getStaticPaths

如果页面有动态路由并使用 getStaticProps，则需要定义要静态生成的路径列表。

当你从使用动态路由的页面导出一个名为 getStaticPaths (静态站点生成) 的函数时，Next.js 将静态预渲染 getStaticPaths 指定的所有路径。

pages/repo/[name].tsx

import type {
  InferGetStaticPropsType,
  GetStaticProps,
  GetStaticPaths,
} from 'next'
 
type Repo = {
  name: string
  stargazers_count: number
}
 
export const getStaticPaths = (async () => {
  return {
    paths: [
      {
        params: {
          name: 'next.js',
        },
      }, // See the "paths" section below
    ],
    fallback: true, // false or "blocking"
  }
}) satisfies GetStaticPaths
 
export const getStaticProps = (async (context) => {
  const res = await fetch('https://api.github.com/repos/vercel/next.js')
  const repo = await res.json()
  return { props: { repo } }
}) satisfies GetStaticProps<{
  repo: Repo
}>
 
export default function Page({
  repo,
}: InferGetStaticPropsType<typeof getStaticProps>) {
  return repo.stargazers_count
}

getStaticPaths API 参考涵盖了可以与 getStaticPaths 一起使用的所有参数和属性。

我应该何时使用 getStaticPaths？

如果你正在静态预渲染使用动态路由的页面，你应该使用 getStaticPaths，并且

数据来自无头 CMS
数据来自数据库
数据来自文件系统
数据可以公开缓存（非用户特定）
页面必须预渲染（为了 SEO）并且非常快 — getStaticProps 生成 HTML 和 JSON 文件，两者都可以被 CDN 缓存以提高性能。

getStaticPaths 何时运行

getStaticPaths 将仅在生产环境的构建期间运行，在运行时不会被调用。你可以使用此工具验证在 getStaticPaths 中编写的代码已从客户端包中删除。

getStaticProps 如何根据 getStaticPaths 运行

getStaticProps 在 next build 期间为构建期间返回的任何 paths 运行。
当使用 fallback: true 时，getStaticProps 在后台运行。
当使用 fallback: blocking 时，getStaticProps 在初始渲染之前被调用。

我可以在哪里使用 getStaticPaths

getStaticPaths 必须与 getStaticProps 一起使用。
你不能将 getStaticPaths 与 getServerSideProps 一起使用。
你可以从也使用 getStaticProps 的动态路由导出 getStaticPaths。
你不能从非页面文件（例如你的 components 文件夹）导出 getStaticPaths。
你必须将 getStaticPaths 导出为独立函数，而不是页面组件的属性。

在开发环境中每次请求时运行

在开发环境 (next dev) 中，getStaticPaths 将在每次请求时被调用。

按需生成路径

getStaticPaths 允许你控制在构建期间生成哪些页面，而不是使用 fallback 按需生成。在构建期间生成更多页面将导致构建速度变慢。

你可以通过为 paths 返回一个空数组来延迟按需生成所有页面。当将你的 Next.js 应用程序部署到多个环境时，这尤其有用。例如，你可以通过为预览（但不是生产构建）按需生成所有页面来获得更快的构建速度。这对于有成百上千个静态页面的网站很有帮助。

pages/posts/[id].js

export async function getStaticPaths() {
  // When this is true (in preview environments) don't
  // prerender any static pages
  // (faster builds, but slower initial page load)
  if (process.env.SKIP_BUILD_STATIC_GENERATION) {
    return {
      paths: [],
      fallback: 'blocking',
    }
  }
 
  // Call an external API endpoint to get posts
  const res = await fetch('https://.../posts')
  const posts = await res.json()
 
  // Get the paths we want to prerender based on posts
  // In production environments, prerender all pages
  // (slower builds, but faster initial page load)
  const paths = posts.map((post) => ({
    params: { id: post.id },
  }))
 
  // { fallback: false } means other routes should 404
  return { paths, fallback: false }
}