头部主要通过路由模块的 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 数据时,loader 和 action 也可以设置头部。
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"`,
},
});
}
headers
导出返回来自 loader 和 action 的头部不会自动发送。你必须从 headers
导出中显式返回它们。
export function headers({
actionHeaders,
loaderHeaders,
}: HeadersArgs) {
return actionHeaders ? actionHeaders : loaderHeaders;
}
一个值得注意的例外是 Set-Cookie
头部,它们会自动保留父级路由中 headers
、loader
和 action
返回的该头部,即使子路由没有导出 headers
。
考虑这些嵌套路由
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