headers

headers は、サーバーコンポーネントからHTTPの受信リクエストヘッダーを読み取ることができる非同期関数です。

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オブジェクト内の各キー/値のペアに対して、指定された関数を1回実行します。
• Headers.get(): Headersオブジェクト内の特定の名前を持つヘッダーのすべての値の文字列シーケンスを返します。
• Headers.has(): Headersオブジェクトが特定のヘッダーを含むかどうかを示すブール値を返します。
• Headers.keys(): このオブジェクトに含まれるキー/値のペアのすべてのキーを走査できるiteratorを返します。
• Headers.values(): このオブジェクトに含まれるキー/値のペアのすべての値を走査できるiteratorを返します。

補足

• headers は、プロミスを返す非同期関数です。async/awaitまたはReactのuse関数を使用する必要があります。
  • バージョン14以前では、headersは同期関数でした。下位互換性のため、Next.js 15では依然として同期的にアクセスできますが、この動作は将来非推奨になります。
• headers は読み取り専用であるため、送信リクエストヘッダーをsetまたはdeleteすることはできません。
• headers は、事前に値が分からない動的APIです。これを使用すると、ルートは**動的レンダリング**になります。

例

Authorization ヘッダーの使用

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

バージョン履歴