|
| 1 | +--- |
| 2 | +source-updated-at: 2025-05-16T04:52:11.000Z |
| 3 | +translation-updated-at: 2025-06-06T04:59:30.331Z |
| 4 | +title: exportPathMap |
| 5 | +description: next export 使用時にHTMLファイルとしてエクスポートされるページをカスタマイズ |
| 6 | +version: legacy |
| 7 | +--- |
| 8 | + |
| 9 | +{/* このドキュメントの内容はappルーターとpagesルーターで共有されています。Pages Router固有のコンテンツを追加する場合は`<PagesOnly>コンテンツ</PagesOnly>`コンポーネントを使用してください。共有コンテンツはコンポーネントでラップしないでください。 */} |
| 10 | + |
| 11 | +> この機能は `next export` 専用で、現在は `pages` の `getStaticPaths` または `app` の `generateStaticParams` を優先するため**非推奨**です。 |
| 12 | +
|
| 13 | +`exportPathMap` を使用すると、エクスポート時に使用されるリクエストパスからページ宛先へのマッピングを指定できます。`exportPathMap` で定義されたパスは [`next dev`](/docs/app/api-reference/cli/next#next-dev-options) 使用時にも利用可能です。 |
| 14 | + |
| 15 | +以下のページを持つアプリケーションのカスタム `exportPathMap` を作成する例から始めましょう: |
| 16 | + |
| 17 | +- `pages/index.js` |
| 18 | +- `pages/about.js` |
| 19 | +- `pages/post.js` |
| 20 | + |
| 21 | +`next.config.js` を開き、以下の `exportPathMap` 設定を追加します: |
| 22 | + |
| 23 | +```js filename="next.config.js" |
| 24 | +module.exports = { |
| 25 | + exportPathMap: async function ( |
| 26 | + defaultPathMap, |
| 27 | + { dev, dir, outDir, distDir, buildId } |
| 28 | + ) { |
| 29 | + return { |
| 30 | + '/': { page: '/' }, |
| 31 | + '/about': { page: '/about' }, |
| 32 | + '/p/hello-nextjs': { page: '/post', query: { title: 'hello-nextjs' } }, |
| 33 | + '/p/learn-nextjs': { page: '/post', query: { title: 'learn-nextjs' } }, |
| 34 | + '/p/deploy-nextjs': { page: '/post', query: { title: 'deploy-nextjs' } }, |
| 35 | + } |
| 36 | + }, |
| 37 | +} |
| 38 | +``` |
| 39 | + |
| 40 | +> **豆知識**: `exportPathMap` の `query` フィールドは、[自動静的最適化ページ](/docs/pages/building-your-application/rendering/automatic-static-optimization) や [`getStaticProps` ページ](/docs/pages/building-your-application/data-fetching/get-static-props) では使用できません。これらはビルド時にHTMLファイルとしてレンダリングされるため、`next export` 時に追加のクエリ情報を提供できないからです。 |
| 41 | +
|
| 42 | +ページはHTMLファイルとしてエクスポートされます。例えば `/about` は `/about.html` になります。 |
| 43 | + |
| 44 | +`exportPathMap` は2つの引数を受け取る `async` 関数です。最初の引数は `defaultPathMap` で、Next.jsが使用するデフォルトのマップです。2番目の引数は以下のプロパティを持つオブジェクトです: |
| 45 | + |
| 46 | +- `dev` - 開発時に `exportPathMap` が呼び出される場合は `true`。`next export` 実行時は `false`。開発時には `exportPathMap` がルート定義に使用されます |
| 47 | +- `dir` - プロジェクトディレクトリの絶対パス |
| 48 | +- `outDir` - `out/` ディレクトリの絶対パス([`-o` で設定可能](#カスタム出力ディレクトリ))。`dev` が `true` の場合、`outDir` の値は `null` になります |
| 49 | +- `distDir` - `.next/` ディレクトリの絶対パス([`distDir`](/docs/pages/api-reference/config/next-config-js/distDir) 設定で設定可能) |
| 50 | +- `buildId` - 生成されたビルドID |
| 51 | + |
| 52 | +返されるオブジェクトはページのマップで、`key` は `pathname`、`value` は以下のフィールドを受け入れるオブジェクトです: |
| 53 | + |
| 54 | +- `page`: `String` - レンダリングする `pages` ディレクトリ内のページ |
| 55 | +- `query`: `Object` - プリレンダリング時に `getInitialProps` に渡される `query` オブジェクト。デフォルトは `{}` |
| 56 | + |
| 57 | +> エクスポートされる `pathname` はファイル名(例:`/readme.md`)にもできますが、コンテンツが `.html` と異なる場合は、サービス提供時に `Content-Type` ヘッダーを `text/html` に設定する必要があるかもしれません。 |
| 58 | +
|
| 59 | +## 末尾スラッシュの追加 |
| 60 | + |
| 61 | +Next.jsを設定して、ページを `index.html` ファイルとしてエクスポートし、末尾スラッシュを要求することが可能です。`/about` は `/about/index.html` になり、`/about/` でルーティング可能になります。これはNext.js 9以前のデフォルトの動作でした。 |
| 62 | + |
| 63 | +末尾スラッシュを追加して元の動作に戻すには、`next.config.js` を開き `trailingSlash` 設定を有効にします: |
| 64 | + |
| 65 | +```js filename="next.config.js" |
| 66 | +module.exports = { |
| 67 | + trailingSlash: true, |
| 68 | +} |
| 69 | +``` |
| 70 | + |
| 71 | +## 出力ディレクトリのカスタマイズ |
| 72 | + |
| 73 | +<AppOnly> |
| 74 | + |
| 75 | +[`next export`](/docs/app/guides/static-exports) はデフォルトで `out` を出力ディレクトリとして使用します。`-o` 引数を使用して以下のようにカスタマイズできます: |
| 76 | + |
| 77 | +</AppOnly> |
| 78 | + |
| 79 | +<PagesOnly> |
| 80 | + |
| 81 | +[`next export`](/docs/pages/guides/static-exports) はデフォルトで `out` を出力ディレクトリとして使用します。`-o` 引数を使用して以下のようにカスタマイズできます: |
| 82 | + |
| 83 | +</PagesOnly> |
| 84 | + |
| 85 | +```bash filename="ターミナル" |
| 86 | +next export -o outdir |
| 87 | +``` |
| 88 | + |
| 89 | +> **警告**: `exportPathMap` の使用は非推奨であり、`pages` 内の `getStaticPaths` によって上書きされます。これらを一緒に使用することはお勧めしません。 |
0 commit comments