跳到主要內容

exportPathMap

這是一個舊版 API,不再建議使用。為了向後相容性,它仍然受到支援。

此功能是 next export 獨有的,目前已棄用,建議改用搭配 pagesgetStaticPaths 或搭配 appgenerateStaticParams

exportPathMap 允許您指定請求路徑到頁面目的地的映射,以便在匯出期間使用。在 exportPathMap 中定義的路徑在使用 next dev 時也將可用。

讓我們從一個範例開始,為具有以下頁面的應用程式建立自訂 exportPathMap

  • pages/index.js
  • pages/about.js
  • pages/post.js

開啟 next.config.js 並新增以下 exportPathMap 設定

next.config.js
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 設定)。當 devtrue 時,outDir 的值將為 null
  • distDir - .next/ 目錄的絕對路徑(可使用 distDir 設定選項設定)
  • buildId - 產生的建置 ID

返回的物件是頁面的映射,其中 keypathname,而 value 是一個物件,它接受以下欄位

  • page: String - 要渲染的 pages 目錄中的頁面
  • query: Object - 在預先渲染時傳遞給 getInitialPropsquery 物件。預設為 {}

匯出的 pathname 也可以是檔案名稱(例如,/readme.md),但如果其內容與 .html 不同,您可能需要在提供其內容時將 Content-Type 標頭設定為 text/html

新增尾端斜線

可以設定 Next.js 將頁面匯出為 index.html 檔案,並要求尾端斜線,/about 變成 /about/index.html,並且可以透過 /about/ 路由。這是 Next.js 9 之前的預設行為。

若要切換回並新增尾端斜線,請開啟 next.config.js 並啟用 trailingSlash 設定

next.config.js
module.exports = {
  trailingSlash: true,
}

自訂輸出目錄

next export 將使用 out 作為預設輸出目錄,您可以使用 -o 參數自訂此目錄,如下所示

終端機
next export -o outdir

警告:使用 exportPathMap 已被棄用,並且會被 pages 內部的 getStaticPaths 覆蓋。我們不建議一起使用它們。