React Router v7 是 Remix v2 之后的下一个主要版本（有关更多信息，请参阅我们的 "逐步迈向 React 19" 博客文章）。
如果您已启用所有 Remix v2 未来特性标志，则从 Remix v2 升级到 React Router v7 主要涉及更新依赖项。
大多数步骤 2-8 可以使用社区成员 James Restall 创建的 codemod 自动更新。
👉 启用未来特性标志
在您的 Remix v2 应用程序中启用所有现有的 未来特性标志。
过去通过运行时特定包（@remix-run/node、@remix-run/cloudflare 等）重新导出的大多数“共享”API 在 v7 中都已合并到 react-router 中。因此，您将直接从 react-router 中导入这些内容，而不是从 @react-router/node 或 @react-router/cloudflare 中导入。
-import { redirect } from "@remix-run/node";
+import { redirect } from "react-router";
在 v7 中，您应该从运行时特定包中导入的唯一 API 是特定于该运行时的 API，例如 Node 的 createFileSessionStorage 和 Cloudflare 的 createWorkersKVSessionStorage。
👉 运行 codemod（自动化）
您可以使用以下 codemod 自动更新您的包和导入。此 codemod 会更新您所有的包和导入。在运行 codemod 之前，请务必提交任何未决更改，以防您需要回滚。
npx codemod remix/2/react-router/upgrade
👉 安装新依赖项
codemod 更新您的依赖项后，您需要安装依赖项以删除 Remix 包并添加新的 React Router 包。
npm install
👉 更新您的依赖项（手动）
如果您不想使用 codemod，可以手动更新您的依赖项。
| Remix v2 包 | React Router v7 包 | |
|---|---|---|
@remix-run/architect |
➡️ | @react-router/architect |
@remix-run/cloudflare |
➡️ | @react-router/cloudflare |
@remix-run/dev |
➡️ | @react-router/dev |
@remix-run/express |
➡️ | @react-router/express |
@remix-run/fs-routes |
➡️ | @react-router/fs-routes |
@remix-run/node |
➡️ | @react-router/node |
@remix-run/react |
➡️ | react-router |
@remix-run/route-config |
➡️ | @react-router/dev |
@remix-run/routes-option-adapter |
➡️ | @react-router/remix-routes-option-adapter |
@remix-run/serve |
➡️ | @react-router/serve |
@remix-run/server-runtime |
➡️ | react-router |
@remix-run/testing |
➡️ | react-router |
package.json 中的 scripts如果您使用了 codemod，则可以跳过此步骤，因为它已自动完成。
👉 更新 package.json 中的脚本
| 脚本 | Remix v2 | React Router v7 | |
|---|---|---|---|
dev |
remix vite:dev |
➡️ | react-router dev |
build |
remix vite:build |
➡️ | react-router build |
start |
remix-serve build/server/index.js |
➡️ | react-router-serve build/server/index.js |
typecheck |
tsc |
➡️ | react-router typegen && tsc |
routes.ts 文件如果您使用了 codemod *并且*启用了 Remix v2 v3_routeConfig 标志，则可以跳过此步骤，因为它已自动完成。
在 React Router v7 中，您可以使用 app/routes.ts 文件定义路由。查看 路由文档 以获取更多信息。
👉 更新依赖项（如果使用 Remix v2 v3_routeConfig 标志）
// app/routes.ts
-import { type RouteConfig } from "@remix-run/route-config";
-import { flatRoutes } from "@remix-run/fs-routes";
-import { remixRoutesOptionAdapter } from "@remix-run/routes-option-adapter";
+import { type RouteConfig } from "@react-router/dev/routes";
+import { flatRoutes } from "@react-router/fs-routes";
+import { remixRoutesOptionAdapter } from "@react-router/remix-routes-option-adapter";
export default [
// however your routes are defined
] satisfies RouteConfig;
👉 添加 routes.ts 文件（如果不使用 Remix v2 v3_routeConfig 标志）
touch app/routes.ts
为了向后兼容以及为了那些更喜欢 基于文件约定 的用户，您可以通过新的 @react-router/fs-routes 包选择加入与您在 Remix v2 中使用的相同“扁平路由”约定
import { type RouteConfig } from "@react-router/dev/routes";
import { flatRoutes } from "@react-router/fs-routes";
export default flatRoutes() satisfies RouteConfig;
或者，如果您使用 routes 选项定义基于配置的路由
import { type RouteConfig } from "@react-router/dev/routes";
import { remixRoutesOptionAdapter } from "@react-router/remix-routes-option-adapter";
export default remixRoutesOptionAdapter((defineRoutes) => {
return defineRoutes((route) => {
route("/", "home/route.tsx", { index: true });
route("about", "about/route.tsx");
route("", "concerts/layout.tsx", () => {
route("trending", "concerts/trending.tsx");
route(":city", "concerts/city.tsx");
});
});
}) satisfies RouteConfig;
如果您在 vite.config.ts 中使用 routes 选项，请务必将其删除。
export default defineConfig({
plugins: [
remix({
ssr: true,
- ignoredRouteFiles: ['**/*'],
- routes(defineRoutes) {
- return defineRoutes((route) => {
- route("/somewhere/cool/*", "catchall.tsx");
- });
- },
})
tsconfigPaths(),
],
});
👉 在您的项目中添加 react-router.config.ts
以前传递给 vite.config.ts 中的 remix 插件的配置现在从 react-router.config.ts 导出。
注意：此时，您应该删除在步骤 1 中添加的 v3 未来特性标志。
touch react-router.config.ts
// vite.config.ts
export default defineConfig({
plugins: [
- remix({
- ssr: true,
- future: {/* all the v3 flags */}
- }),
+ remix(),
tsconfigPaths(),
],
});
// react-router.config.ts
+import type { Config } from "@react-router/dev/config";
+export default {
+ ssr: true,
+} satisfies Config;
vite.config如果您使用了 codemod，则可以跳过此步骤，因为它已自动完成。
👉 将 reactRouter 插件添加到 vite.config
更改 vite.config.ts 以导入并使用来自 @react-router/dev/vite 的新 reactRouter 插件
-import { vitePlugin as remix } from "@remix-run/dev";
+import { reactRouter } from "@react-router/dev/vite";
import { defineConfig } from "vite";
import tsconfigPaths from "vite-tsconfig-paths";
export default defineConfig({
plugins: [
- remix(),
+ reactRouter(),
tsconfigPaths(),
],
});
如果您没有使用 TypeScript，则可以跳过此步骤。
React Router 会自动将路由模块的类型生成到应用程序根目录下的 .react-router/ 目录中。此目录完全由 React Router 管理，应将其添加到 .gitignore 中。了解有关 新的类型安全功能 的更多信息。
👉 将 .react-router/ 添加到 .gitignore
.react-router/
👉 更新 tsconfig.json
更新 tsconfig.json 中的 types 字段以包含
.react-router/types/**/* 路径在 include 字段中types 字段中的适当 @react-router/* 包rootDirs 用于简化相对导入{
"include": [
/* ... */
+ ".react-router/types/**/*"
],
"compilerOptions": {
- "types": ["@remix-run/node", "vite/client"],
+ "types": ["@react-router/node", "vite/client"],
/* ... */
+ "rootDirs": [".", "./.react-router/types"]
}
}
如果您使用了 codemod，则可以跳过此步骤，因为它已自动完成。
如果您的应用程序中包含 entry.server.tsx 和/或 entry.client.tsx 文件，则需要更新这些文件中的主要组件
-import { RemixServer } from "@remix-run/react";
+import { ServerRouter } from "react-router";
-<RemixServer context={remixContext} url={request.url} />,
+<ServerRouter context={remixContext} url={request.url} />,
-import { RemixBrowser } from "@remix-run/react";
+import { HydratedRouter } from "react-router/dom";
hydrateRoot(
document,
<StrictMode>
- <RemixBrowser />
+ <HydratedRouter />
</StrictMode>,
);
AppLoadContext 的类型如果您使用的是 remix-serve，则可以跳过此步骤。这仅适用于您在 Remix v2 中使用自定义服务器的情况。
由于 React Router 可以用作 React 框架 *和*独立的路由库，因此 LoaderFunctionArgs 和 ActionFunctionArgs 的 context 参数现在是可选的，默认情况下类型为 any。您可以为加载上下文注册类型以获取加载器和操作的类型安全。
👉 注册加载上下文的类型
在迁移到新的 Route.LoaderArgs 和 Route.ActionArgs 类型之前，您可以暂时使用您的加载上下文类型来扩展 LoaderFunctionArgs 和 ActionFunctionArgs 以简化迁移。
declare module "react-router" {
// Your AppLoadContext used in v2
interface AppLoadContext {
whatever: string;
}
// TODO: remove this once we've migrated to `Route.LoaderArgs` instead for our loaders
interface LoaderFunctionArgs {
context: AppLoadContext;
}
// TODO: remove this once we've migrated to `Route.ActionArgs` instead for our actions
interface ActionFunctionArgs {
context: AppLoadContext;
}
}
export {}; // necessary for TS to treat this as a module
使用 declare module 注册类型是一种称为 模块增强 的标准 TypeScript 技术。您可以在 tsconfig.json 的 include 字段涵盖的任何 TypeScript 文件中执行此操作，但我们建议在您的应用程序目录中使用专用的 env.ts。
👉 使用新类型
采用 新的类型生成 后，您可以删除 LoaderFunctionArgs/ActionFunctionArgs 增强并使用来自 Route.LoaderArgs 和 Route.ActionArgs 的 context 参数。
declare module "react-router" {
// Your AppLoadContext used in v2
interface AppLoadContext {
whatever: string;
}
}
export {}; // necessary for TS to treat this as a module
import type { Route } from "./+types/my-route";
export function loader({ context }: Route.LoaderArgs) {}
// { whatever: string } ^^^^^^^
export function action({ context }: Route.ActionArgs) {}
// { whatever: string } ^^^^^^^
恭喜！您现在已使用 React Router v7。继续运行您的应用程序以确保一切正常。