headers

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

app/page.tsx

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，表示具有给定名称的 Headers 对象中标头的所有值的序列。
Headers.has()：返回一个布尔值，指示 Headers 对象是否包含某个标头。
Headers.keys(): 返回一个迭代器，允许你遍历此对象中包含的所有键值对的键。
Headers.values(): 返回一个迭代器，允许你遍历此对象中包含的所有键值对的值。

值得注意的是

headers 是一个异步函数，它返回一个 Promise。你必须使用 async/await 或 React 的 use 函数。
- 在 14 版本及更早版本中，headers 是一个同步函数。为了帮助向后兼容，你仍然可以在 Next.js 15 中同步访问它，但这种行为将在未来弃用。
由于 headers 是只读的，因此你无法设置或删除传出的请求头。
headers 是一个动态 API，其返回值无法提前知道。在其中使用它将使路由进入动态渲染。

示例

使用授权头

app/page.js

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

版本历史

版本	更改
`v15.0.0-RC`	`headers` 现在是一个异步函数。一个代码修改可用。
`v13.0.0`	引入 `headers`。