exportPathMap

此功能僅限於 next export 使用,目前已棄用,建議改用 pages 中的 getStaticPathsapp 中的 generateStaticParams

範例

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 欄位無法與自動靜態優化頁面 (automatically statically optimized pages)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 覆寫。我們不建議同時使用它們。

On this page