headers

headers 是一个异步函数，它允许你从 服务器组件中读取 HTTP 请求的 headers。

import { headers } from 'next/headers'
 
export default async function Page() {
  const headersList = await headers()
  const userAgent = headersList.get('user-agent')
}

参考

参数

headers 不接受任何参数。

返回值

headers 返回一个只读的 Web Headers 对象。

• Headers.entries()：返回一个 iterator，允许遍历对象中包含的所有键值对。
• Headers.forEach()：对此 Headers 对象中的每个键值对执行一次提供的函数。
• Headers.get()：返回一个 String，包含具有给定名称的 header 的所有值。
• Headers.has()：返回一个布尔值，表明 Headers 对象是否包含某个 header。
• Headers.keys()：返回一个 iterator，允许你遍历对象中包含的所有键值对的键。
• Headers.values()：返回一个 iterator，允许你遍历对象中包含的所有键值对的值。

值得注意的是

• headers 是一个返回 promise 的异步函数。你必须使用 async/await 或 React 的 use 函数。
  • 在第 14 版及更早版本中，headers 是一个同步函数。为了向后兼容，你在 Next.js 15 中仍然可以同步访问它，但这个行为将在未来被废弃。
• 由于 headers 是只读的，你不能 set 或 delete 输出请求的 headers。
• headers 是一个 动态 API，其返回值无法提前知道。使用它将使路由采用**动态渲染**。

示例

使用 Authorization header

import { headers } from 'next/headers'
 
export default async function Page() {
  const authorization = (await headers()).get('authorization')
  const res = await fetch('...', {
    headers: { authorization }, // 转发 authorization header
  })
  const user = await res.json()
 
  return <h1>{user.name}</h1>
}

版本历史