コンテンツにスキップ

exportPathMap

この機能はnext export専用であり、現在pagesでのgetStaticPaths、またはappでの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' } },
    }
  },
}

注意点: exportPathMapqueryフィールドは、自動静的最適化されたページgetStaticPropsページでは使用できません。これらはビルド時にHTMLファイルとしてレンダリングされるため、next export中に追加のクエリ情報を提供することはできません。

これらのページはHTMLファイルとしてエクスポートされます。たとえば、/about/about.htmlになります。

exportPathMapは2つの引数を受け取るasync関数です。最初の引数はNext.jsが使用するデフォルトのマップであるdefaultPathMapです。2番目の引数は以下のフィールドを持つオブジェクトです。

  • dev - 開発環境でexportPathMapが呼び出されている場合はtrueです。next exportを実行している場合はfalseです。開発環境ではexportPathMapはルートを定義するために使用されます。
  • dir - プロジェクトディレクトリへの絶対パス
  • outDir - out/ディレクトリへの絶対パス(-oで設定可能)。devtrueの場合、outDirの値はnullになります。
  • distDir - .next/ディレクトリへの絶対パス(distDir設定で設定可能)
  • buildId - 生成されたビルドID

返されるオブジェクトはページのマップで、keypathnamevalueは以下のフィールドを受け入れるオブジェクトです。

  • 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設定を有効にします。

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

出力ディレクトリをカスタマイズする

next exportはデフォルトの出力ディレクトリとしてoutを使用しますが、以下のように-o引数を使用してカスタマイズできます。

ターミナル
next export -o outdir

警告: exportPathMapの使用は非推奨であり、pages内のgetStaticPathsによって上書きされます。これらを一緒に使用することはお勧めしません。