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

2025-04-30 03:00:00作者：昌雅子Ethen

React Router 是一款轻量级、功能齐全的React库路由解决方案，适用于Web、服务器（基于node.js）和React Native。无论你是新手还是从v5升级到v6，都能找到相应的教程和迁移指南。参与贡献，查看我们的贡献指南。这是一个包含多个包的单仓库，如`react-router`, `react-router-dom`, 和 `react-router-native`。让我们共同打造更好的React路由体验！

项目地址：https://gitcode.com/gh_mirrors/reac/react-router

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