从组件路由进行框架适配

如果您正在使用 <RouterProvider>，请参阅从 RouterProvider 进行框架适配。

如果您正在使用 <Routes>，那么这里就是您需要的地方。

React Router Vite 插件为 React Router 增加了框架特性。本指南将帮助您在应用中适配该插件。如果您遇到任何问题，请在 Twitter 或 Discord 上寻求帮助。

特性

Vite 插件增加了

路由加载器、操作和自动数据重新验证
类型安全的路由模块
自动路由代码分割
导航间的自动滚动恢复
可选的静态预渲染
可选的服务器端渲染

初始设置需要做的工作最多。然而，一旦完成，您就可以增量地、逐个路由地采用新功能。

先决条件

要使用 Vite 插件，您的项目需要

Node.js 20+（如果使用 Node 作为运行时）
Vite 5+

1. 安装 Vite 插件

👉 安装 React Router Vite 插件

npm install -D @react-router/dev

👉 安装一个运行时适配器

我们假设您正在使用 Node 作为运行时。

npm install @react-router/node

👉 将 React 插件换成 React Router。

-import react from '@vitejs/plugin-react'
+import { reactRouter } from "@react-router/dev/vite";
import { defineConfig } from "vite";


export default defineConfig({
  plugins: [
-    react()
+    reactRouter()
  ],
});

2. 添加 React Router 配置

👉 创建一个 react-router.config.ts 文件

将以下内容添加到项目的根目录。在此配置中，您可以告知 React Router 您的项目信息，比如在哪里找到应用目录以及暂时不使用 SSR（服务器端渲染）。

touch react-router.config.ts

import type { Config } from "@react-router/dev/config";

export default {
  appDirectory: "src",
  ssr: false,
} satisfies Config;

3. 添加根入口点

在典型的 Vite 应用中，index.html 文件是打包的入口点。React Router Vite 插件将入口点移至 root.tsx 文件，这样您就可以使用 React 来渲染应用的框架，而不是静态 HTML，并最终在需要时升级到服务器端渲染。

👉 将您现有的 index.html 移动到 root.tsx

例如，如果您当前的 index.html 如下所示

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <meta
      name="viewport"
      content="width=device-width, initial-scale=1.0"
    />
    <title>My App</title>
  </head>
  <body>
    <div id="root"></div>
    <script type="module" src="/src/main.tsx"></script>
  </body>
</html>

您需要将该标记移入 src/root.tsx 并删除 index.html

touch src/root.tsx

import {
  Links,
  Meta,
  Outlet,
  Scripts,
  ScrollRestoration,
} from "react-router";

export function Layout({
  children,
}: {
  children: React.ReactNode;
}) {
  return (
    <html lang="en">
      <head>
        <meta charSet="UTF-8" />
        <meta
          name="viewport"
          content="width=device-width, initial-scale=1.0"
        />
        <title>My App</title>
        <Meta />
        <Links />
      </head>
      <body>
        {children}
        <ScrollRestoration />
        <Scripts />
      </body>
    </html>
  );
}

export default function Root() {
  return <Outlet />;
}

4. 添加客户端入口模块

在典型的 Vite 应用中，index.html 文件指向 src/main.tsx 作为客户端入口点。React Router 则使用一个名为 src/entry.client.tsx 的文件。

👉 将 src/entry.client.tsx 作为您的入口点

如果您当前的 src/main.tsx 如下所示

import React from "react";
import ReactDOM from "react-dom/client";
import { BrowserRouter } from "react-router";
import "./index.css";
import App from "./App";

ReactDOM.createRoot(
  document.getElementById("root")!,
).render(
  <React.StrictMode>
    <BrowserRouter>
      <App />
    </BrowserRouter>
  </React.StrictMode>,
);

您需要将其重命名为 entry.client.tsx 并更改为以下内容

import React from "react";
import ReactDOM from "react-dom/client";
import { HydratedRouter } from "react-router/dom";
import "./index.css";

ReactDOM.hydrateRoot(
  document,
  <React.StrictMode>
    <HydratedRouter />
  </React.StrictMode>,
);

