headers

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

TypeScript

app/page.tsx

import { headers } from 'next/headers'

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

JavaScript

app/page.js

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()：返回具有给定名称的 Headers 对象中头部的所有值的 String 序列。
• Headers.has()：返回一个布尔值，说明 Headers 对象是否包含某个头部。
• Headers.keys()：返回一个 iterator，允许你遍历此对象中包含的键/值对的所有键。
• Headers.values()：返回一个 iterator，允许你遍历此对象中包含的键/值对的所有值。

提示

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

示例

使用 Authorization 头

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 }, // 转发 authorization 头
  })
  const user = await res.json()

  return <h1>{user.name}</h1>
}

版本历史

版本	更改
v15.0.0-RC	headers 现在是一个异步函数。提供了 codemod。
v13.0.0	引入了 headers。