数据加载
此页面

数据加载

数据通过 `loader` 和 `clientLoader` 提供给路由组件。

加载器数据会自动从加载器中序列化并在组件中反序列化。除了字符串和数字等基本值之外,加载器还可以返回 Promise、Map、Set、Date 等。

客户端数据加载

`clientLoader` 用于在客户端获取数据。这对于您希望仅从浏览器获取数据的页面或完整项目非常有用。

// route("products/:pid", "./product.tsx");
import type { Route } from "./+types/product";

export async function clientLoader({
  params,
}: Route.ClientLoaderArgs) {
  const res = await fetch(`/api/products/${params.pid}`);
  const product = await res.json();
  return product;
}

export default function Product({
  loaderData,
}: Route.ComponentProps) {
  const { name, description } = loaderData;
  return (
    <div>
      <h1>{name}</h1>
      <p>{description}</p>
    </div>
  );
}

服务器数据加载

在服务器渲染时,`loader` 用于初始页面加载和客户端导航。客户端导航通过 React Router 从浏览器到服务器的自动 `fetch` 调用加载器。

// route("products/:pid", "./product.tsx");
import type { Route } from "./+types/product";
import { fakeDb } from "../db";

export async function loader({ params }: Route.LoaderArgs) {
  const product = await fakeDb.getProduct(params.pid);
  return product;
}

export default function Product({
  loaderData,
}: Route.ComponentProps) {
  const { name, description } = loaderData;
  return (
    <div>
      <h1>{name}</h1>
      <p>{description}</p>
    </div>
  );
}

请注意,`loader` 函数已从客户端 bundle 中移除,因此您可以使用仅服务器端 API,而无需担心它们会被包含在浏览器中。

静态数据加载

在预渲染时,加载器用于在生产构建期间获取数据。

// route("products/:pid", "./product.tsx");
import type { Route } from "./+types/product";

export async function loader({ params }: Route.LoaderArgs) {
  let product = await getProductFromCSVFile(params.pid);
  return product;
}

export default function Product({
  loaderData,
}: Route.ComponentProps) {
  const { name, description } = loaderData;
  return (
    <div>
      <h1>{name}</h1>
      <p>{description}</p>
    </div>
  );
}

预渲染的 URL 在 react-router.config.ts 中指定。

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

export default {
  async prerender() {
    let products = await readProductsFromCSVFile();
    return products.map(
      (product) => `/products/${product.id}`
    );
  },
} satisfies Config;

请注意,在服务器渲染时,任何未预渲染的 URL 将照常进行服务器渲染,允许您在单个路由处预渲染一些数据,同时仍然对其余部分进行服务器渲染。

同时使用加载器

`loader` 和 `clientLoader` 可以一起使用。`loader` 将在服务器上用于初始 SSR(或预渲染),而 `clientLoader` 将在随后的客户端导航中使用。

// route("products/:pid", "./product.tsx");
import type { Route } from "./+types/product";
import { fakeDb } from "../db";

export async function loader({ params }: Route.LoaderArgs) {
  return fakeDb.getProduct(params.pid);
}

export async function clientLoader({
  params,
}: Route.ClientLoader) {
  const res = await fetch(`/api/products/${params.pid}`);
  return res.json();
}

export default function Product({
  loaderData,
}: Route.ComponentProps) {
  const { name, description } = loaderData;

  return (
    <div>
      <h1>{name}</h1>
      <p>{description}</p>
    </div>
  );
}

下一步:操作

另请参阅

文档和示例 CC 4.0