headers

头部允许你在给定路径的传入请求响应上设置自定义 HTTP 头部。

要设置自定义 HTTP 头部，你可以在 next.config.js 中使用 headers 键：

next.config.js
module.exports = {
  async headers() {
    return [
      {
        source: '/about',
        headers: [
          {
            key: 'x-custom-header',
            value: 'my custom header value',
          },
          {
            key: 'x-another-custom-header',
            value: 'my other custom header value',
          },
        ],
      },
    ]
  },
}

headers 是一个异步函数，期望返回一个包含具有 source 和 headers 属性的对象的数组：

source 是传入请求路径模式。
headers 是响应头部对象的数组，具有 key 和 value 属性。
basePath：false 或 undefined - 如果为 false，匹配时不会包含 basePath，仅可用于外部重写。
locale：false 或 undefined - 匹配时是否不应包含区域设置。
has 是具有 type、key 和 value 属性的 has 对象数组。
missing 是具有 type、key 和 value 属性的 missing 对象数组。

头部在文件系统（包括页面和 /public 文件）之前进行检查。

头部覆盖行为

如果两个头部匹配相同路径并设置相同的头部键，最后一个头部键将覆盖第一个。使用下面的头部，路径 /hello 将导致头部 x-hello 为 world，因为最后设置的头部值为 world。

next.config.js
module.exports = {
  async headers() {
    return [
      {
        source: '/:path*',
        headers: [
          {
            key: 'x-hello',
            value: 'there',
          },
        ],
      },
      {
        source: '/hello',
        headers: [
          {
            key: 'x-hello',
            value: 'world',
          },
        ],
      },
    ]
  },
}

路径匹配

允许路径匹配，例如 /blog/:slug 将匹配 /blog/hello-world（无嵌套路径）：

next.config.js
module.exports = {
  async headers() {
    return [
      {
        source: '/blog/:slug',
        headers: [
          {
            key: 'x-slug',
            value: ':slug', // 匹配的参数可以在值中使用
          },
          {
            key: 'x-slug-:slug', // 匹配的参数可以在键中使用
            value: 'my other custom header value',
          },
        ],
      },
    ]
  },
}

通配符路径匹配

要匹配通配符路径，你可以在参数后使用 *，例如 /blog/:slug* 将匹配 /blog/a/b/c/d/hello-world：

next.config.js
module.exports = {
  async headers() {
    return [
      {
        source: '/blog/:slug*',
        headers: [
          {
            key: 'x-slug',
            value: ':slug*', // 匹配的参数可以在值中使用
          },
          {
            key: 'x-slug-:slug*', // 匹配的参数可以在键中使用
            value: 'my other custom header value',
          },
        ],
      },
    ]
  },
}

正则表达式路径匹配

要匹配正则表达式路径，你可以在参数后的括号中包装正则表达式，例如 /blog/:slug(\\d{1,}) 将匹配 /blog/123 但不匹配 /blog/abc：

next.config.js
module.exports = {
  async headers() {
    return [
      {
        source: '/blog/:post(\\d{1,})',
        headers: [
          {
            key: 'x-post',
            value: ':post',
          },
        ],
      },
    ]
  },
}

以下字符 (、)、{、}、:、*、+、? 用于正则表达式路径匹配，因此当在 source 中作为非特殊值使用时，必须通过在它们前面添加 \\ 来转义：

next.config.js
module.exports = {
  async headers() {
    return [
      {
        // 这将匹配请求 `/english(default)/something`
        source: '/english\\(default\\)/:slug',
        headers: [
          {
            key: 'x-header',
            value: 'value',
          },
        ],
      },
    ]
  },
}

头部、Cookie 和查询匹配

要仅在头部、cookie 或查询值也匹配 has 字段或不匹配 missing 字段时应用头部，可以使用这些字段。头部要应用，source 和所有 has 项必须匹配，所有 missing 项必须不匹配。

has 和 missing 项可以具有以下字段：

type：String - 必须是 header、cookie、host 或 query 之一。
key：String - 要匹配的选定类型的键。
value：String 或 undefined - 要检查的值，如果未定义，任何值都将匹配。可以使用类似正则表达式的字符串来捕获值的特定部分，例如，如果值 first-(?<paramName>.*) 用于 first-second，则 second 可以在目标中使用 :paramName。