使用 hydrateRoot 代替 createRoot
渲染一个 <HydratedRouter> 而不是您的 <App/> 组件
注意：我们停止了渲染 <App/> 组件。我们会在后面的步骤中把它加回来，但首先我们想让应用通过新的入口点启动。

5. 重新整理文件

在 root.tsx 和 entry.client.tsx 之间，您可能需要重新整理一些东西。

一般来说

root.tsx 包含任何渲染相关的东西，如上下文提供者、布局、样式等。
entry.client.tsx 应尽可能精简
记住，暂时不要尝试渲染您现有的 <App/> 组件，我们将在后面的步骤中进行

请注意，您的 root.tsx 文件将被静态生成并作为应用的入口点，因此只有该模块需要与服务器渲染兼容。这可能会是您遇到麻烦最多的地方。

6. 设置路由

React Router Vite 插件使用 routes.ts 文件来配置您的路由。现在，我们将添加一个简单的“全匹配”路由来启动项目。

👉 设置一个 catchall.tsx 路由

touch src/routes.ts src/catchall.tsx

import {
  type RouteConfig,
  route,
} from "@react-router/dev/routes";

export default [
  // * matches all URLs, the ? makes it optional so it will match / as well
  route("*?", "catchall.tsx"),
] satisfies RouteConfig;

👉 渲染一个占位符路由

最终我们会用我们原来的 App 组件替换它，但现在我们只渲染一些简单的东西，以确保我们能启动应用。

export default function Component() {
  return <div>Hello, world!</div>;
}

查看我们的路由配置指南，了解更多关于 routes.ts 文件的信息。

7. 启动应用程序

此时，您应该能够启动应用程序并看到根布局。

👉 添加 dev 脚本并运行应用

"scripts": {
  "dev": "react-router dev"
}

现在请确保在继续之前，您可以在此阶段启动您的应用

npm run dev

您可能需要将 .react-router/ 添加到您的 .gitignore 文件中，以避免在您的仓库中跟踪不必要的文件。

.react-router/

您可以查看类型安全来学习如何完全设置和使用自动生成的类型安全，包括参数、加载器数据等。

8. 渲染您的应用程序

为了回到渲染您的应用，我们将更新我们之前设置的“全匹配”路由，该路由匹配所有 URL，这样您现有的 <Routes> 就能有机会渲染。

👉 更新“全匹配”路由以渲染您的应用

import App from "./App";

export default function Component() {
  return <App />;
}

您的应用现在应该重新显示在屏幕上，并且像往常一样工作！

9. 将路由迁移到路由模块

您现在可以逐步将您的路由迁移到路由模块。

假设有一个像这样的现有路由

// ...
import About from "./containers/About";

export default function App() {
  return (
    <Routes>
      <Route path="/about" element={<About />} />
    </Routes>
  );
}

👉 将路由定义添加到 routes.ts

import {
  type RouteConfig,
  route,
} from "@react-router/dev/routes";

export default [
  route("/about", "./pages/about.tsx"),
  route("*?", "catchall.tsx"),
] satisfies RouteConfig;

👉 添加路由模块

编辑路由模块以使用路由模块 API

export async function clientLoader() {
  // you can now fetch data here
  return {
    title: "About page",
  };
}

export default function Component({ loaderData }) {
  return <h1>{loaderData.title}</h1>;
}

请参阅类型安全，以设置参数、加载器数据等的自动生成类型安全。

您迁移的前几个路由是最难的，因为您通常需要以与以前不同的方式访问各种抽象（例如在加载器中而不是从 hook 或 context 中）。但是一旦处理完最棘手的部分，您就会进入一个增量迁移的节奏。

启用 SSR 和/或预渲染

如果您想启用服务器渲染和静态预渲染，可以通过打包器插件中的 ssr 和 prerender 选项来实现。对于 SSR，您还需要将服务器构建部署到服务器上。

import type { Config } from "@react-router/dev/config";

export default {
  ssr: true,
  async prerender() {
    return ["/", "/about", "/contact"];
  },
} satisfies Config;