React Router 服务端渲染中遇到的 HMR 热更新问题解析

2025-04-30 23:39:53作者：昌雅子Ethen

在 React Router 项目中实现服务端渲染(SSR)时，开发者可能会遇到一个棘手的问题：当添加 entry.server.tsx 文件后，虽然首次渲染正常，但在热更新(HMR)时会出现 ReferenceError: __reactRouterDataRouter is not defined 的错误。本文将深入分析这个问题背后的原因，并提供解决方案。

问题现象

当开发者按照 React Router 的文档配置服务端渲染时，通常会遇到以下两种场景：

没有 entry.server.tsx 文件时：
- 样式类名不会在服务端收集
- 客户端会出现 FOUC（无样式内容闪烁）现象
- 热更新功能正常工作
添加 entry.server.tsx 文件后：
- 服务端能正确收集样式
- 首次渲染无 FOUC 问题
- 热更新时抛出 __reactRouterDataRouter is not defined 错误

根本原因分析

这个问题实际上涉及到多个技术层面的交互：

hydration 不匹配：服务端和客户端渲染结果不一致导致 React 无法正确协调
路由实例断开：热更新过程中内部路由实例的连接丢失
异步组件问题：根布局组件使用 async 函数会加剧这个问题

解决方案

1. 检查样式收集实现

在使用 styled-components 等 CSS-in-JS 方案时，确保服务端和客户端的样式收集方式一致。推荐使用 ServerStyleSheet 进行服务端样式收集：

const sheet = new ServerStyleSheet()
const markup = renderToString(
  sheet.collectStyles(
    <ServerRouter
      context={reactRouterContext}
      url={request.url}
    />
  )
)

2. 避免异步根布局

将根布局组件从异步函数改为同步函数：

// 错误做法
export default async function RootLayout() {
  return <html>...</html>
}

// 正确做法
export default function RootLayout() {
  return <html>...</html>
}

3. 考虑流式渲染

对于更复杂的应用，建议探索流式渲染方案。虽然 styled-components 目前对流的支持仍在开发中，但这将是未来的最佳实践方向。

最佳实践建议

保持服务端和客户端一致性：确保两边渲染逻辑完全相同
简化根组件：避免在根布局中使用复杂逻辑或异步操作
逐步测试：先实现基本 SSR 功能，再逐步添加样式收集等特性
监控 hydration 警告：React 会在控制台输出 hydration 不匹配的警告，这些是排查问题的重要线索

通过以上分析和解决方案，开发者可以更好地在 React Router 项目中实现可靠的服务端渲染，同时保持开发体验中的热更新功能。记住，SSR 的实现往往需要权衡各种因素，找到最适合自己项目需求的平衡点。

登录后查看全文