next.config.js
module.exports = {
  async headers() {
    return [
      // 如果头部 `x-add-header` 存在，
      // 将应用 `x-another-header` 头部
      {
        source: '/:path*',
        has: [
          {
            type: 'header',
            key: 'x-add-header',
          },
        ],
        headers: [
          {
            key: 'x-another-header',
            value: 'hello',
          },
        ],
      },
      // 如果头部 `x-no-header` 不存在，
      // 将应用 `x-another-header` 头部
      {
        source: '/:path*',
        missing: [
          {
            type: 'header',
            key: 'x-no-header',
          },
        ],
        headers: [
          {
            key: 'x-another-header',
            value: 'hello',
          },
        ],
      },
      // 如果源、查询和 cookie 都匹配，
      // 将应用 `x-authorized` 头部
      {
        source: '/specific/:path*',
        has: [
          {
            type: 'query',
            key: 'page',
            // 页面值在头部键/值中不可用，因为提供了值
            // 并且不使用命名捕获组，例如 (?<page>home)
            value: 'home',
          },
          {
            type: 'cookie',
            key: 'authorized',
            value: 'true',
          },
        ],
        headers: [
          {
            key: 'x-authorized',
            value: ':authorized',
          },
        ],
      },
      // 如果头部 `x-authorized` 存在且
      // 包含匹配值，将应用 `x-another-header`
      {
        source: '/:path*',
        has: [
          {
            type: 'header',
            key: 'x-authorized',
            value: '(?<authorized>yes|true)',
          },
        ],
        headers: [
          {
            key: 'x-another-header',
            value: ':authorized',
          },
        ],
      },
      // 如果主机是 `example.com`，
      // 将应用此头部
      {
        source: '/:path*',
        has: [
          {
            type: 'host',
            value: 'example.com',
          },
        ],
        headers: [
          {
            key: 'x-another-header',
            value: ':authorized',
          },
        ],
      },
    ]
  },
}

支持 basePath 的头部

当在头部中利用 basePath 支持时，每个 source 都会自动添加 basePath 前缀，除非你在头部中添加 basePath: false：

next.config.js
module.exports = {
  basePath: '/docs',

  async headers() {
    return [
      {
        source: '/with-basePath', // 变为 /docs/with-basePath
        headers: [
          {
            key: 'x-hello',
            value: 'world',
          },
        ],
      },
      {
        source: '/without-basePath', // 由于设置了 basePath: false，不会被修改
        headers: [
          {
            key: 'x-hello',
            value: 'world',
          },
        ],
        basePath: false,
      },
    ]
  },
}

支持 i18n 的头部

当在头部中利用 i18n 支持时，每个 source 都会自动添加前缀以处理配置的 locales，除非你在头部中添加 locale: false。如果使用 locale: false，你必须在 source 前添加区域设置前缀才能正确匹配。

next.config.js
module.exports = {
  i18n: {
    locales: ['en', 'fr', 'de'],
    defaultLocale: 'en',
  },

  async headers() {
    return [
      {
        source: '/with-locale', // 自动处理所有区域设置
        headers: [
          {
            key: 'x-hello',
            value: 'world',
          },
        ],
      },
      {
        // 由于设置了 locale: false，不会自动处理区域设置
        source: '/nl/with-locale-manual',
        locale: false,
        headers: [
          {
            key: 'x-hello',
            value: 'world',
          },
        ],
      },
      {
        // 这匹配 '/'，因为 `en` 是 defaultLocale
        source: '/en',
        locale: false,
        headers: [
          {
            key: 'x-hello',
            value: 'world',
          },
        ],
      },
      {
        // 这被转换为 /(en|fr|de)/(.*)，所以不会匹配顶级
        // `/` 或 `/fr` 路由，就像 /:path* 那样
        source: '/(.*)',
        headers: [
          {
            key: 'x-hello',
            value: 'world',
          },
        ],
      },
    ]
  },
}

缓存控制

Next.js 为真正不可变的资源设置 Cache-Control 头部为 public, max-age=31536000, immutable。这无法被覆盖。这些不可变文件在文件名中包含 SHA 哈希，因此可以安全地无限期缓存。例如，静态图像导入。你无法在 next.config.js 中为这些资源设置 Cache-Control 头部。

但是，你可以为其他响应或数据设置 Cache-Control 头部。

了解有关 App 路由的缓存的更多信息。

如果你需要重新验证已静态生成的页面的缓存，可以通过在页面的 getStaticProps 函数中设置 revalidate 属性来实现。

要缓存 API 路由的响应，你可以使用 res.setHeader：

TypeScript
JavaScript

pages/api/hello.ts
import type { NextApiRequest, NextApiResponse } from 'next'

type ResponseData = {
  message: string
}

export default function handler(
  req: NextApiRequest,
  res: NextApiResponse<ResponseData>
) {
  res.setHeader('Cache-Control', 's-maxage=86400')
  res.status(200).json({ message: 'Hello from Next.js!' })
}

pages/api/hello.js
export default function handler(req, res) {
  res.setHeader('Cache-Control', 's-maxage=86400')
  res.status(200).json({ message: 'Hello from Next.js!' })
}

你也可以在 getServerSideProps 中使用缓存头部（Cache-Control）来缓存动态响应。例如，使用 stale-while-revalidate。

TypeScript
JavaScript

