路由段配置

如果 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() 返回空值。

须知:

• 关于 如何从 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 时，该段使用 流式服务器渲染。
• 如果使用 dynamic = 'error' 和 dynamic = 'force-static'，它会将 dynamicParams 的默认值更改为 false。

revalidate

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

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

• false (默认)：默认启发式方法，用于缓存任何将其 cache 选项设置为 'force-cache' 的 fetch 请求，或在 动态 API 使用之前发现的请求。 语义上等同于 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 添加特定的执行限制。 例如，在 Vercel 上。

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

export const maxDuration = 5

须知:

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

generateStaticParams

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

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

版本历史