headers

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

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

Reference

Parameters

headers 不接受任何参数。

Returns

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

• Headers.entries()：返回一个 iterator，允许遍历该对象中包含的所有键/值对。
• Headers.forEach()：为此 Headers 对象中的每个键/值对执行一次提供的函数。
• Headers.get()：返回一个 String 序列，包含 Headers 对象中具有给定名称的 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 是一个 Dynamic API，其返回值无法提前知道。在路由中使用它将使该路由选择**动态渲染**。

Examples

使用 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>
}

Version History