动态路由

当您无法提前确定确切的路径段名称,并希望基于动态数据创建路由时,可以使用动态片段 (Dynamic Segments),这些片段会在请求时填充或在构建时预渲染

约定

通过将文件夹名称用方括号包裹即可创建动态片段:[folderName]。例如 [id][slug]

动态片段会作为 params 属性传递给 layoutpageroutegenerateMetadata 函数。

示例

例如,博客可以包含以下路由 app/blog/[slug]/page.js,其中 [slug] 是博客文章的动态片段。

export default function Page({ params }: { params: { slug: string } }) {
  return <div>My Post: {params.slug}</div>
}
路由路径示例 URLparams
app/blog/[slug]/page.js/blog/a{ slug: 'a' }
app/blog/[slug]/page.js/blog/b{ slug: 'b' }
app/blog/[slug]/page.js/blog/c{ slug: 'c' }

查看 generateStaticParams() 页面了解如何为片段生成参数。

须知:动态片段等同于 pages 目录中的动态路由

生成静态参数

generateStaticParams 函数可与动态路由片段结合使用,以在构建时静态生成路由,而非在请求时按需生成。

export async function generateStaticParams() {
  const posts = await fetch('https://.../posts').then((res) => res.json())

  return posts.map((post) => ({
    slug: post.slug,
  }))
}

generateStaticParams 函数的主要优势在于其智能数据检索能力。如果在 generateStaticParams 函数中使用 fetch 请求获取内容,这些请求会被自动记忆化。这意味着跨多个 generateStaticParams、布局和页面的相同参数 fetch 请求只会执行一次,从而减少构建时间。

如果您正在从 pages 目录迁移,请参考迁移指南

更多信息和高级用例请参阅 generateStaticParams 服务端函数文档

通配片段

通过在方括号内添加省略号 [...folderName],可以扩展动态片段以通配后续所有片段。

例如,app/shop/[...slug]/page.js 将匹配 /shop/clothes,同时也匹配 /shop/clothes/tops/shop/clothes/tops/t-shirts 等路径。

路由路径示例 URLparams
app/shop/[...slug]/page.js/shop/a{ slug: ['a'] }
app/shop/[...slug]/page.js/shop/a/b{ slug: ['a', 'b'] }
app/shop/[...slug]/page.js/shop/a/b/c{ slug: ['a', 'b', 'c'] }

可选通配片段

通过将参数放在双方括号中 [[...folderName]],可以将通配片段设为可选

例如,app/shop/[[...slug]]/page.js 除了匹配 /shop/clothes/shop/clothes/tops/shop/clothes/tops/t-shirts 外,还会匹配 /shop

通配片段与可选通配片段的区别在于,可选情况下不携带参数的路径也会被匹配(如上例中的 /shop)。

路由路径示例 URLparams
app/shop/[[...slug]]/page.js/shop{}
app/shop/[[...slug]]/page.js/shop/a{ slug: ['a'] }
app/shop/[[...slug]]/page.js/shop/a/b{ slug: ['a', 'b'] }
app/shop/[[...slug]]/page.js/shop/a/b/c{ slug: ['a', 'b', 'c'] }

TypeScript

使用 TypeScript 时,您可以根据配置的路由片段为 params 添加类型。

export default function Page({ params }: { params: { slug: string } }) {
  return <h1>My Page</h1>
}
路由路径params 类型定义
app/blog/[slug]/page.js{ slug: string }
app/shop/[...slug]/page.js{ slug: string[] }
app/shop/[[...slug]]/page.js{ slug?: string[] }
app/[categoryId]/[itemId]/page.js{ categoryId: string, itemId: string }

须知:未来这可能会由 TypeScript 插件自动完成。

On this page