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
設定を追加します:
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
は2つの引数を受け取るasync
関数です。最初の引数はdefaultPathMap
で、Next.jsが使用するデフォルトのマップです。2番目の引数は以下のプロパティを持つオブジェクトです:
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
によって上書きされます。これらを一緒に使用することは推奨しません。