ルートセグメント設定

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

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

オプション

experimental_ppr

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

export const experimental_ppr = true
// true | false

dynamic

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

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,

• 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

• false (デフォルト): 'force-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'

runtime

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

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

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

preferredRegion

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

知っておくと良いこと:

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

generateStaticParams

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

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

バージョン履歴