服务器和客户端组合模式

在构建 React 应用程序时，您需要考虑应用程序的哪些部分应该在服务器或客户端上渲染。此页面介绍在使用服务器组件和客户端组件时的一些推荐的组合模式。

何时使用服务器组件和客户端组件？

以下是服务器组件和客户端组件的不同用例的快速总结

您需要做什么？	服务器组件	客户端组件
获取数据
访问后端资源（直接）
将敏感信息保存在服务器上（访问令牌、API 密钥等）
将大型依赖项保存在服务器上/减少客户端 JavaScript
添加交互性和事件监听器（`onClick()`、`onChange()` 等）
使用状态和生命周期效果（`useState()`、`useReducer()`、`useEffect()` 等）
使用仅浏览器 API
使用依赖于状态、效果或仅浏览器 API 的自定义钩子
使用 React 类组件

服务器组件模式

在选择客户端渲染之前，您可能希望在服务器上执行一些工作，例如获取数据或访问您的数据库或后端服务。

以下是使用服务器组件时的一些常见模式

在服务器上获取数据时，可能存在需要跨不同组件共享数据的情况。例如，您可能拥有一个布局和一个依赖于相同数据的页面。

而不是使用 React 上下文（在服务器上不可用）或将数据作为道具传递，您可以使用 fetch 或 React 的 cache 函数在需要它的组件中获取相同的数据，而无需担心对相同数据发出重复请求。这是因为 React 扩展了 fetch 以自动记忆数据请求，并且当 fetch 不可用时可以使用 cache 函数。

查看此模式的示例。

避免将仅服务器端代码引入客户端环境

由于 JavaScript 模块可以在服务器端和客户端组件模块之间共享，因此仅打算在服务器端运行的代码可能会意外地进入客户端。

例如，请考虑以下数据获取函数

lib/data.ts

export async function getData() {
  const res = await fetch('https://external-service.com/data', {
    headers: {
      authorization: process.env.API_KEY,
    },
  })
 
  return res.json()
}

乍一看，getData 似乎可以在服务器端和客户端上运行。但是，此函数包含一个 API_KEY，其编写意图是仅在服务器端执行。

由于环境变量 API_KEY 没有以 NEXT_PUBLIC 为前缀，因此它是一个私有变量，只能在服务器端访问。为了防止环境变量泄露到客户端，Next.js 会将私有环境变量替换为空字符串。

因此，即使 getData() 可以在客户端导入和执行，它也不会按预期工作。虽然将变量设为公共变量可以使函数在客户端上工作，但您可能不希望将敏感信息暴露给客户端。

为了防止这种意外的客户端使用服务器端代码的情况，我们可以使用 server-only 包，如果开发人员意外地将这些模块中的任何一个导入到客户端组件中，则会引发构建时错误。

要使用 server-only，首先安装该包

终端

npm install server-only

然后将该包导入到包含仅服务器端代码的任何模块中

lib/data.js

import 'server-only'
 
export async function getData() {
  const res = await fetch('https://external-service.com/data', {
    headers: {
      authorization: process.env.API_KEY,
    },
  })
 
  return res.json()
}

现在，任何导入 getData() 的客户端组件都会收到一个构建时错误，说明此模块只能在服务器端使用。

相应的包 client-only 可以用来标记包含仅客户端代码的模块 - 例如，访问 window 对象的代码。

使用第三方包和提供程序

由于服务器端组件是 React 的一项新功能，生态系统中的第三方包和提供程序才刚刚开始为使用仅客户端功能（如 useState、useEffect 和 createContext）的组件添加 "use client" 指令。

目前，许多来自 npm 包并使用仅客户端功能的组件尚未包含该指令。这些第三方组件在客户端组件中可以按预期工作，因为它们具有 "use client" 指令，但在服务器端组件中则无法工作。

例如，假设您安装了假设的 acme-carousel 包，该包具有一个 <Carousel /> 组件。此组件使用 useState，但尚未包含 "use client" 指令。

如果您在客户端组件中使用 <Carousel />，它将按预期工作

app/gallery.tsx

'use client'
 
import { useState } from 'react'
import { Carousel } from 'acme-carousel'
 
