NNext.js 中文网 GitHub

静态站点生成(SSG)

使用静态站点生成(SSG)在构建时预渲染页面。

<details> <summary>示例</summary>

</details>

如果页面使用静态生成(Static Generation),页面 HTML 会在构建时生成。这意味着在生产环境中,页面 HTML 会在你运行 next build 时生成。随后该 HTML 会在每次请求时被复用,并可由 CDN 缓存。

在 Next.js 中,你可以静态生成带数据或不带数据的页面。让我们看看每种情况。

无数据的静态生成#

默认情况下,Next.js 使用静态生成来预渲染页面,且不获取数据。示例如下:

jsx
function About() {
  return <div>About</div>
}

export default About

请注意,此页面无需获取任何外部数据即可预渲染。在这种情况下,Next.js 会在构建时为每个页面生成一个 HTML 文件。

带数据的静态生成#

某些页面需要获取外部数据才能预渲染。有两种场景,可能适用其中一种或两种。在每种情况下,你都可以使用 Next.js 提供的这些函数:

  1. 页面内容依赖外部数据:使用 getStaticProps。
  2. 页面的路径依赖外部数据:使用 getStaticPaths(通常与 getStaticProps 一起使用)。

场景 1:页面内容依赖外部数据#

示例:你的博客页面可能需要从 CMS(内容管理系统)获取博客文章列表。

jsx
// TODO: 需要(通过调用某个 API 端点)获取 `posts`,
//       然后才能预渲染此页面。
export default function Blog({ posts }) {
  return (
    <ul>
      {posts.map((post) => (
        <li>{post.title}</li>
      ))}
    </ul>
  )
}

为了在预渲染时获取这些数据,Next.js 允许你从同一文件中 export 一个名为 getStaticProps 的 async 函数。该函数在构建时被调用,使你能够在预渲染时将获取到的数据传递给页面的 props。

jsx
export default function Blog({ posts }) {
  // 渲染文章列表……
}

// 此函数在构建时被调用
export async function getStaticProps() {
  // 调用外部 API 端点以获取文章
  const res = await fetch('https://.../posts')
  const posts = await res.json()

  // 通过返回 { props: { posts } },Blog 组件
  // 将在构建时接收到 `posts` 作为 prop
  return {
    props: {
      posts,
    },
  }
}

要详细了解 getStaticProps 的工作原理,请查阅数据获取文档。

场景 2:页面路径依赖外部数据#

Next.js 允许你创建带有动态路由的页面。例如,你可以创建一个名为 pages/posts/[id].js 的文件,根据 id 显示单篇博客文章。这样当你访问 posts/1 时,就会显示 id: 1 的博客文章。

要详细了解动态路由,请查阅动态路由文档。

但是,要在构建时预渲染哪些 id 可能取决于外部数据。

示例:假设你只向数据库添加了一篇博客文章(id: 1)。在这种情况下,你只想在构建时预渲染 posts/1。

之后,你可能会添加第二篇 id: 2 的文章。这时你也希望预渲染 posts/2。

因此,被预渲染的页面路径依赖外部数据。为处理这种情况,Next.js 允许你从动态页面(本例中为 pages/posts/[id].js)export 一个名为 getStaticPaths 的 async 函数。该函数在构建时被调用,使你可以指定要预渲染的路径。

jsx
// 此函数在构建时被调用
export async function getStaticPaths() {
  // 调用外部 API 端点以获取文章
  const res = await fetch('https://.../posts')
  const posts = await res.json()

  // 根据文章获取我们要预渲染的路径
  const paths = posts.map((post) => ({
    params: { id: post.id },
  }))

  // 我们将仅在构建时预渲染这些路径。
  // { fallback: false } 表示其他路由应返回 404。
  return { paths, fallback: false }
}

同样在 pages/posts/[id].js 中,你需要导出 getStaticProps,以便获取该 id 对应的文章数据并用它来预渲染页面:

jsx
export default function Post({ post }) {
  // 渲染文章……
}

export async function getStaticPaths() {
  // ...
}

// 此函数同样在构建时被调用
export async function getStaticProps({ params }) {
  // params 包含文章的 `id`。
  // 如果路由是 /posts/1,则 params.id 为 1
  const res = await fetch(`https://.../posts/${params.id}`)
  const post = await res.json()

  // 通过 props 将文章数据传递给页面
  return { props: { post } }
}

要详细了解 getStaticPaths 的工作原理,请查阅数据获取文档。

何时应该使用静态生成?#

我们建议尽可能使用静态生成(无论是否带数据),因为你的页面只需构建一次即可由 CDN 提供服务,这比让服务器在每次请求时都渲染页面要快得多。

静态生成可用于多种类型的页面,包括:

  • 营销页面
  • 博客文章和作品集
  • 电子商务商品列表
  • 帮助和文档

你应该问自己:“我能否在用户请求之前预渲染这个页面?”如果答案是肯定的,那么就应该选择静态生成。

另一方面,如果你无法在用户请求之前预渲染页面,那么静态生成就不是一个好的选择。也许你的页面展示的是频繁更新的数据,页面内容每次请求都会变化。

在这种情况下,你可以采用以下方法之一:

  • 结合客户端数据获取使用静态生成:你可以跳过页面某些部分的预渲染,然后使用客户端 JavaScript 来填充它们。要详细了解这种方法,请查阅数据获取文档。
  • 使用服务端渲染(Server-Side Rendering):Next.js 在每次请求时预渲染页面。这种方式会更慢,因为页面无法被 CDN 缓存,但预渲染的页面始终是最新的。我们将在下文讨论这种方法。
Next.js 中文网