ルートセグメント設定

このページで説明するオプションは、dynamicIO フラグが有効な場合には無効化され、将来的に廃止される予定です。

ルートセグメントオプションを使用すると、以下の変数を直接エクスポートすることで、ページ、レイアウト、またはルートハンドラーの動作を設定できます:

オプション

experimental_ppr

レイアウトまたはページに対して部分的な事前レンダリング (PPR) を有効にします。

export const experimental_ppr = true
// true | false

export const experimental_ppr = true
// true | false

dynamic

レイアウトまたはページの動的動作を完全に静的または完全に動的に変更します。

export const dynamic = 'auto'
// 'auto' | 'force-dynamic' | 'error' | 'force-static'

export const dynamic = 'auto'
// 'auto' | 'force-dynamic' | 'error' | 'force-static'

豆知識: app ディレクトリの新しいモデルでは、pages ディレクトリでのページレベルの getServerSideProps や getStaticProps の全か無かのバイナリモデルよりも、fetch リクエストレベルでの細かいキャッシュ制御が優先されます。dynamic オプションは、利便性のために以前のモデルに戻る方法を提供し、より簡単な移行パスを提供します。

• 'auto' (デフォルト): コンポーネントが動的動作を選択するのを妨げずに、可能な限りキャッシュするデフォルトオプション。
• 'force-dynamic': 動的レンダリングを強制し、リクエスト時に各ユーザーに対してルートがレンダリングされます。このオプションは以下と同等です:
  • レイアウトまたはページ内のすべての fetch() リクエストのオプションを { cache: 'no-store', next: { revalidate: 0 } } に設定。
  • セグメント設定を export const fetchCache = 'force-no-store' に設定。
• 'error': 静的レンダリングを強制し、動的API またはキャッシュされていないデータを使用するコンポーネントがある場合にエラーを発生させることで、レイアウトまたはページのデータをキャッシュします。このオプションは以下と同等です:
  • pages ディレクトリの getStaticProps()。
  • レイアウトまたはページ内のすべての fetch() リクエストのオプションを { cache: 'force-cache' } に設定。
  • セグメント設定を fetchCache = 'only-cache', dynamicParams = false に設定。
  • dynamic = 'error' は dynamicParams のデフォルトを true から false に変更します。generateStaticParams で生成されていない動的パラメータに対して動的にページをレンダリングするには、手動で dynamicParams = true を設定できます。
• 'force-static': 静的レンダリングを強制し、cookies、headers()、useSearchParams() が空の値を返すようにすることで、レイアウトまたはページのデータをキャッシュします。force-static でレンダリングされたページまたはレイアウトで revalidate、revalidatePath、revalidateTag を使用することが可能です。

豆知識:

• getServerSideProps と getStaticProps から dynamic: 'force-dynamic' および dynamic: 'error' への移行方法については、アップグレードガイドを参照してください。

dynamicParams

generateStaticParams で生成されていない動的セグメントにアクセスしたときの動作を制御します。

export const dynamicParams = true // true | false,

export const dynamicParams = true // true | false,

• true (デフォルト): generateStaticParams に含まれていない動的セグメントはオンデマンドで生成されます。
• false: generateStaticParams に含まれていない動的セグメントは404を返します。

豆知識:

• このオプションは pages ディレクトリの getStaticPaths の fallback: true | false | blocking オプションを置き換えます。
• 初回アクセス時にすべてのパスを静的にレンダリングするには、generateStaticParams で空の配列を返すか、export const dynamic = 'force-static' を使用する必要があります。
• dynamicParams = true の場合、セグメントはストリーミングサーバーレンダリングを使用します。

revalidate

レイアウトまたはページのデフォルトの再検証時間を設定します。このオプションは個々の fetch リクエストで設定された revalidate 値を上書きしません。

export const revalidate = false
// false | 0 | number

export const revalidate = false
// false | 0 | number

