logo
  • 指南
  • 配置
  • 插件
  • API
  • 示例
  • 社区
  • Modern.js 2.x 文档
  • 简体中文
    • 简体中文
    • English
    • 开始
      介绍
      快速上手
      版本升级
      名词解释
      技术栈
      核心概念
      页面入口
      构建工具
      Web 服务器
      基础功能
      路由
      路由基础
      配置式路由
      数据管理
      数据获取
      数据写入
      数据缓存
      渲染
      渲染模式总览
      服务端渲染(SSR)
      服务端流式渲染(Streaming SSR)
      渲染缓存
      静态站点生成(SSG)
      React Server Components (RSC)
      渲染预处理
      样式开发
      引入 CSS
      使用 CSS Modules
      使用 CSS-in-JS
      使用 Tailwind CSS
      HTML 模板
      引用静态资源
      引用 JSON 文件
      引用 SVG 资源
      引用 Wasm 资源
      调试
      数据模拟(Mock)
      网络代理
      使用 Rsdoctor
      使用 Storybook
      测试
      Playwright
      Vitest
      Jest
      Cypress
      路径别名
      环境变量
      构建产物目录
      部署应用
      进阶功能
      使用 BFF
      基础用法
      运行时框架
      创建可扩展的 BFF 函数
      扩展 BFF Server
      扩展一体化调用 SDK
      文件上传
      跨项目调用
      优化页面性能
      代码分割
      静态资源内联
      产物体积优化
      React Compiler
      提升构建性能
      浏览器兼容性
      配置底层工具
      源码构建模式
      服务端监控
      Monitors
      日志事件
      指标事件
      国际化
      基础概念
      快速开始
      配置说明
      语言检测
      资源加载
      路由集成
      API 参考
      高级用法
      最佳实践
      自定义 Web Server
      专题详解
      模块联邦
      简介
      开始使用
      应用级别模块
      服务端渲染
      部署
      集成国际化能力
      常见问题
      依赖安装问题
      命令行问题
      构建相关问题
      热更新问题
      从 Modern.js 2.0 升级
      概述
      配置变更
      入口变更
      自定义 Web Server 变化
      Tailwind 插件变更
      其他重要变更
      📝 编辑此页面
      上一页静态站点生成(SSG)下一页渲染预处理

      #React Server Components (RSC)

      React Server Components (RSC) 是一种新的组件类型,允许在服务端环境中渲染组件,为现代 Web 应用带来更好的性能和开发体验。

      #核心优势

      • 零客户端 JavaScript:Server Components 的代码不会被打包到客户端,显著减少客户端 bundle 体积
      • 直接访问服务端资源:可以直接访问数据库、文件系统、内部 API 等服务端资源,无需额外的 API 层
      • 更好的性能:数据获取更接近数据源,减少客户端数据瀑布流,提升首屏加载速度
      • 自动代码分割:基于实际渲染的数据进行代码分割,而不仅仅是路由,实现更精细的代码优化
      • 更高的内聚性:与数据、权限、缓存等紧密相关的逻辑可以留在 Server Component 中,组件内聚度更高,减少状态上浮和跨层级传递
      前置阅读

      在开始之前,建议你阅读 React 官方的 Server Components 文档,对 Server Component 有一个基本的了解。

      #快速开始

      1. 确保 React 和 React DOM 升级到 19 版本(建议 19.2.3 以上版本)

      2. 安装 react-server-dom-webpack 依赖

      npm install react-server-dom-webpack
      注意事项
      1. 目前暂不支持在 SPA 项目中使用 Server Functions
      2. 目前在 Rspack 构建时,产物分片和体积还未达到最优状态,我们将在近期进一步优化
      1. 设置 server.rsc 为 true:
      modern.config.ts
      import { defineConfig } from '@modern-js/app-tools';
      
      export default defineConfig({
        server: {
          rsc: true,
        },
      });
      旧 CSR 项目迁移

      如果是 CSR 项目,且项目中使用了 Modern.js 的 data loader,开启 RSC 后,data loader 默认会在服务端执行。 为了与原有行为保持一致,需要先将所有的 .data.ts 文件改为 .data.client.ts。

      #使用指南

      #默认行为

      默认情况下,当开启 RSC 时,Modern.js 中的所有组件默认是 Server Component。Server Component 允许你在服务端获取数据并渲染 UI。当需要交互性(如事件处理、状态管理)或使用浏览器 API 时,你可以使用 "use client" 指令将组件标记为 Client Component。

      #组件类型选择

      #何时使用 Client Component

      当组件需要以下功能时,你需要使用 "use client" 指令将其标记为 Client Component:

      • 交互性:使用 State 和 event handlers,例如 onClick、onChange、onSubmit
      • 生命周期:使用生命周期相关的 hook,例如 useEffect、useLayoutEffect
      • 浏览器 API:使用浏览器的 API(如 window、document、localStorage、navigator 等)
      • 自定义 Hook:使用自定义 hook,特别是那些依赖客户端特性的 hook

      #何时使用 Server Component

      以下场景应该使用 Server Component(默认行为,无需额外标记):

      1. 访问服务端资源:使用服务端才有的 API(如 Node.js 的 API、文件系统、consul、RPC 等)
      2. 数据获取:在服务端获取数据以优化性能,减少客户端请求
      3. 安全性:访问私密的环境变量或 API 密钥,避免暴露给客户端
      4. 减少 bundle 体积:使用大型依赖库,这些库不需要包含在客户端 bundle 中
      5. 静态内容:渲染静态或变化频率低的内容

      #Client Boundary(客户端边界)

      一旦一个文件被标记为 "use client",那么它所导入的所有其他模块(如果它们还没有被标记为 "use client")也会被认为是客户端代码,并被包含在客户端的 JavaScript 包中。这就是 Client Boundary 的概念。

      理解 Client Boundary

      "use client" 指令创建了一个边界:边界内的所有代码都会被打包到客户端。这意味着即使 Button 和 Tooltip 组件本身没有 "use client" 指令,它们也会因为被 InteractiveCard 导入而成为客户端代码。

      components/InteractiveCard.tsx
      'use client'; // <--- 这里是 Client Boundary 的起点
      
      import { useState } from 'react';
      import Button from './Button'; // Button.tsx 没有 "use client",但会被包含在客户端 bundle 中
      import Tooltip from './Tooltip'; // Tooltip.tsx 也没有 "use client",同样会被包含
      
      export default function InteractiveCard() {
        const [isActive, setIsActive] = useState(false);
      
        return (
          <div onClick={() => setIsActive(!isActive)}>
            <p>Click me!</p>
            <Button />
            <Tooltip text="This is a card" />
          </div>
        );
      }

      #如何组合两种组件

      Server Component 和 Client Component 并非孤立存在,它们需要协同工作。请记住以下两条规则:

      #Server Component 可以导入 Client Component

      这是最常见的模式,你的页面主体是一个 Server Component,负责获取数据和布局,而在其中需要交互的部分,则嵌入 Client Component。

      routes/page.tsx
      // Server Component(默认,无需标记)
      import CounterButton from './CounterButton'; // 这是一个 Client Component
      
      async function getPageData() {
        // 在服务端获取数据
        const res = await fetch('https://api.example.com/data');
        return res.json();
      }
      
      export default async function Page() {
        const data = await getPageData();
      
        return (
          <div>
            <h1>{data.title}</h1> {/* 服务端渲染 */}
            <p>This part is static.</p>
            {/* Client Component 可以无缝嵌入 Server Component */}
            <CounterButton />
          </div>
        );
      }
      routes/CounterButton.tsx
      'use client'; // Client Component
      
      import { useState } from 'react';
      
      export default function CounterButton() {
        const [count, setCount] = useState(0);
        return <button onClick={() => setCount(c => c + 1)}>Count: {count}</button>;
      }

      #Client Component 不能直接导入 Server Component

      这一点初看起来可能有些违反直觉。原因在于:Server Component 的代码根本不存在于客户端。当一个 Client Component 在浏览器中渲染时,它无法去执行一个只存在于服务器上的函数。

      但是,有两种模式可以绕过这个限制:

      1. 通过 children Prop 传递 Server Component

      你可以将 Server Components 作为 children Prop 传递给一个 Client Component。假设一个带动画的 Tabs 组件,Tabs 的切换逻辑本身是客户端的,但每个标签页的内容可能是静态的、从服务器获取的。

      app/components/Tabs.tsx
      'use client'; // Client Component
      
      import React, { useState } from 'react';
      
      interface TabsProps {
        tabLabels: string[];
        children: React.ReactNode;
      }
      
      export default function Tabs({ tabLabels, children }: TabsProps) {
        const [activeTab, setActiveTab] = useState(0);
      
        return (
          <div>
            <nav>
              {tabLabels.map((label, index) => (
                <button key={label} onClick={() => setActiveTab(index)}>
                  {label}
                </button>
              ))}
            </nav>
            {/* React.Children.toArray 会确保只渲染活跃的子组件 */}
            <div>{React.Children.toArray(children)[activeTab]}</div>
          </div>
        );
      }
      app/dashboard/page.tsx
      // Server Component(默认)
      import Tabs from '../components/Tabs';
      import Analytics from '../components/Analytics'; // Server Component
      import UserSettings from '../components/UserSettings'; // Server Component
      
      export default function DashboardPage() {
        const labels = ['Analytics', 'Settings'];
      
        return (
          <main>
            <h1>Dashboard</h1>
            {/*
              这里,Tabs 是 Client Component(负责交互逻辑),
              但 Analytics 和 UserSettings 是在服务端渲染好的 Server Component,
              它们作为 children prop 传递给 Tabs 组件。
              这样既保持了交互性,又最大化利用了服务端渲染的优势。
            */}
            <Tabs tabLabels={labels}>
              <Analytics />
              <UserSettings />
            </Tabs>
          </main>
        );
      }

      通过这种模式,你可以在保持交互性的同时,最大限度地将组件保留在服务端,从而获得极致的性能。这是 RSC 中最强大的组合模式之一。

      2. 路由组件可以独立选择组件类型

      每一级的路由组件(如 layout.tsx、page.tsx)可以独立选择是 Client Component 还是 Server Component:

      - routes
          - layout.tsx  // 可以是 Client Component
          - page.tsx    // 可以是 Server Component

      例如,假设 layout.tsx 是一个 Client Component(需要客户端交互),你仍然可以将 page.tsx 设置为 Server Component(用于数据获取和渲染)。这种方式提供了极大的灵活性,也使非 RSC 项目可以渐进式地迁移至 RSC 项目。

      #注意事项

      #旧 CSR 项目

      如果是 CSR 项目,且项目中使用了 EdenX 的 data loader,开启 RSC 后,data loader 默认是在服务端执行,这意味着需要先把所有的 .data.ts 文件改为.data.client.ts,才能和之前的行为保持一致。

      #使用 Streaming SSR 的项目

      如果你同时使用了 Streaming SSR 和 RSC,在 react19 中需要通过使用 use,而不再需要使用 Await 组件:

      function NonCriticalUI({ p }: { p: Promise<string> }) {
        let value = React.use(p);
        return <h3>Non critical value {value}</h3>;
      }
      
      <React.Suspense fallback={<div>Loading...</div>}>
        <NonCriticalUI p={nonCriticalData} />
      </React.Suspense>

      #最佳实践

      #获取数据

      1. 不管是 SSR 还是 RSC 项目,建议在服务端执行的数据获取逻辑默认使用 Modern.js 提供的 cache 函数,这样每一次服务端渲染,不管调用该函数多少次,只会执行一次。

      这也是 react.js 推荐的用法,为此 react.js 提供了 cache, Modern.js 的 cache 可以视作其超集。

      import { cache } from '@modern-js/runtime/cache';
      
      const getCriticalCached = cache(getCritical);
      • 在使用 cache 函数的基础上,你不再需要通过 props,context 等管理服务端的状态,我们推荐哪个组件需要数据就在最近的 Server Component 中获取数据,通过 cache 函数,即使多次调用同一个函数,这样可以使项目的状态管理,业务逻辑,性能优化更简单。
      // layout.tsx
      export default async function Layout() {
        const criticalData = await getCriticalCached();
      }
      
      export default async function Page() {
        const criticalData = await getCriticalCached();
      }

      #最佳性能

      为了发挥 RSC 或 Streaming SSR 的优势,我们需要使尽可能多的组件流动起来,一个核心原则是使 Suspense 包裹的区域尽可能地小(这也是我们推荐使用 cache 函数的原因之一)

      对于直接消费数据的 Server Component,我们推荐在其上层包裹 Suspense:

      这种场景下 Server Component 往往是异步的,还有一种情况 Server Component 为同步的,由 Client Component 消费数据,在下面进行描述

      // profile/components/PostsList.tsx
      export default async function PostsList() {
        const posts = await getUserPosts();
      
        return (
          <ul>
            {posts.map(post => (
              <li key={post.id}>{post.title}</li>
            ))}
          </ul>
        );
      }
      // profile/page.tsx
      import { Suspense } from 'react';
      import UserInfo from './components/UserInfo';
      import PostsList from './components/PostsList';
      import PostsSkeleton from './components/PostsSkeleton';
      
      export default function ProfilePage() {
        return (
          <div>
            <UserInfo />
      
            <hr />
      
            {/*
              我们将慢速的 PostsList 包裹在 Suspense 中。
              当 PostsList 正在获取数据时,用户会看到 PostsSkeleton。
              一旦 PostsList 的数据准备就绪,它会自动替换掉骨架屏。
            */}
            <Suspense fallback={<PostsSkeleton />}>
              <PostsList posts={postsPromise} />
            </Suspense>
          </div>
        );
      }

      还有一种场景是在 Client Component 中消费数据,此时我们应避免在 Server Component 中使用 await,避免阻塞渲染:

      // profile/components/PostsList.tsx
      'use client';
      export default function PostsList({ postsPromise }) {
        const posts = use(postsPromise);
      
        return (
          <ul>
            {posts.map(post => (
              <li key={post.id}>{post.title}</li>
            ))}
          </ul>
        );
      }
      // profile/page.tsx
      import { Suspense } from 'react';
      import UserInfo from './components/UserInfo';
      import PostsList from './components/PostsList'; // 现在是 Client Component
      import PostsSkeleton from './components/PostsSkeleton';
      import { getUserPosts } from '../lib/data'; // 导入数据获取函数
      
      // 注意:这个组件不是 async 的
      export default function ProfilePage() {
        // 1. 在服务端调用数据获取函数,但不 await 它
        // 这会立即返回一个 Promise
        const postsPromise = getUserPosts();
      
        return (
          <div>
            <UserInfo />
      
            <hr />
      
            {/* 2. Suspense 边界依然是必需的。它会捕获
                由 PostsList 内部的 `use` 钩子抛出的 Promise */}
            <Suspense fallback={<PostsSkeleton />}>
              {/* 3. 将 Promise 对象本身作为 prop 传递给客户端组件 */}
              <PostsList postsPromise={postsPromise} />
            </Suspense>
          </div>
        );
      }

      #Helmet

      当使用 react19 时,无需再使用 Helmet,推荐直接使用 react 提供的组件。

      #常见问题

      #This entry point is not yet supported outside of experimental channels

      项目中的 bundle 引入了非 19 的 react 版本,常见于 monorepo。请确保所有依赖都使用 React 19 版本。

      #相关链接

      • React Server Components 官方文档
      • React Server Functions 文档
      • 数据缓存
      • 服务端渲染(SSR)
      • Streaming SSR