从组件路由采用框架

如果您使用的是 <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 渲染应用的 shell 而不是静态 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

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

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

您迁移的前几个路由是最难的，因为您通常需要以与之前略有不同的方式访问各种抽象（例如在加载器中而不是从钩子或上下文）。但是，一旦处理了最棘手的部分，您就会进入增量模式。

启用 SSR 和/或预渲染

如果您想启用服务器渲染和静态预渲染，您可以在捆绑器插件中的 ssr 和 prerender 选项中执行此操作。对于 SSR，您还需要将服务器构建部署到服务器。有关更多信息，请参阅部署。

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

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