路由區段配置
如果啟用了
dynamicIO
標誌,本頁概述的選項將會停用,並最終在未來被棄用。
路由區段選項允許您透過直接匯出以下變數來設定頁面、版面配置或路由處理器的行為
選項 | 類型 | 預設 |
---|---|---|
experimental_ppr | boolean | |
dynamic | 'auto' | 'force-dynamic' | 'error' | 'force-static' | 'auto' |
dynamicParams | boolean | true |
revalidate | false | 0 | number | false |
fetchCache | 'auto' | 'default-cache' | 'only-cache' | 'force-cache' | 'force-no-store' | 'default-no-store' | 'only-no-store' | 'auto' |
runtime | 'nodejs' | 'edge' | 'nodejs' |
preferredRegion | 'auto' | 'global' | 'home' | string | string[] | 'auto' |
maxDuration | number | 由部署平台設定 |
選項
experimental_ppr
為版面配置或頁面啟用部分預先渲染 (PPR)。
export const experimental_ppr = true
// true | false
dynamic
將版面配置或頁面的動態行為變更為完全靜態或完全動態。
export const dynamic = 'auto'
// 'auto' | 'force-dynamic' | 'error' | 'force-static'
小提示:`app` 目錄中的新模型傾向於在
fetch
請求層級進行細緻的快取控制,而不是 `pages` 目錄中頁面層級的getServerSideProps
和getStaticProps
的二元全有或全無模型。`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
。您可以透過手動設定dynamicParams = true
,選擇重新動態渲染非由generateStaticParams
產生的動態參數頁面。
- `pages` 目錄中的
-
'force-static'
:強制靜態渲染並快取版面配置或頁面的資料,方法是強制cookies
、headers()
和useSearchParams()
傳回空值。
小提示:
- 關於如何從
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
時,區段會使用串流伺服器渲染。- 如果使用
dynamic = 'error'
和dynamic = 'force-static'
,則會將dynamicParams
的預設值變更為false
。
revalidate
設定版面配置或頁面的預設重新驗證時間。此選項不會覆寫由個別 fetch
請求設定的 revalidate
值。
export const revalidate = false
// false | 0 | number
false
(預設):預設啟發式方法,用於快取任何將其cache
選項設定為'force-cache'
或在動態 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
值不可用。- 在開發模式中,頁面始終依需求渲染,且永不快取。這可讓您立即看到變更,而無需等待重新驗證期間過去。
重新驗證頻率
- 單一路線的每個版面配置和頁面中最低的
revalidate
值將決定整個路線的重新驗證頻率。這確保子頁面與其父版面配置一樣頻繁地重新驗證。 - 個別
fetch
請求可以設定低於路由預設revalidate
的值,以增加整個路由的重新驗證頻率。這可讓您根據某些條件動態選擇加入更頻繁的特定路由重新驗證。
fetchCache
這是一個進階選項,只有在您明確需要覆寫預設行為時才應使用。
預設情況下,Next.js 將快取在任何動態 API 使用之前可到達的任何 fetch()
請求,並且不會快取在動態 API 使用之後發現的 fetch
請求。
fetchCache
允許您覆寫版面配置或頁面中所有 fetch
請求的預設 cache
選項。
export const fetchCache = 'auto'
// 'auto' | 'default-cache' | 'only-cache'
// 'force-cache' | 'force-no-store' | 'default-no-store' | 'only-no-store'
'auto'
(預設):預設選項,用於快取動態 API 之前的fetch
請求,並使用它們提供的cache
選項,而不快取動態 API 之後的fetch
請求。'default-cache'
:允許將任何cache
選項傳遞給fetch
,但如果未提供任何選項,則將cache
選項設定為'force-cache'
。這表示即使動態 API 之後的fetch
請求也被視為靜態。'only-cache'
:確保所有fetch
請求都選擇加入快取,方法是將預設值變更為cache: 'force-cache'
(如果未提供任何選項),並在任何fetch
請求使用cache: 'no-store'` 時引發錯誤。
'force-cache'
:確保所有fetch
請求都選擇加入快取,方法是將所有fetch
請求的cache
選項設定為'force-cache'
。'default-no-store'
:允許將任何cache
選項傳遞給fetch
,但如果未提供任何選項,則將cache
選項設定為'no-store'
。這表示即使動態 API 之前的fetch
請求也被視為動態。'only-no-store'
:確保所有fetch
請求都選擇退出快取,方法是將預設值變更為cache: 'no-store'
(如果未提供任何選項),並在任何fetch
請求使用cache: 'force-cache'` 時引發錯誤。
'force-no-store'
:確保所有fetch
請求都選擇退出快取,方法是將所有fetch
請求的cache
選項設定為'no-store'
。即使它們提供'force-cache'
選項,這也會強制在每次請求時重新取得所有fetch
請求。
跨路由區段行為
- 單一路線的每個版面配置和頁面中設定的任何選項都需要彼此相容。
- 如果同時提供
'only-cache'
和'force-cache'
,則'force-cache'
勝出。如果同時提供'only-no-store'
和'force-no-store'
,則'force-no-store'
勝出。force 選項會變更整個路由的行為,因此具有'force-*'
的單一區段將防止由'only-*'
引起的任何錯誤。 'only-*'
和'force-*'
選項的目的是保證整個路由是完全靜態或完全動態的。這表示- 單一路線中不允許組合
'only-cache'
和'only-no-store'
。 - 單一路線中不允許組合
'force-cache'
和'force-no-store'
。
- 單一路線中不允許組合
- 如果子項提供
'auto'
或'*-cache'
,則父項不能提供'default-no-store'
,因為這可能會使相同的提取具有不同的行為。
- 如果同時提供
- 一般建議將共用的父版面配置保留為
'auto'
,並在子區段分歧的地方自訂選項。
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
來新增特定的執行限制。例如,在 Vercel上。
注意:此設定需要 Next.js 13.4.10
或更高版本。
export const maxDuration = 5
小提示:
- 如果使用伺服器行為,請在頁面層級設定
maxDuration
,以變更頁面上使用的所有伺服器行為的預設逾時。
generateStaticParams
generateStaticParams
函式可以與動態路由區段結合使用,以定義將在建置時靜態產生而不是在請求時依需求產生的路由區段參數清單。
請參閱 API 參考以瞭解更多詳細資訊。
版本歷史
版本 | |
---|---|
v15.0.0-RC | export const runtime = "experimental-edge" 已棄用。有一個 codemod 可用。 |
這有幫助嗎?