HTTP 标头

标头主要通过路由模块的 headers 导出定义。您也可以在 entry.server.tsx 中设置标头。

来自路由模块

import { Route } from "./+types/some-route";

export function headers(_: Route.HeadersArgs) {
  return {
    "Content-Security-Policy": "default-src 'self'",
    "X-Frame-Options": "DENY",
    "X-Content-Type-Options": "nosniff",
    "Cache-Control": "max-age=3600, s-maxage=86400",
  };
}

您可以返回 Headers 实例或 HeadersInit。

来自 loader 和 action

当标头依赖于 loader 数据时，loader 和 action 也可以设置标头。

1. 将返回值包装在 `data` 中

import { data } from "react-router";

export async function loader({ params }: LoaderArgs) {
  let [page, ms] = await fakeTimeCall(
    await getPage(params.id)
  );

  return data(page, {
    headers: {
      "Server-Timing": `page;dur=${ms};desc="Page query"`,
    },
  });
}

2. 从 `headers` 导出返回

来自 loader 和 action 的标头不会自动发送。您必须从 headers 导出中显式返回它们。

export function headers({
  actionHeaders,
  loaderHeaders,
}: HeadersArgs) {
  return actionHeaders ? actionHeaders : loaderHeaders;
}

一个值得注意的例外是 Set-Cookie 标头，即使不从子路由导出 headers，也会自动从父路由中的 headers、loader 和 action 中保留。

与父级标头合并

考虑这些嵌套路由

route("pages", "pages-layout-with-nav.tsx", [
  route(":slug", "page.tsx"),
]);

如果两个路由模块都想设置标头，则将发送最深层匹配路由的标头。

当您需要同时保留父级和子级标头时，需要在子路由中合并它们。

追加

最简单的方法是直接追加到父级标头。这避免了覆盖父级可能已设置的标头，并且两者都很重要。

export function headers({ parentHeaders }: HeadersArgs) {
  parentHeaders.append(
    "Permissions-Policy: geolocation=()"
  );
  return parentHeaders;
}

设置

有时覆盖父级标头很重要。使用 set 而不是 append 来执行此操作

export function headers({ parentHeaders }: HeadersArgs) {
  parentHeaders.set(
    "Cache-Control",
    "max-age=3600, s-maxage=86400"
  );
  return parentHeaders;
}

您可以仅在“叶子路由”（索引路由和没有子路由的子路由）中定义标头，而不在父路由中定义标头，从而避免合并标头的需要。

来自 `entry.server.tsx`

handleRequest 导出接收来自路由模块的标头作为参数。您可以在此处追加全局标头。

export default function handleRequest(
  request,
  responseStatusCode,
  responseHeaders,
  routerContext,
  loadContext
) {
  // set, append global headers
  responseHeaders.set(
    "X-App-Version",
    routerContext.manifest.version
  );

  return new Response(await getStream(), {
    headers: responseHeaders,
    status: responseStatusCode,
  });
}

如果您没有 entry.server.tsx，请运行 reveal 命令

react-router reveal