自定义框架

除了使用 @react-router/dev，你可以将 React Router 的框架特性（如 loaders, actions, fetchers 等）集成到你自己的打包器和服务器抽象中。

客户端渲染

1. 创建 Router

浏览器运行时 API，它启用路由模块 API（loaders, actions 等）是 createBrowserRouter。

它接受一个路由对象数组，这些对象支持 loaders、actions、错误边界等等。React Router Vite 插件从 routes.ts 创建其中一个，但你可以手动创建一个（或使用抽象）并使用你自己的打包器。

import { createBrowserRouter } from "react-router";

let router = createBrowserRouter([
  {
    path: "/",
    Component: Root,
    children: [
      {
        path: "shows/:showId",
        Component: Show,
        loader: ({ request, params }) =>
          fetch(`/api/show/${params.id}.json`, {
            signal: request.signal,
          }),
      },
    ],
  },
]);

2. 渲染 Router

要在浏览器中渲染 router，请使用 <RouterProvider>。

import {
  createBrowserRouter,
  RouterProvider,
} from "react-router";
import { createRoot } from "react-dom/client";

createRoot(document.getElementById("root")).render(
  <RouterProvider router={router} />
);

3. 懒加载

路由可以使用 lazy 属性延迟加载它们的大部分定义。

createBrowserRouter([
  {
    path: "/show/:showId",
    lazy: () => {
      let [loader, action, Component] = await Promise.all([
        import("./show.action.js"),
        import("./show.loader.js"),
        import("./show.component.js"),
      ]);
      return { loader, action, Component };
    },
  },
]);

服务端渲染

要服务端渲染自定义设置，有一些服务器 API 可用于渲染和数据加载。

本指南仅为您提供一些关于其工作原理的想法。为了更深入的理解，请查看 Custom Framework Example Repo

1. 定义你的路由

路由在服务器端和客户端是相同类型的对象。

export default [
  {
    path: "/",
    Component: Root,
    children: [
      {
        path: "shows/:showId",
        Component: Show,
        loader: ({ params }) => {
          return db.loadShow(params.id);
        },
      },
    ],
  },
];

2. 创建静态处理器

使用 createStaticHandler 将你的路由转换为请求处理器

import { createStaticHandler } from "react-router";
import routes from "./some-routes";

let { query, dataRoutes } = createStaticHandler(routes);

3. 获取路由上下文并渲染

React Router 与 web fetch Requests 一起工作，因此如果你的服务器不使用 web fetch，你需要将它使用的任何对象适配成 web fetch Request 对象。

此步骤假设你的服务器接收 Request 对象。

import { renderToString } from "react-dom/server";
import {
  createStaticHandler,
  createStaticRouter,
  StaticRouterProvider,
} from "react-router";

import routes from "./some-routes.js";

let { query, dataRoutes } = createStaticHandler(routes);

export async function handler(request: Request) {
  // 1. run actions/loaders to get the routing context with `query`
  let context = await query(request);

  // If `query` returns a Response, send it raw (a route probably a redirected)
  if (context instanceof Response) {
    return context;
  }

  // 2. Create a static router for SSR
  let router = createStaticRouter(dataRoutes, context);

  // 3. Render everything with StaticRouterProvider
  let html = renderToString(
    <StaticRouterProvider
      router={router}
      context={context}
    />
  );

  // Setup headers from action and loaders from deepest match
  let leaf = context.matches[context.matches.length - 1];
  let actionHeaders = context.actionHeaders[leaf.route.id];
  let loaderHeaders = context.loaderHeaders[leaf.route.id];
  let headers = new Headers(actionHeaders);
  if (loaderHeaders) {
    for (let [key, value] of loaderHeaders.entries()) {
      headers.append(key, value);
    }
  }

  headers.set("Content-Type", "text/html; charset=utf-8");

  // 4. send a response
  return new Response(`<!DOCTYPE html>${html}`, {
    status: context.statusCode,
    headers,
  });
}

4. 在浏览器中水合

水合数据嵌入到 window.__staticRouterHydrationData 中，使用它来初始化你的客户端 router 并渲染 <RouterProvider>。

import { StrictMode } from "react";
import { hydrateRoot } from "react-dom/client";
import { RouterProvider } from "react-router/dom";
import routes from "./app/routes.js";
import { createBrowserRouter } from "react-router";

let router = createBrowserRouter(routes, {
  hydrationData: window.__staticRouterHydrationData,
});

hydrateRoot(
  document,
  <StrictMode>
    <RouterProvider router={router} />
  </StrictMode>
);