数据获取和缓存

示例

本指南将带你了解 Next.js 中数据获取和缓存的基础知识，提供实用示例和最佳实践。

以下是 Next.js 中数据获取的简单示例：

app/page.tsx

TypeScript

export default async function Page() {
  const data = await fetch('https://api.vercel.app/blog')
  const posts = await data.json()
  return (
    <ul>
      {posts.map((post) => (
        <li key={post.id}>{post.title}</li>
      ))}
    </ul>
  )
}

这个示例展示了在异步 React 服务器组件中使用 fetch API 进行基本的服务器端数据获取。

参考

示例

在服务器端使用 `fetch` API 获取数据

这个组件将获取并显示博客文章列表。默认情况下，fetch 的响应不会被缓存。

app/page.tsx

TypeScript

export default async function Page() {
  const data = await fetch('https://api.vercel.app/blog')
  const posts = await data.json()
  return (
    <ul>
      {posts.map((post) => (
        <li key={post.id}>{post.title}</li>
      ))}
    </ul>
  )
}

如果在此路由中没有使用任何动态 API，它将在 next build 期间被预渲染为静态页面。然后可以使用增量静态再生成更新数据。

要防止页面预渲染，你可以在文件中添加以下内容：

export const dynamic = 'force-dynamic'

但是，你通常会使用 cookies、headers 或从页面 props 中读取传入的 searchParams 等函数，这些函数会自动使页面动态渲染。在这种情况下，你_不_需要显式使用 force-dynamic。

使用 ORM 或数据库在服务器端获取数据

这个组件将获取并显示博客文章列表。默认情况下，数据库的响应不会被缓存，但可以通过额外配置实现缓存。

app/page.tsx

TypeScript

import { db, posts } from '@/lib/db'
 
export default async function Page() {
  const allPosts = await db.select().from(posts)
  return (
    <ul>
      {allPosts.map((post) => (
        <li key={post.id}>{post.title}</li>
      ))}
    </ul>
  )
}

如果在此路由中没有使用任何动态 API，它将在 next build 期间被预渲染为静态页面。然后可以使用增量静态再生成更新数据。

要防止页面预渲染，你可以在文件中添加以下内容：

export const dynamic = 'force-dynamic'

在客户端获取数据

我们建议首先尝试在服务器端获取数据。

然而，仍然有一些情况下客户端数据获取是有意义的。在这些场景中，你可以在 useEffect 中手动调用 fetch（不推荐），或依赖社区中流行的 React 库（如 SWR 或 React Query）进行客户端获取。

app/page.tsx

TypeScript

'use client'
 
import { useState, useEffect } from 'react'
 
export function Posts() {
  const [posts, setPosts] = useState(null)
 
  useEffect(() => {
    async function fetchPosts() {
      const res = await fetch('https://api.vercel.app/blog')
      const data = await res.json()
      setPosts(data)
    }
    fetchPosts()
  }, [])
 
  if (!posts) return <div>Loading...</div>
 
  return (
    <ul>
      {posts.map((post) => (
        <li key={post.id}>{post.title}</li>
      ))}
    </ul>
  )
}

使用 ORM 或数据库缓存数据

你可以使用 unstable_cache API 在运行 next build 时缓存响应。

app/page.tsx

TypeScript

import { unstable_cache } from 'next/cache'
import { db, posts } from '@/lib/db'
 
const getPosts = unstable_cache(
  async () => {
    return await db.select().from(posts)
  },
  ['posts'],
  { revalidate: 3600, tags: ['posts'] }
)
 
export default async function Page() {
  const allPosts = await getPosts()
 
  return (
    <ul>
      {allPosts.map((post) => (
        <li key={post.id}>{post.title}</li>
      ))}
    </ul>
  )
}

这个示例将数据库查询结果缓存 1 小时（3600 秒）。它还添加了缓存标签 posts，然后可以通过增量静态再生成使其失效。

跨多个函数重用数据

Next.js 使用了诸如 generateMetadata 和 generateStaticParams 等 API，你需要在这些 API 中使用在 page 中获取的相同数据。

如果你使用的是 fetch，可以通过添加 cache: 'force-cache' 对请求进行记忆化。这意味着你可以安全地使用相同的 URL 和相同的选项调用，并且只会发出一个请求。