• false (デフォルト): 'force-cache' に cache オプションを設定した fetch リクエスト、または動的API が使用される前に発見されたリクエストをキャッシュするデフォルトのヒューリスティック。意味的には revalidate: Infinity と同等で、リソースは実質的に無期限にキャッシュされます。個々の fetch リクエストで cache: 'no-store' または revalidate: 0 を使用してキャッシュを回避し、ルートを動的にレンダリングすることも可能です。または、ルートのデフォルトよりも小さい正の数値を revalidate に設定して、ルートの再検証頻度を上げることができます。
• 0: 動的レンダリングを強制し、動的APIやキャッシュされていないデータフェッチが発見されない場合でも、レイアウトまたはページが常に動的にレンダリングされるようにします。このオプションは、cache オプションを設定していない fetch リクエストのデフォルトを 'no-store' に変更しますが、'force-cache' を選択した fetch リクエストや正の revalidate を使用したリクエストはそのままにします。
• number: (秒単位) レイアウトまたはページのデフォルトの再検証頻度を n 秒に設定します。

豆知識:

• revalidate値は静的に解析可能である必要があります。例えば revalidate = 600 は有効ですが、revalidate = 60 * 10 は無効です。
• runtime = 'edge' を使用している場合、revalidate値は利用できません。
• 開発環境では、ページは常にオンデマンドでレンダリングされ、キャッシュされません。これにより、再検証期間を待たずにすぐに変更を確認できます。

再検証頻度

• 単一ルートの各レイアウトとページ全体で最も低い revalidate 値が、ルート全体の再検証頻度を決定します。これにより、子ページが親レイアウトと同じ頻度で再検証されます。
• 個々の fetch リクエストで、ルートのデフォルトの revalidate よりも低い値を設定することで、ルート全体の再検証頻度を上げることができます。これにより、特定の条件に基づいて、特定のルートに対してより頻繁な再検証を動的に選択できます。

fetchCache

export const fetchCache = 'auto'
// 'auto' | 'default-cache' | 'only-cache'
// 'force-cache' | 'force-no-store' | 'default-no-store' | 'only-no-store'

export const fetchCache = 'auto'
// 'auto' | 'default-cache' | 'only-cache'
// 'force-cache' | 'force-no-store' | 'default-no-store' | 'only-no-store'

runtime

アプリケーションのレンダリングにはNode.jsランタイム、ミドルウェアにはEdgeランタイムを使用することを推奨します。

export const runtime = 'nodejs'
// 'nodejs' | 'edge'

export const runtime = 'nodejs'
// 'nodejs' | 'edge'

• 'nodejs' (デフォルト)
• 'edge'

preferredRegion

export const preferredRegion = 'auto'
// 'auto' | 'global' | 'home' | ['iad1', 'sfo1']

export const preferredRegion = 'auto'
// 'auto' | 'global' | 'home' | ['iad1', 'sfo1']

preferredRegionのサポートとサポートされているリージョンは、デプロイメントプラットフォームに依存します。

豆知識:

• preferredRegionが指定されていない場合、最も近い親レイアウトのオプションを継承します。
• ルートレイアウトはデフォルトでallリージョンに設定されます。

maxDuration

デフォルトでは、Next.jsはサーバーサイドロジック（ページのレンダリングやAPIの処理）の実行時間を制限しません。 デプロイメントプラットフォームは、Next.jsのビルド出力からmaxDurationを使用して特定の実行制限を追加できます。

注: この設定にはNext.js 13.4.10以降が必要です。

export const maxDuration = 5

export const maxDuration = 5

豆知識:

• サーバーアクションを使用する場合、ページレベルのmaxDurationを設定して、ページで使用されるすべてのサーバーアクションのデフォルトタイムアウトを変更できます。

generateStaticParams

generateStaticParams関数は動的ルートセグメントと組み合わせて使用でき、ビルド時に静的に生成されるルートセグメントパラメータのリストを定義します。リクエスト時にオンデマンドで生成されるのではなく、ビルド時に静的に生成されます。

詳細についてはAPIリファレンスを参照してください。

バージョン履歴