ルートセグメント設定

知っておくと良いこと:

• このページで概説されているオプションは、cacheComponentsフラグがオンの場合、無効になり、将来的に廃止される予定です。
• ルートセグメントオプションは、サーバーコンポーネントのページ、レイアウト、またはルートハンドラーでのみ有効です。
• generateStaticParamsは'use client'ファイル内では使用できません。

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

オプション

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'に設定すること。

• '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 (デフォルト): cacheオプションを'force-cache'に設定したすべてのfetchリクエスト、または動的APIが使用される前に検出されたfetchリクエストをキャッシュするデフォルトのヒューリスティック。revalidate: Infinity、つまりリソースは無期限にキャッシュされるべきであることを意味します。個々のfetchリクエストでcache: 'no-store'またはrevalidate: 0を使用してキャッシュを回避し、ルートを動的にレンダリングすることは依然として可能です。または、revalidateをルートのデフォルトよりも小さい正の数に設定して、ルートの再検証頻度を増やすこともできます。
• 0: 動的APIまたはキャッシュされていないデータフェッチが検出されない場合でも、レイアウトまたはページが常に動的にレンダリングされることを保証します。このオプションは、cacheオプションが設定されていないfetchリクエストのデフォルトを'no-store'に変更しますが、'force-cache'をオプトインするか正のrevalidateを使用するfetchリクエストはそのままにします。
• number: (秒単位) レイアウトまたはページのデフォルトの再検証頻度をn秒に設定します。

知っておくと良いこと:

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

Revalidation Frequency

• 単一ルートの各レイアウトとページ全体での最も低いrevalidate値が、*ルート全体*の再検証頻度を決定します。これにより、子ページが親レイアウトと同じ頻度で再検証されることが保証されます。
• 個々のfetchリクエストは、ルートのデフォルトrevalidateよりも低い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

知っておくと良いこと:

• Server Actionsを使用している場合は、ページレベルでmaxDurationを設定して、ページで使用されるすべてのServer Actionsのデフォルトタイムアウトを変更します。

generateStaticParams

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

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

バージョン履歴