export default function Gallery() {
  const [isOpen, setIsOpen] = useState(false)
 
  return (
    <div>
      <button onClick={() => setIsOpen(true)}>View pictures</button>
 
      {/* Works, since Carousel is used within a Client Component */}
      {isOpen && <Carousel />}
    </div>
  )
}

但是，如果您尝试在服务器端组件中直接使用它，则会看到错误

app/page.tsx

import { Carousel } from 'acme-carousel'
 
export default function Page() {
  return (
    <div>
      <p>View pictures</p>
 
      {/* Error: `useState` can not be used within Server Components */}
      <Carousel />
    </div>
  )
}

这是因为 Next.js 不知道 <Carousel /> 正在使用仅客户端功能。

要解决此问题，您可以将依赖于仅客户端功能的第三方组件包装在您自己的客户端组件中

app/carousel.tsx

'use client'
 
import { Carousel } from 'acme-carousel'
 
export default Carousel

现在，您可以在服务器端组件中直接使用 <Carousel />

app/page.tsx

import Carousel from './carousel'
 
export default function Page() {
  return (
    <div>
      <p>View pictures</p>
 
      {/*  Works, since Carousel is a Client Component */}
      <Carousel />
    </div>
  )
}

我们预计您不需要包装大多数第三方组件，因为您可能会在客户端组件中使用它们。但是，一个例外是提供程序，因为它们依赖于 React 状态和上下文，并且通常需要在应用程序的根目录中使用。了解有关下方第三方上下文提供程序的更多信息。

使用上下文提供程序

上下文提供程序通常渲染在应用程序的根目录附近，以共享全局问题，例如当前主题。由于React 上下文在服务器端组件中不受支持，因此尝试在应用程序的根目录处创建上下文会导致错误

app/layout.tsx

import { createContext } from 'react'
 
//  createContext is not supported in Server Components
export const ThemeContext = createContext({})
 
export default function RootLayout({ children }) {
  return (
    <html>
      <body>
        <ThemeContext.Provider value="dark">{children}</ThemeContext.Provider>
      </body>
    </html>
  )
}

要解决此问题，请在客户端组件内创建上下文并渲染其提供程序

app/theme-provider.tsx

'use client'
 
import { createContext } from 'react'
 
export const ThemeContext = createContext({})
 
export default function ThemeProvider({
  children,
}: {
  children: React.ReactNode
}) {
  return <ThemeContext.Provider value="dark">{children}</ThemeContext.Provider>
}

您的服务器端组件现在可以直接渲染您的提供程序，因为它已被标记为客户端组件

app/layout.tsx

import ThemeProvider from './theme-provider'
 
export default function RootLayout({
  children,
}: {
  children: React.ReactNode
}) {
  return (
    <html>
      <body>
        <ThemeProvider>{children}</ThemeProvider>
      </body>
    </html>
  )
}

在根目录处渲染提供程序后，应用程序中的所有其他客户端组件都将能够使用此上下文。

注意：您应该尽可能在树中更深处渲染提供程序 - 请注意 ThemeProvider 如何仅包装 {children} 而不是整个 <html> 文档。这使 Next.js 更易于优化服务器端组件的静态部分。

库作者建议

类似地，创建供其他开发人员使用的包的库作者可以使用 "use client" 指令来标记其包的客户端入口点。这允许包的用户直接将其包组件导入到其服务器端组件中，而无需创建包装边界。

您可以通过使用'use client' 在树中更深处来优化您的包，从而允许导入的模块成为服务器端组件模块图的一部分。

值得注意的是，某些打包工具可能会去除 "use client" 指令。您可以在React Wrap Balancer和Vercel Analytics存储库中找到有关如何配置 esbuild 以包含 "use client" 指令的示例。

客户端组件

将客户端组件移至树中更深处

为了减少客户端 JavaScript 包的大小，我们建议将客户端组件移至组件树中更深处。

例如，您可能有一个布局，其中包含静态元素（例如徽标、链接等）和一个使用状态的交互式搜索栏。

与其将整个布局设为客户端组件，不如将交互逻辑移至客户端组件（例如 <SearchBar />），并将布局保留为服务器端组件。这意味着您不必将布局的所有组件 JavaScript 发送到客户端。