值得注意的是：

在 Next.js 的早期版本中，使用 fetch 的默认 cache 值是 force-cache。这在版本 15 中发生了变化，默认变为 cache: no-store。

app/blog/[id]/page.tsx

TypeScript

import { notFound } from 'next/navigation'
 
interface Post {
  id: string
  title: string
  content: string
}
 
async function getPost(id: string) {
  const res = await fetch(`https://api.vercel.app/blog/${id}`, {
    cache: 'force-cache',
  })
  const post: Post = await res.json()
  if (!post) notFound()
  return post
}
 
export async function generateStaticParams() {
  const posts = await fetch('https://api.vercel.app/blog', {
    cache: 'force-cache',
  }).then((res) => res.json())
 
  return posts.map((post: Post) => ({
    id: String(post.id),
  }))
}
 
export async function generateMetadata({
  params,
}: {
  params: Promise<{ id: string }>
}) {
  const { id } = await params
  const post = await getPost(id)
 
  return {
    title: post.title,
  }
}
 
export default async function Page({
  params,
}: {
  params: Promise<{ id: string }>
}) {
  const { id } = await params
  const post = await getPost(id)
 
  return (
    <article>
      <h1>{post.title}</h1>
      <p>{post.content}</p>
    </article>
  )
}

如果你_不_使用 fetch，而是直接使用 ORM 或数据库，你可以用 React 的 cache 函数包装你的数据获取。这将去重并只进行一次查询。

import { cache } from 'react'
import { db, posts, eq } from '@/lib/db' // 使用 Drizzle ORM 的示例
import { notFound } from 'next/navigation'
 
export const getPost = cache(async (id) => {
  const post = await db.query.posts.findFirst({
    where: eq(posts.id, parseInt(id)),
  })
 
  if (!post) notFound()
  return post
})

重新验证缓存数据

了解更多关于使用增量静态再生成重新验证缓存数据的信息。

模式

并行和顺序数据获取

在组件内部获取数据时，你需要了解两种数据获取模式：并行和顺序。

顺序：组件树中的请求相互依赖。这可能导致加载时间更长。
并行：路由中的请求被急切地发起，并将同时加载数据。这减少了加载数据所需的总时间。

顺序数据获取

如果你有嵌套组件，且每个组件获取自己的数据，那么如果这些数据请求没有被记忆化，数据获取将按顺序进行。

在某些情况下，你可能希望采用这种模式，因为一个获取依赖于另一个的结果。例如，Playlists 组件只会在 Artist 组件完成数据获取后开始获取数据，因为 Playlists 依赖于 artistID 属性：

app/artist/[username]/page.tsx

TypeScript

export default async function Page({
  params,
}: {
  params: Promise<{ username: string }>
}) {
  const { username } = await params
  // 获取艺术家信息
  const artist = await getArtist(username)
 
  return (
    <>
      <h1>{artist.name}</h1>
      {/* 在 Playlists 组件加载时显示后备 UI */}
      <Suspense fallback={<div>Loading...</div>}>
        {/* 将艺术家 ID 传递给 Playlists 组件 */}
        <Playlists artistID={artist.id} />
      </Suspense>
    </>
  )
}
 
async function Playlists({ artistID }: { artistID: string }) {
  // 使用艺术家 ID 获取播放列表
  const playlists = await getArtistPlaylists(artistID)
 
  return (
    <ul>
      {playlists.map((playlist) => (
        <li key={playlist.id}>{playlist.name}</li>
      ))}
    </ul>
  )
}

你可以使用 loading.js（用于路由段）或 React <Suspense>（用于嵌套组件）来在 React 流式传输结果时显示即时加载状态。

这将防止整个路由被数据请求阻塞，用户将能够与页面中已准备好的部分进行交互。

并行数据获取

默认情况下，布局和页面段并行渲染。这意味着请求将被并行发起。

然而，由于 async/await 的性质，相同段或组件内部的等待请求将阻塞其下方的请求。

要并行获取数据，你可以通过在使用数据的组件外部定义它们来急切地发起请求。这通过并行发起两个请求来节省时间，但用户在两个 Promise 都解析之前不会看到渲染结果。

在下面的示例中，getArtist 和 getAlbums 函数定义在 Page 组件外部，并使用 Promise.all 在组件内部发起：

