NNext.js 中文网 GitHub

headers

headers 函数的 API 参考。

headers 是一个异步函数,允许你从 Server Component 读取传入的 HTTP 请求头。

app/page.tsx
import { headers } from 'next/headers'

export default async function Page() {
  const headersList = await headers()
  const userAgent = headersList.get('user-agent')
}
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 是一个异步函数,返回 promise。你必须使用 async/await 或 React 的 use 函数。
    • 在 14 及更早版本中,headers 是同步函数。为了帮助向后兼容,在 Next.js 15 中你仍可以同步访问它,但此行为将来会被弃用。
  • 由于 headers 是只读的,你无法 set 或 delete 传出的请求头。
  • headers 是一个请求时 API,其返回值无法提前得知。在路由中使用它会使该路由选择动态渲染。
  • 使用 Cache Components 时,在 <Suspense> 边界之外调用 headers() 会阻止该路由被预渲染。请参阅 Next.js 在预渲染期间遇到运行时数据了解修复选项。

示例#

使用 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-RCheaders 现在是异步函数。可使用 codemod。
v13.0.0引入 headers。
Next.js 中文网