路由段配置

如果启用了 dynamicIO 标志，则本页描述的选项将被禁用，并将在未来版本中弃用。

路由段选项允许您通过直接导出以下变量来配置 页面、布局 或 路由处理器 的行为：

选项

experimental_ppr

为布局或页面启用 部分预渲染 (PPR)。

export const experimental_ppr = true
// true | false

dynamic

将布局或页面的动态行为更改为完全静态或完全动态。

export const dynamic = 'auto'
// 'auto' | 'force-dynamic' | 'error' | 'force-static'

须知：app 目录中的新模型更倾向于在 fetch 请求级别进行细粒度的缓存控制，而不是 pages 目录中 getServerSideProps 和 getStaticProps 在页面级别的全有或全无模型。dynamic 选项是一种回退到先前模型的便捷方式，并提供了更简单的迁移路径。

• 'auto' (默认)：默认选项，尽可能缓存而不阻止任何组件选择动态行为。
• 'force-dynamic'：强制 动态渲染，这将导致路由在每次用户请求时渲染。此选项等效于：
  • 将布局或页面中每个 fetch() 请求的选项设置为 { cache: 'no-store', next: { revalidate: 0 } }。
  • 将段配置设置为 export const fetchCache = 'force-no-store'
• 'error'：强制静态渲染并通过在组件使用 动态 API 或未缓存数据时引发错误来缓存布局或页面的数据。此选项等效于：
  • pages 目录中的 getStaticProps()。
  • 将布局或页面中每个 fetch() 请求的选项设置为 { cache: 'force-cache' }。
  • 将段配置设置为 fetchCache = 'only-cache', dynamicParams = false。
  • dynamic = 'error' 将 dynamicParams 的默认值从 true 更改为 false。您可以通过手动设置 dynamicParams = true 来选择为未由 generateStaticParams 生成的动态参数动态渲染页面。
• 'force-static'：通过强制 cookies、headers() 和 useSearchParams() 返回空值来强制静态渲染并缓存布局或页面的数据。可以在使用 force-static 渲染的页面或布局中 revalidate、revalidatePath 或 revalidateTag。

须知：

• 有关如何从 getServerSideProps 和 getStaticProps 迁移到 dynamic: 'force-dynamic' 和 dynamic: 'error' 的说明，请参阅 升级指南。

dynamicParams

控制访问未通过 generateStaticParams 生成的动态段时发生的情况。

export const dynamicParams = true // true | false,

• true (默认)：未包含在 generateStaticParams 中的动态段按需生成。
• false：未包含在 generateStaticParams 中的动态段将返回 404。

须知：

• 此选项替换了 pages 目录中 getStaticPaths 的 fallback: true | false | blocking 选项。
• 要静态渲染所有路径首次访问时，您需要在 generateStaticParams 中返回空数组或使用 export const dynamic = 'force-static'。
• 当 dynamicParams = true 时，段使用 流式服务器渲染。

revalidate

设置布局或页面的默认重新验证时间。此选项不会覆盖单个 fetch 请求设置的 revalidate 值。

export const revalidate = false
// false | 0 | number

• false (默认)：默认启发式缓存任何将 cache 选项设置为 'force-cache' 或在 动态 API 使用之前发现的 fetch 请求。语义上等同于 revalidate: Infinity，这意味着资源应无限期缓存。单个 fetch 请求仍可以使用 cache: 'no-store' 或 revalidate: 0 来避免被缓存并使路由动态渲染。或者将 revalidate 设置为低于路由默认值的正数以增加路由的重新验证频率。
• 0：确保布局或页面始终 动态渲染，即使未发现动态 API 或未缓存的数据获取。此选项将未设置 cache 选项的 fetch 请求的默认值更改为 'no-store'，但保留选择 'force-cache' 或使用正 revalidate 的 fetch 请求不变。
• number：(以秒为单位) 将布局或页面的默认重新验证频率设置为 n 秒。

须知：

• 重新验证值必须是静态可分析的。例如 revalidate = 600 是有效的，但 revalidate = 60 * 10 不是。
• 使用 runtime = 'edge' 时，重新验证值不可用。
• 在开发环境中，页面始终按需渲染且从不缓存。这使您可以立即查看更改而无需等待重新验证期过去。

重新验证频率

• 单个路由的每个布局和页面中最低的 revalidate 将决定整个路由的重新验证频率。这确保了子页面与其父布局一样频繁地重新验证。
• 单个 fetch 请求可以设置比路由默认 revalidate 更低的 revalidate 以增加整个路由的重新验证频率。这使您可以根据某些条件动态选择更频繁地重新验证某些路由。

fetchCache

export const fetchCache = 'auto'
// 'auto' | 'default-cache' | 'only-cache'
// 'force-cache' | 'force-no-store' | 'default-no-store' | 'only-no-store'

runtime

我们建议使用 Node.js 运行时渲染您的应用程序，并使用 Edge 运行时处理中间件。

export const runtime = 'nodejs'
// 'nodejs' | 'edge'

• 'nodejs' (默认)
• 'edge'

preferredRegion

export const preferredRegion = 'auto'
// 'auto' | 'global' | 'home' | ['iad1', 'sfo1']

对 preferredRegion 的支持以及支持的地区取决于您的部署平台。

须知：

• 如果未指定 preferredRegion，它将继承最近父布局的选项。
• 根布局默认为 all 地区。

maxDuration

默认情况下，Next.js 不限制服务器端逻辑的执行（渲染页面或处理 API）。部署平台可以使用 Next.js 构建输出中的 maxDuration 来添加特定的执行限制。

注意：此设置需要 Next.js 13.4.10 或更高版本。

export const maxDuration = 5

须知：

• 如果使用 服务器操作，请在页面级别设置 maxDuration 以更改页面上使用的所有服务器操作的默认超时。

generateStaticParams

generateStaticParams 函数可以与 动态路由段 结合使用，以定义将在构建时静态生成的路由段参数列表，而不是在请求时按需生成。

有关更多详细信息，请参阅 API 参考。

版本历史