获取数据

本页面将引导你了解如何在 Server 和 Client Components 中获取数据，以及如何流式传输依赖于数据的组件。

获取数据

Server Components

你可以在 Server Components 中使用以下方式获取数据：

fetch API
ORM 或数据库

使用 `fetch` API

要使用 fetch API 获取数据，将你的组件转换为异步函数，并 await fetch 调用。例如：

app/blog/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>
  )
}

值得注意的是：

默认情况下，fetch 响应不会被缓存。然而，Next.js 会预渲染路由，输出将被缓存以提高性能。如果你想选择进入动态渲染，使用 { cache: 'no-store' } 选项。参见 fetch API 参考。

在开发过程中，你可以记录 fetch 调用以获得更好的可见性和调试。参见 logging API 参考。

使用 ORM 或数据库

由于 Server Components 在服务器上渲染，你可以安全地使用 ORM 或数据库客户端进行数据库查询。将你的组件转换为异步函数，并 await 调用：

app/blog/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>
  )
}

Client Components

有两种方式在 Client Components 中获取数据，使用：

React 的 use hook
社区库，如 SWR 或 React Query

使用 `use` hook 流式传输数据

你可以使用 React 的 use hook 从服务器到客户端流式传输数据。首先在 Server 组件中获取数据，并将 promise 作为 prop 传递给 Client Component：

app/blog/page.tsx

TypeScript

import Posts from '@/app/ui/posts'
import { Suspense } from 'react'
 
export default function Page() {
  // 不要 await 数据获取函数
  const posts = getPosts()
 
  return (
    <Suspense fallback={<div>Loading...</div>}>
      <Posts posts={posts} />
    </Suspense>
  )
}

然后，在你的 Client Component 中，使用 use hook 读取 promise：

app/ui/posts.tsx

TypeScript

'use client'
import { use } from 'react'
 
export default function Posts({
  posts,
}: {
  posts: Promise<{ id: string; title: string }[]>
}) {
  const allPosts = use(posts)
 
  return (
    <ul>
      {allPosts.map((post) => (
        <li key={post.id}>{post.title}</li>
      ))}
    </ul>
  )
}

在上面的示例中，<Posts> 组件被包裹在 <Suspense> 边界中。这意味着在 promise 解析时将显示后备内容。了解更多关于流式传输的信息。

社区库

你可以使用社区库，如 SWR 或 React Query 在 Client Components 中获取数据。这些库具有自己的缓存、流式传输和其他功能的语义。例如，使用 SWR：

app/blog/page.tsx

TypeScript

'use client'
import useSWR from 'swr'
 
const fetcher = (url) => fetch(url).then((r) => r.json())
 
export default function BlogPage() {
  const { data, error, isLoading } = useSWR(
    'https://api.vercel.app/blog',
    fetcher
  )
 
  if (isLoading) return <div>Loading...</div>
  if (error) return <div>Error: {error.message}</div>
 
  return (
    <ul>
      {data.map((post: { id: string; title: string }) => (
        <li key={post.id}>{post.title}</li>
      ))}
    </ul>
  )
}

去重请求和缓存数据

去重 fetch 请求的一种方法是使用请求记忆化。通过这种机制，在单个渲染过程中使用相同 URL 和选项的 GET 或 HEAD 的 fetch 调用会被合并为一个请求。这是自动发生的，你可以通过向 fetch 传递 Abort 信号来选择退出。

请求记忆化的作用域限定在请求的生命周期内。

你也可以通过使用 Next.js 的 Data Cache 去重 fetch 请求，例如在你的 fetch 选项中设置 cache: 'force-cache'。

Data Cache 允许在当前渲染过程和传入请求之间共享数据。

如果你没有使用 fetch，而是直接使用 ORM 或数据库，你可以使用 React cache 函数包装你的数据访问。

app/lib/data.ts

TypeScript

import { cache } from 'react'
import { db, posts, eq } from '@/lib/db'
 
export const getPost = cache(async (id: string) => {
  const post = await db.query.posts.findFirst({
    where: eq(posts.id, parseInt(id)),
  })
})

流式传输

警告：以下内容假设你的应用程序中启用了 cacheComponents 配置选项。该标志在 Next.js 15 canary 中引入。

当你在 Server Components 中获取数据时，数据会在服务器上为每个请求获取和渲染。如果你有任何慢速数据请求，整个路由将被阻止渲染，直到所有数据都被获取。

为了改善初始加载时间和用户体验，你可以使用流式传输将页面的 HTML 分解为更小的块，并逐步将这些块从服务器发送到客户端。

