exportPathMap
此功能為
next export
獨有,目前已棄用,建議改用getStaticPaths
(搭配pages
) 或generateStaticParams
(搭配app
)。
exportPathMap
讓您指定請求路徑到頁面目的地的映射,用於匯出期間。在 exportPathMap
中定義的路徑在使用 next dev
時也將可用。
讓我們從一個範例開始,為具有以下頁面的應用程式建立自訂 exportPathMap
pages/index.js
pages/about.js
pages/post.js
開啟 next.config.js
並新增以下 exportPathMap
設定
module.exports = {
exportPathMap: async function (
defaultPathMap,
{ dev, dir, outDir, distDir, buildId }
) {
return {
'/': { page: '/' },
'/about': { page: '/about' },
'/p/hello-nextjs': { page: '/post', query: { title: 'hello-nextjs' } },
'/p/learn-nextjs': { page: '/post', query: { title: 'learn-nextjs' } },
'/p/deploy-nextjs': { page: '/post', query: { title: 'deploy-nextjs' } },
}
},
}
須知:
exportPathMap
中的query
欄位不能與自動靜態優化頁面或getStaticProps
頁面 一起使用,因為它們在建置時被渲染成 HTML 檔案,並且在next export
期間無法提供額外的查詢資訊。
頁面接著將匯出為 HTML 檔案,例如,/about
將變成 /about.html
。
exportPathMap
是一個 async
函數,它接收 2 個參數:第一個是 defaultPathMap
,這是 Next.js 使用的預設映射。第二個參數是一個物件,包含
dev
- 當在開發環境中呼叫exportPathMap
時為true
。當執行next export
時為false
。在開發環境中,exportPathMap
用於定義路由。dir
- 專案目錄的絕對路徑outDir
-out/
目錄的絕對路徑 (可使用-o
設定)。當dev
為true
時,outDir
的值將為null
。distDir
-.next/
目錄的絕對路徑 (可使用distDir
設定)buildId
- 產生的建置 ID
回傳的物件是頁面的映射,其中 key
是 pathname
,而 value
是一個物件,它接受以下欄位
page
:String
- 要渲染的pages
目錄內的頁面query
:Object
- 傳遞給getInitialProps
以進行預先渲染的query
物件。預設為{}
匯出的
pathname
也可以是檔案名稱 (例如,/readme.md
),但如果其內容與.html
不同,您可能需要將Content-Type
標頭設定為text/html
以在提供其內容時使用。
新增尾部斜線
可以設定 Next.js 將頁面匯出為 index.html
檔案,並要求尾部斜線,/about
變成 /about/index.html
,並且可透過 /about/
路由。這是 Next.js 9 之前的預設行為。
若要切換回並新增尾部斜線,請開啟 next.config.js
並啟用 trailingSlash
設定
module.exports = {
trailingSlash: true,
}
自訂輸出目錄
next export
將使用 out
作為預設輸出目錄,您可以使用 -o
引數自訂此目錄,如下所示
next export -o outdir
警告:使用
exportPathMap
已被棄用,並且會被pages
內部的getStaticPaths
覆蓋。我們不建議一起使用它們。
這有幫助嗎?