pages/index.tsx
import { GetStaticProps, GetStaticPaths, GetServerSideProps } from 'next'

// 此值在十秒内被认为是新鲜的 (s-maxage=10)。
// 如果在接下来的 10 秒内重复请求，之前
// 缓存的值仍然新鲜。如果在 59 秒前重复请求，
// 缓存的值将过期但仍会渲染 (stale-while-revalidate=59)。
//
// 在后台，将发出重新验证请求以用新鲜值填充缓存。
// 如果你刷新页面，你将看到新值。
export const getServerSideProps = (async (context) => {
  context.res.setHeader(
    'Cache-Control',
    'public, s-maxage=10, stale-while-revalidate=59'
  )

  return {
    props: {},
  }
}) satisfies GetServerSideProps

pages/index.js
// 此值在十秒内被认为是新鲜的 (s-maxage=10)。
// 如果在接下来的 10 秒内重复请求，之前
// 缓存的值仍然新鲜。如果在 59 秒前重复请求，
// 缓存的值将过期但仍会渲染 (stale-while-revalidate=59)。
//
// 在后台，将发出重新验证请求以用新鲜值填充缓存。
// 如果你刷新页面，你将看到新值。
export async function getServerSideProps({ req, res }) {
  res.setHeader(
    'Cache-Control',
    'public, s-maxage=10, stale-while-revalidate=59'
  )

  return {
    props: {},
  }
}

选项

CORS

跨源资源共享 (CORS) 是一项安全功能，允许你控制哪些站点可以访问你的资源。你可以设置 Access-Control-Allow-Origin 头部以允许特定源访问你的 API 端点路由处理器。

async headers() {
    return [
      {
        source: "/api/:path*",
        headers: [
          {
            key: "Access-Control-Allow-Origin",
            value: "*", // 设置你的源
          },
          {
            key: "Access-Control-Allow-Methods",
            value: "GET, POST, PUT, DELETE, OPTIONS",
          },
          {
            key: "Access-Control-Allow-Headers",
            value: "Content-Type, Authorization",
          },
        ],
      },
    ];
  },

X-DNS-Prefetch-Control

此头部控制 DNS 预取，允许浏览器主动对外部链接、图像、CSS、JavaScript 等执行域名解析。此预取在后台执行，因此当需要引用的项目时，DNS 更有可能已被解析。这减少了用户点击链接时的延迟。

{
  key: 'X-DNS-Prefetch-Control',
  value: 'on'
}

Strict-Transport-Security

此头部通知浏览器应该只使用 HTTPS 访问，而不是使用 HTTP。使用下面的配置，所有当前和未来的子域将使用 HTTPS，max-age 为 2 年。这会阻止访问只能通过 HTTP 提供的页面或子域。

{
  key: 'Strict-Transport-Security',
  value: 'max-age=63072000; includeSubDomains; preload'
}

X-Frame-Options

此头部指示是否应该允许站点在 iframe 中显示。这可以防止点击劫持攻击。

此头部已被 CSP 的 frame-ancestors 选项取代，在现代浏览器中有更好的支持（有关配置详细信息，请参阅内容安全策略）。

{
  key: 'X-Frame-Options',
  value: 'SAMEORIGIN'
}

Permissions-Policy

此头部允许你控制浏览器中可以使用哪些功能和 API。它之前名为 Feature-Policy。

{
  key: 'Permissions-Policy',
  value: 'camera=(), microphone=(), geolocation=(), browsing-topics=()'
}

X-Content-Type-Options

此头部防止浏览器在未明确设置 Content-Type 头部时尝试猜测内容类型。这可以防止允许用户上传和共享文件的网站的 XSS 攻击。

例如，用户尝试下载图像，但将其视为不同的 Content-Type，如可执行文件，这可能是恶意的。此头部也适用于下载浏览器扩展。此头部的唯一有效值是 nosniff。

{
  key: 'X-Content-Type-Options',
  value: 'nosniff'
}

Referrer-Policy

此头部控制浏览器从当前网站（源）导航到另一个网站时包含多少信息。

{
  key: 'Referrer-Policy',
  value: 'origin-when-cross-origin'
}

Content-Security-Policy

了解有关为你的应用程序添加内容安全策略的更多信息。

版本历史

版本	更改
`v13.3.0`	添加 `missing`。
`v10.2.0`	添加 `has`。
`v9.5.0`	添加头部。

头部覆盖行为​

路径匹配​

通配符路径匹配​

正则表达式路径匹配​

头部、Cookie 和查询匹配​

支持 basePath 的头部​

支持 i18n 的头部​

缓存控制​

选项​

CORS​

X-DNS-Prefetch-Control​

Strict-Transport-Security​

X-Frame-Options​

Permissions-Policy​

X-Content-Type-Options​

Referrer-Policy​

Content-Security-Policy​

版本历史​