动态路由
当您事先不知道确切的段名称,并且想要从动态数据创建路由时,可以使用动态段,这些段在请求时填充,或者在构建时预渲染。
约定
动态段可以通过将文件夹名称用方括号括起来创建:[文件夹名称]
。例如,[id]
或 [slug]
。
动态段作为 params
属性传递给 layout
、page
、route
和 generateMetadata
函数。
示例
例如,博客可以包含以下路由 app/blog/[slug]/page.js
,其中 [slug]
是博客文章的动态段。
export default async function Page({
params,
}: {
params: Promise<{ slug: string }>
}) {
const slug = (await params).slug
return <div>My Post: {slug}</div>
}
路由 | 示例 URL | params |
---|---|---|
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() 页面,了解如何为段生成参数。
须知
- 由于
params
属性是一个 Promise。您必须使用 async/await 或 React 的 use 函数来访问这些值。- 在版本 14 及更早版本中,
params
是一个同步属性。为了帮助向后兼容,您仍然可以在 Next.js 15 中同步访问它,但此行为在未来将被弃用。
- 在版本 14 及更早版本中,
- 动态段等同于
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
服务器函数文档。
全捕获段
动态段可以扩展为全捕获后续段,方法是在方括号内添加省略号 [...文件夹名称]
。
例如,app/shop/[...slug]/page.js
将匹配 /shop/clothes
,以及 /shop/clothes/tops
、/shop/clothes/tops/t-shirts
等等。
路由 | 示例 URL | params |
---|---|---|
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'] } |
可选全捕获段
全捕获段可以通过将参数包含在双重方括号中来设为可选:[[...文件夹名称]]
。
例如,app/shop/[[...slug]]/page.js
将也匹配 /shop
,以及 /shop/clothes
、/shop/clothes/tops
、/shop/clothes/tops/t-shirts
。
全捕获段和可选全捕获段之间的区别在于,对于可选全捕获段,不带参数的路由也会被匹配(上面的示例中的 /shop
)。
路由 | 示例 URL | params |
---|---|---|
app/shop/[[...slug]]/page.js | /shop | { slug: undefined } |
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 async function Page({
params,
}: {
params: Promise<{ 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 插件自动完成。
下一步
这是否有帮助?