自定义框架

您可以将 React Router 的框架功能（如加载器、操作、fetchers 等）集成到您自己的打包器和服务器抽象中，而不是使用 @react-router/dev。

客户端渲染

1. 创建路由器

启用路由模块 API（加载器、操作等）的浏览器运行时 API 是createBrowserRouter。

它接受一个支持加载器、操作、错误边界等路由对象的数组。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. 渲染路由器

要在浏览器中渲染路由器，请使用<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。

本指南仅提供一些关于其工作原理的想法。要深入了解，请参阅自定义框架示例仓库

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 请求，因此，如果您的服务器没有使用，则需要将它使用的任何对象适配为 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中，使用它初始化您的客户端路由器并渲染<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>
);