How Server Rendering with Streaming Works

有两种方式可以在你的应用程序中实现流式传输：

使用 loading.js 文件包裹页面
使用 <Suspense> 包裹组件

使用 `loading.js`

你可以在与页面相同的文件夹中创建一个 loading.js 文件，以在获取数据时流式传输整个页面。例如，要流式传输 app/blog/page.js，请在 app/blog 文件夹内添加该文件。

Blog folder structure with loading.js file

app/blog/loading.tsx

TypeScript

export default function Loading() {
  // 在这里定义加载 UI
  return <div>Loading...</div>
}

在导航时，用户将立即看到布局和加载状态，同时页面正在渲染。一旦渲染完成，新内容将自动替换。

在后台，loading.js 将嵌套在 layout.js 内部，并将自动将 page.js 文件和下面的任何子元素包裹在 <Suspense> 边界中。

这种方法适用于路由段（布局和页面），但对于更细粒度的流式传输，你可以使用 <Suspense>。

使用 `<Suspense>`

<Suspense> 允许你更精细地控制页面的哪些部分进行流式传输。例如，你可以立即显示 <Suspense> 边界之外的任何页面内容，并在边界内流式传输博客文章列表。

app/blog/page.tsx

TypeScript

import { Suspense } from 'react'
import BlogList from '@/components/BlogList'
import BlogListSkeleton from '@/components/BlogListSkeleton'
 
export default function BlogPage() {
  return (
    <div>
      {/* 此内容将立即发送到客户端 */}
      <header>
        <h1>Welcome to the Blog</h1>
        <p>Read the latest posts below.</p>
      </header>
      <main>
        {/* 任何包裹在 <Suspense> 边界中的内容都将被流式传输 */}
        <Suspense fallback={<BlogListSkeleton />}>
          <BlogList />
        </Suspense>
      </main>
    </div>
  )
}

例如，<Playlists> 组件只有在 <Artist> 组件完成数据获取后才会开始获取数据，因为 <Playlists> 依赖于 artistID prop：

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>
  )
}

为了改善用户体验，你应该使用 React <Suspense> 在获取数据时显示 fallback。这将启用流式传输并防止整个路由被顺序数据请求阻止。

并行数据获取

当路由中的数据请求被急切地启动并同时开始时，会发生并行数据获取。

默认情况下，布局和页面是并行渲染的。因此每个段都会尽快开始获取数据。

然而，在任何组件内，如果多个 async/await 请求放置在其他请求之后，仍然可能是顺序的。例如，getAlbums 将被阻止，直到 getArtist 解析：

app/artist/[username]/page.tsx

TypeScript

import { getArtist, getAlbums } from '@/app/lib/data'
 
export default async function Page({ params }) {
  // 这些请求将是顺序的
  const { username } = await params
  const artist = await getArtist(username)
  const albums = await getAlbums(username)
  return <div>{artist.name}</div>
}

通过调用 fetch 启动多个请求，然后使用 Promise.all await 它们。请求在调用 fetch 时立即开始。

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} />
    </>
  )
}

值得注意的是：使用 Promise.all 时，如果一个请求失败，整个操作都会失败。要处理这种情况，你可以使用 Promise.allSettled 方法代替。

预加载数据

你可以通过创建一个在阻塞请求之前急切调用的实用函数来预加载数据。<Item> 根据 checkIsAvailable() 函数有条件地渲染。

你可以在 checkIsAvailable() 之前调用 preload() 以急切地启动 <Item/> 数据依赖项。在 <Item/> 渲染时，其数据已经被获取。

app/item/[id]/page.tsx

TypeScript

import { getItem, checkIsAvailable } from '@/lib/data'
 
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
}
 
export const preload = (id: string) => {
  // void 计算给定的表达式并返回 undefined
  // https://developer.mozilla.org/docs/Web/JavaScript/Reference/Operators/void
  void getItem(id)
}
export async function Item({ id }: { id: string }) {
  const result = await getItem(id)
  // ...
}

此外，你可以使用 React 的 cache 函数和 server-only 包创建可重用的实用函数。这种方法允许你缓存数据获取函数并确保它仅在服务器上执行。

utils/get-item.ts

TypeScript

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

获取数据

获取数据

Server Components

使用 `fetch` API

使用 ORM 或数据库

Client Components

使用 `use` hook 流式传输数据

社区库

去重请求和缓存数据

流式传输

使用 `loading.js`

使用 `<Suspense>`

创建有意义的加载状态

示例

顺序数据获取

并行数据获取

预加载数据

API Reference

数据安全

loading.js

fetch

logging

taint