Next.jsアプリケーションの静的エクスポートを作成する方法
Next.jsは静的サイトまたはシングルページアプリケーション(SPA)として開始し、後でオプションでサーバーを必要とする機能を使用するようにアップグレードすることができます。
next build
を実行すると、Next.jsはルートごとにHTMLファイルを生成します。厳密なSPAを個々のHTMLファイルに分割することで、Next.jsはクライアント側で不要なJavaScriptコードを読み込まずに済み、バンドルサイズを削減し、ページの読み込みを高速化できます。
Next.jsはこの静的エクスポートをサポートしているため、HTML/CSS/JSの静的アセットを提供できるあらゆるWebサーバーにデプロイしてホスティングすることができます。
設定
静的エクスポートを有効にするには、next.config.js
内の出力モードを変更します:
/**
* @type {import('next').NextConfig}
*/
const nextConfig = {
output: 'export',
// オプション: リンクを `/me` -> `/me/` に変更し、`/me.html` -> `/me/index.html` として出力
// trailingSlash: true,
// オプション: 自動的な `/me` -> `/me/` への変更を防止し、代わりに `href` を保持
// skipTrailingSlashRedirect: true,
// オプション: 出力ディレクトリを `out` -> `dist` に変更
// distDir: 'dist',
}
module.exports = nextConfig
next build
を実行すると、Next.jsはアプリケーションのHTML/CSS/JSアセットを含むout
フォルダを作成します。
getStaticProps
とgetStaticPaths
を活用して、pages
ディレクトリ内の各ページ(または動的ルートの場合はそれ以上)のHTMLファイルを生成できます。
サポートされる機能
静的サイトを構築するために必要なNext.jsのコア機能の大部分がサポートされています:
getStaticPaths
を使用した動的ルートnext/link
によるプリフェッチ- JavaScriptのプリロード
- 動的インポート
- あらゆるスタイリングオプション(CSS Modules、styled-jsxなど)
- クライアント側のデータ取得
getStaticProps
getStaticPaths
画像最適化
next/image
を通じた画像最適化は、next.config.js
でカスタム画像ローダーを定義することで静的エクスポートで使用できます。たとえば、Cloudinaryのようなサービスで画像を最適化できます:
/** @type {import('next').NextConfig} */
const nextConfig = {
output: 'export',
images: {
loader: 'custom',
loaderFile: './my-loader.ts',
},
}
module.exports = nextConfig
このカスタムローダーは、リモートソースから画像をフェッチする方法を定義します。たとえば、次のローダーはCloudinary用のURLを構築します:
export default function cloudinaryLoader({
src,
width,
quality,
}: {
src: string
width: number
quality?: number
}) {
const params = ['f_auto', 'c_limit', `w_${width}`, `q_${quality || 'auto'}`]
return `https://res.cloudinary.com/demo/image/upload/${params.join(
','
)}${src}`
}
その後、アプリケーションでnext/image
を使用し、Cloudinaryの画像への相対パスを定義できます:
import Image from 'next/image'
export default function Page() {
return <Image alt="turtles" src="/turtles.jpg" width={300} height={300} />
}
サポートされない機能
Node.jsサーバーを必要とする機能、またはビルドプロセス中に計算できない動的ロジックはサポートされていません:
- 国際化対応ルーティング
- APIルート
- リライト
- リダイレクト
- ヘッダー
- ミドルウェア
- インクリメンタル静的再生成
- デフォルトの
loader
を使用した画像最適化 - ドラフトモード
fallback: true
を使用したgetStaticPaths
fallback: 'blocking'
を使用したgetStaticPaths
getServerSideProps
デプロイ
静的エクスポートを使用すると、Next.jsはHTML/CSS/JSの静的アセットを提供できるあらゆるWebサーバーにデプロイしてホスティングできます。
next build
を実行すると、Next.jsはout
フォルダに静的エクスポートを生成します。たとえば、次のようなルートがあるとします:
/
/blog/[id]
next build
実行後、Next.jsは以下のファイルを生成します:
/out/index.html
/out/404.html
/out/blog/post-1.html
/out/blog/post-2.html
Nginxのような静的ホスティングを使用している場合、受信リクエストから正しいファイルへのリライトを設定できます:
server {
listen 80;
server_name acme.com;
root /var/www/out;
location / {
try_files $uri $uri.html $uri/ =404;
}
# これは `trailingSlash: false` の場合に必要です。
# `trailingSlash: true` の場合は省略できます。
location /blog/ {
rewrite ^/blog/(.*)$ /blog/$1.html break;
}
error_page 404 /404.html;
location = /404.html {
internal;
}
}
バージョン履歴
バージョン | 変更点 |
---|---|
v14.0.0 | next export は"output": "export" に置き換えられ削除されました |
v13.4.0 | Appルーター(安定版)が強化された静的エクスポートをサポート(Reactサーバーコンポーネントとルートハンドラーを含む) |
v13.3.0 | next export は非推奨となり、"output": "export" に置き換えられました |