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
関数です。最初の引数はNext.jsが使用するデフォルトのマップであるdefaultPathMap
です。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
によって上書きされます。これらを一緒に使用することはお勧めしません。
これは役立ちましたか?