Menu

exportPathMap(非推奨)

この機能は 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' } },
    }
  },
}

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

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

exportPathMap は、2 つの引数を受け取る非同期関数です:最初の引数は Next.js によって使用されるデフォルトのマップである defaultPathMap、2 番目の引数は以下のオブジェクトです:

  • dev - exportPathMap が開発中に呼び出される場合は truenext 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)にすることもできますが、異なる場合はコンテンツを提供する際に Content-Type ヘッダーを .html 以外の 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 引数を使用してこれをカスタマイズできます:

Terminal
next export -o outdir

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