React Server Components (RSC) 是一种新的组件类型,允许在服务端环境中渲染组件,为现代 Web 应用带来更好的性能和开发体验。
在开始之前,建议你阅读 React 官方的 Server Components 文档,对 Server Component 有一个基本的了解。
确保 React 和 React DOM 升级到 19 版本(建议 19.2.3 以上版本)
安装 react-server-dom-webpack 依赖
npm install react-server-dom-webpackserver.rsc 为 true:import { defineConfig } from '@modern-js/app-tools';
export default defineConfig({
server: {
rsc: true,
},
});
如果是 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。
当组件需要以下功能时,你需要使用 "use client" 指令将其标记为 Client Component:
onClick、onChange、onSubmituseEffect、useLayoutEffectwindow、document、localStorage、navigator 等)以下场景应该使用 Server Component(默认行为,无需额外标记):
一旦一个文件被标记为 "use client",那么它所导入的所有其他模块(如果它们还没有被标记为 "use client")也会被认为是客户端代码,并被包含在客户端的 JavaScript 包中。这就是 Client Boundary 的概念。
"use client" 指令创建了一个边界:边界内的所有代码都会被打包到客户端。这意味着即使 Button 和 Tooltip 组件本身没有 "use client" 指令,它们也会因为被 InteractiveCard 导入而成为客户端代码。
'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(默认,无需标记)
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>
);
}'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>;
}这一点初看起来可能有些违反直觉。原因在于:Server Component 的代码根本不存在于客户端。当一个 Client Component 在浏览器中渲染时,它无法去执行一个只存在于服务器上的函数。
但是,有两种模式可以绕过这个限制:
1. 通过 children Prop 传递 Server Component
你可以将 Server Components 作为 children Prop 传递给一个 Client Component。假设一个带动画的 Tabs 组件,Tabs 的切换逻辑本身是客户端的,但每个标签页的内容可能是静态的、从服务器获取的。
'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>
);
}// 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 项目,且项目中使用了 EdenX 的 data loader,开启 RSC 后,data loader 默认是在服务端执行,这意味着需要先把所有的 .data.ts 文件改为.data.client.ts,才能和之前的行为保持一致。
如果你同时使用了 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>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>
);
}当使用 react19 时,无需再使用 Helmet,推荐直接使用 react 提供的组件。
This entry point is not yet supported outside of experimental channels项目中的 bundle 引入了非 19 的 react 版本,常见于 monorepo。请确保所有依赖都使用 React 19 版本。