app/layout.tsx

// SearchBar is a Client Component
import SearchBar from './searchbar'
// Logo is a Server Component
import Logo from './logo'
 
// Layout is a Server Component by default
export default function Layout({ children }: { children: React.ReactNode }) {
  return (
    <>
      <nav>
        <Logo />
        <SearchBar />
      </nav>
      <main>{children}</main>
    </>
  )
}

将属性从服务器端传递到客户端组件（序列化）

如果您在服务器端组件中获取数据，您可能希望将数据作为属性传递给客户端组件。从服务器端传递到客户端组件的属性需要由 React 序列化。

如果您的客户端组件依赖于不可序列化的数据，您可以使用第三方库在客户端获取数据或使用路由处理器在服务器端获取数据。

交错服务器端和客户端组件

当交错客户端和服务器端组件时，将您的 UI 视为组件树可能会有所帮助。从根布局（这是一个服务器端组件）开始，然后可以通过添加 "use client" 指令在客户端上渲染某些组件子树。

在这些客户端子树中，您仍然可以嵌套服务器端组件或调用服务器端操作，但需要注意一些事项

在请求-响应生命周期中，您的代码从服务器端移动到客户端。如果您需要在客户端访问服务器端的数据或资源，则需要向服务器发出新请求 - 而不是来回切换。
当向服务器发出新请求时，首先会渲染所有服务器端组件，包括嵌套在客户端组件中的那些组件。渲染结果（RSC有效负载）将包含对客户端组件位置的引用。然后，在客户端，React 使用 RSC 有效负载将服务器端和客户端组件协调成一棵树。

由于客户端组件是在服务器组件之后渲染的，因此您无法将服务器组件导入到客户端组件模块中（因为这需要向服务器发出新的请求）。相反，您可以将服务器组件作为props传递给客户端组件。请参阅下面的不支持的模式和支持的模式部分。

不支持的模式：将服务器组件导入客户端组件

以下模式不受支持。您无法将服务器组件导入客户端组件。

app/client-component.tsx

'use client'
 
// You cannot import a Server Component into a Client Component.
import ServerComponent from './Server-Component'
 
export default function ClientComponent({
  children,
}: {
  children: React.ReactNode
}) {
  const [count, setCount] = useState(0)
 
  return (
    <>
      <button onClick={() => setCount(count + 1)}>{count}</button>
 
      <ServerComponent />
    </>
  )
}

支持的模式：将服务器组件作为 Props 传递给客户端组件

以下模式受支持。您可以将服务器组件作为 prop 传递给客户端组件。

一种常见的模式是使用 React 的children prop 在您的客户端组件中创建一个“插槽”。

在下面的示例中，<ClientComponent> 接受一个children prop。

app/client-component.tsx

'use client'
 
import { useState } from 'react'
 
export default function ClientComponent({
  children,
}: {
  children: React.ReactNode
}) {
  const [count, setCount] = useState(0)
 
  return (
    <>
      <button onClick={() => setCount(count + 1)}>{count}</button>
      {children}
    </>
  )
}

<ClientComponent>不知道children最终将由服务器组件的结果填充。<ClientComponent>唯一的责任是决定children最终将在哪里放置。

在父服务器组件中，您可以同时导入<ClientComponent>和<ServerComponent>，并将<ServerComponent>作为<ClientComponent>的子元素传递。

app/page.tsx

// This pattern works:
// You can pass a Server Component as a child or prop of a
// Client Component.
import ClientComponent from './client-component'
import ServerComponent from './server-component'
 
// Pages in Next.js are Server Components by default
export default function Page() {
  return (
    <ClientComponent>
      <ServerComponent />
    </ClientComponent>
  )
}

通过这种方法，<ClientComponent>和<ServerComponent>是解耦的，可以独立渲染。在这种情况下，子元素<ServerComponent>可以在服务器端渲染，早于客户端渲染<ClientComponent>。

了解一下

“向上提升内容”的模式已被用于避免在父组件重新渲染时重新渲染嵌套的子组件。

您不限于children prop。您可以使用任何 prop 传递 JSX。