getStaticProps

如果你从页面中导出一个名为 getStaticProps（静态站点生成）的函数，Next.js 将在构建时使用 getStaticProps 返回的 props 预渲染此页面。

pages/index.tsx

TypeScript

import type { InferGetStaticPropsType, GetStaticProps } from 'next'
 
type Repo = {
  name: string
  stargazers_count: number
}
 
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
}

注意，无论渲染类型如何，任何 props 都将传递给页面组件，并且可以在初始 HTML 中在客户端查看。这是为了确保页面可以正确地被水合。请确保不要在 props 中传递不应在客户端可用的敏感信息。

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

我何时应该使用 getStaticProps？

如果出现以下情况，你应该使用 getStaticProps：

渲染页面所需的数据在用户请求之前的构建时就已可用
数据来自无头 CMS
页面必须预渲染（为了 SEO）并且非常快速 — getStaticProps 生成 HTML 和 JSON 文件，这两个文件都可以被 CDN 缓存以提高性能
数据可以公开缓存（非用户特定）。通过使用中间件重写路径，可以在某些特定情况下绕过此条件。

getStaticProps 何时运行

getStaticProps 始终在服务器上运行，而不是在客户端。你可以使用此工具验证 getStaticProps 中编写的代码是否从客户端捆绑包中删除。

getStaticProps 始终在 next build 期间运行
使用 fallback: true 时，getStaticProps 在后台运行
使用 fallback: blocking 时，getStaticProps 在初始渲染之前被调用
使用 revalidate 时，getStaticProps 在后台运行
使用 revalidate() 时，getStaticProps 在后台按需运行

当与增量静态重新生成结合使用时，getStaticProps 将在后台运行，同时重新验证过时的页面，并向浏览器提供新鲜的页面。

getStaticProps 无法访问传入的请求（如查询参数或 HTTP 标头），因为它生成静态 HTML。如果你需要访问页面的请求，请考虑除了 getStaticProps 之外还使用中间件。

使用 getStaticProps 从 CMS 获取数据

以下示例展示了如何从 CMS 获取博客文章列表。

pages/blog.tsx

TypeScript

// 博客文章将在构建时由 getStaticProps() 填充
export default function Blog({ posts }) {
  return (
    <ul>
      {posts.map((post) => (
        <li>{post.title}</li>
      ))}
    </ul>
  )
}
 
// 此函数在服务器端构建时被调用。
// 它不会在客户端调用，因此你甚至可以
// 直接进行数据库查询。
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 API 参考涵盖了可以与 getStaticProps 一起使用的所有参数和属性。

直接编写服务器端代码

由于 getStaticProps 仅在服务器端运行，它永远不会在客户端运行。它甚至不会包含在浏览器的 JS 捆绑包中，因此你可以编写直接的数据库查询而不会将其发送到浏览器。

这意味着，与其从 getStaticProps 中获取一个API 路由（该路由本身从外部源获取数据），不如直接在 getStaticProps 中编写服务器端代码。

以下是一个示例。使用 API 路由从 CMS 获取一些数据。然后直接从 getStaticProps 调用该 API 路由。这会产生额外的调用，降低性能。相反，可以通过使用 lib/ 目录共享从 CMS 获取数据的逻辑。然后可以与 getStaticProps 共享。

lib/load-posts.js

// 以下函数与 getStaticProps 和 API 路由共享
// 来自 `lib/` 目录
export async function loadPosts() {
  // 调用外部 API 端点获取文章
  const res = await fetch('https://.../posts/')
  const data = await res.json()
 
  return data
}

pages/blog.js

// pages/blog.js
import { loadPosts } from '../lib/load-posts'
 
// 此函数仅在服务器端运行
export async function getStaticProps() {
  // 与其获取你的 `/api` 路由，不如直接在 `getStaticProps` 中调用相同的函数
  const posts = await loadPosts()
 
  // 返回的 Props 将传递给页面组件
  return { props: { posts } }
}

或者，如果你不使用 API 路由获取数据，那么可以直接在 getStaticProps 中使用 fetch() API 获取数据。

要验证 Next.js 从客户端捆绑包中消除了什么，你可以使用 next-code-elimination 工具。

静态生成 HTML 和 JSON

当在构建时预渲染带有 getStaticProps 的页面时，除了页面 HTML 文件外，Next.js 还会生成一个 JSON 文件，其中包含运行 getStaticProps 的结果。

这个 JSON 文件将用于通过 next/link 或 next/router 进行客户端路由。当你导航到使用 getStaticProps 预渲染的页面时，Next.js 会获取此 JSON 文件（在构建时预先计算）并将其用作页面组件的 props。这意味着客户端页面转换将不会调用 getStaticProps，因为只使用导出的 JSON。

使用增量静态生成时，getStaticProps 将在后台执行，以生成客户端导航所需的 JSON。你可能会看到对同一页面发出多个请求，但是，这是有意为之，对最终用户性能没有影响。

我可以在哪里使用 getStaticProps

getStaticProps 只能从页面导出。你不能从非页面文件、_app、_document 或 _error 导出它。

这一限制的原因之一是 React 需要在渲染页面之前获取所有必需的数据。

另外，你必须将 getStaticProps 导出为独立函数 — 如果将 getStaticProps 添加为页面组件的属性，它将不会起作用。

值得注意的是：如果你已创建自定义应用，请确保将 pageProps 传递给页面组件，如链接文档中所示，否则 props 将为空。

在开发中每次请求都运行

在开发中（next dev），getStaticProps 将在每次请求时被调用。

预览模式

你可以使用预览模式临时绕过静态生成，并在请求时而不是构建时渲染页面。例如，你可能正在使用无头 CMS，并希望在发布之前预览草稿。