Route Segment Config

值得注意的是：

• 如果 cacheComponents 标志启用，本页面列出的选项将被禁用，并最终会在未来被弃用。
• 路由段选项仅在服务器组件页面、布局或路由处理程序中生效。
• generateStaticParams 不能在 'use client' 文件中使用。

路由段选项允许你通过直接导出以下变量来配置 Page、Layout 或 Route Handler 的行为：

选项

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'。

• '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 值需要是静态可分析的。例如 revalidate = 600 是有效的，但 revalidate = 60 * 10 无效。
• 使用 runtime = 'edge' 时，revalidate 值不可用。
• 在开发环境中，页面_始终_按需渲染且永远不会被缓存。这使你可以立即看到更改，而无需等待重新验证期结束。

重新验证频率

• 单个路由的每个布局和页面中最低的 revalidate 将决定_整个_路由的重新验证频率。这确保子页面与其父布局一样频繁地重新验证。
• 单个 fetch 请求可以设置低于路由默认 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 运行时来渲染你的应用程序。此选项不能在 Proxy 中使用。

值得注意的是：使用 runtime: 'edge' 对于 Cache Components 是不支持的。

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

值得注意的是：

• 如果使用 Server Actions，请在页面级别设置 maxDuration 以更改页面上使用的所有 Server Actions 的默认超时时间。

generateStaticParams

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

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

版本历史