app/artist/[username]/page.tsx

TypeScript

import Albums from './albums'
 
async function getArtist(username: string) {
  const res = await fetch(`https://api.example.com/artist/${username}`)
  return res.json()
}
 
async function getAlbums(username: string) {
  const res = await fetch(`https://api.example.com/artist/${username}/albums`)
  return res.json()
}
 
export default async function Page({
  params,
}: {
  params: Promise<{ username: string }>
}) {
  const { username } = await params
  const artistData = getArtist(username)
  const albumsData = getAlbums(username)
 
  // 并行发起两个请求
  const [artist, albums] = await Promise.all([artistData, albumsData])
 
  return (
    <>
      <h1>{artist.name}</h1>
      <Albums list={albums} />
    </>
  )
}

此外，你可以添加一个 Suspense 边界来分解渲染工作，并尽快显示部分结果。

预加载数据

另一种防止瀑布流的方法是使用_预加载_模式，通过创建一个你在阻塞请求之上急切调用的实用函数。例如，checkIsAvailable() 阻止 <Item/> 渲染，所以你可以在它之前调用 preload()，以急切地发起 <Item/> 的数据依赖。到 <Item/> 被渲染时，它的数据已经被获取。

注意，preload 函数不会阻止 checkIsAvailable() 运行。

components/Item.tsx

TypeScript

import { getItem } from '@/utils/get-item'
 
export const preload = (id: string) => {
  // void 评估给定表达式并返回 undefined
  // https://developer.mozilla.org/docs/Web/JavaScript/Reference/Operators/void
  void getItem(id)
}
export default async function Item({ id }: { id: string }) {
  const result = await getItem(id)
  // ...
}

app/item/[id]/page.tsx

TypeScript

import Item, { preload, checkIsAvailable } from '@/components/Item'
 
export default async function Page({
  params,
}: {
  params: Promise<{ id: string }>
}) {
  const { id } = await params
  // 开始加载项目数据
  preload(id)
  // 执行另一个异步任务
  const isAvailable = await checkIsAvailable()
 
  return isAvailable ? <Item id={id} /> : null
}

值得注意的是： "preload"函数也可以有任何名称，因为它是一种模式，而不是 API。

将 React `cache` 和 `server-only` 与预加载模式结合使用

你可以结合 cache 函数、preload 模式和 server-only 包来创建一个可以在整个应用中使用的数据获取实用工具。

utils/get-item.ts

TypeScript

import { cache } from 'react'
import 'server-only'
 
export const preload = (id: string) => {
  void getItem(id)
}
 
export const getItem = cache(async (id: string) => {
  // ...
})

通过这种方法，你可以急切地获取数据，缓存响应，并确保这种数据获取只在服务器上发生。

布局、页面或其他组件可以使用 utils/get-item 导出，使它们能够控制何时获取项目的数据。

值得注意的是：

我们建议使用 server-only 包，确保服务器数据获取函数永远不会在客户端使用。

防止敏感数据暴露给客户端

我们建议使用 React 的污点 API，taintObjectReference 和 taintUniqueValue，来防止整个对象实例或敏感值被传递给客户端。

要在应用中启用污点，将 Next.js 配置 experimental.taint 选项设置为 true：

next.config.js

module.exports = {
  experimental: {
    taint: true,
  },
}

然后将要污染的对象或值传递给 experimental_taintObjectReference 或 experimental_taintUniqueValue 函数：

app/utils.ts

TypeScript

import { queryDataFromDB } from './api'
import {
  experimental_taintObjectReference,
  experimental_taintUniqueValue,
} from 'react'
 
export async function getUserData() {
  const data = await queryDataFromDB()
  experimental_taintObjectReference(
    '不要将整个用户对象传递给客户端',
    data
  )
  experimental_taintUniqueValue(
    '不要将用户地址传递给客户端',
    data,
    data.address
  )
  return data
}

app/page.tsx

TypeScript

import { getUserData } from './data'
 
export async function Page() {
  const userData = getUserData()
  return (
    <ClientComponent
      user={userData} // 这会因为 taintObjectReference 而导致错误
      address={userData.address} // 这会因为 taintUniqueValue 而导致错误
    />
  )
}