标头主要通过路由模块的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
。
当标头依赖于加载器数据时,加载器和操作也可以设置标头。
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
导出返回来自加载器和操作的标头不会以隐藏方式发送,您必须从headers
导出中返回它们。
export function headers({
actionHeaders,
loaderHeaders,
}: HeadersArgs) {
return actionHeaders ? actionHeaders : loaderHeaders;
}
考虑这些嵌套路由
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