Menu

静的エクスポート

Next.jsは静的サイトまたはSingle-Page Application (SPA)として開始し、後でサーバーを必要とする機能にオプションでアップグレードすることを可能にします。

next buildを実行すると、Next.jsは各ルートに対してHTMLファイルを生成します。厳密なSPAを個々のHTMLファイルに分解することで、Next.jsはクライアント側で不要なJavaScriptコードの読み込みを回避し、バンドルサイズを削減し、高速なページ読み込みを実現できます。

Next.jsはこの静的エクスポートをサポートしているため、HTML/CSS/JSの静的アセットを提供できる任意のウェブサーバーにデプロイおよびホスティングできます。

設定

静的エクスポートを有効にするには、next.config.js内の出力モードを変更します：

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フォルダを生成します。

サポートされている機能

Next.jsのコアは静的エクスポートをサポートするように設計されています。

サーバーコンポーネント

next buildを実行して静的エクスポートを生成する際、appディレクトリ内で使用されるサーバーコンポーネントは、従来の静的サイト生成と同様に、ビルド中に実行されます。

結果のコンポーネントは、最初のページ読み込み時に静的HTMLにレンダリングされ、ルート間のクライアントナビゲーション用に静的ペイロードになります。動的サーバー関数を使用しない限り、静的エクスポートを使用する際にサーバーコンポーネントに変更は必要ありません。

app/page.tsx
TypeScript
export default async function Page() {
  // このフェッチは `next build` 中にサーバー上で実行されます
  const res = await fetch('https://api.example.com/...')
  const data = await res.json()
 
  return <main>...</main>
}

クライアントコンポーネント

クライアント側でデータフェッチを行う場合は、SWRを使用するクライアントコンポーネントでリクエストをメモ化できます。

app/other/page.tsx
TypeScript
'use client'
 
import useSWR from 'swr'
 
const fetcher = (url: string) => fetch(url).then((r) => r.json())
 
export default function Page() {
  const { data, error } = useSWR(
    `https://jsonplaceholder.typicode.com/posts/1`,
    fetcher
  )
  if (error) return 'Failed to load'
  if (!data) return 'Loading...'
 
  return data.title
}

ルート遷移はクライアント側で発生するため、従来のSPAのように動作します。例えば、以下のインデックスルートでは、クライアント上で異なる投稿にナビゲートできます：

app/page.tsx
TypeScript
import Link from 'next/link'
 
export default function Page() {
  return (
    <>
      <h1>インデックスページ</h1>
      <hr />
      <ul>
        <li>
          <Link href="/post/1">投稿 1</Link>
        </li>
        <li>
          <Link href="/post/2">投稿 2</Link>
        </li>
      </ul>
    </>
  )
}

画像最適化

next.config.jsでカスタム画像ローダーを定義することで、静的エクスポートで画像最適化を使用できます。例えば、Cloudinaryなどのサービスで画像を最適化できます：

next.config.js
/** @type {import('next').NextConfig} */
const nextConfig = {
  output: 'export',
  images: {
    loader: 'custom',
    loaderFile: './my-loader.ts',
  },
}
 
module.exports = nextConfig

このカスタムローダーは、リモートソースから画像をフェッチする方法を定義します。例えば、以下のローダーはCloudinaryのURLを構築します：

my-loader.ts
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}`
}
my-loader.js
export default function cloudinaryLoader({ src, width, quality }) {
  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の画像への相対パスを定義できます：

app/page.tsx
TypeScript
import Image from 'next/image'
 
export default function Page() {
  return <Image alt="カメ" src="/turtles.jpg" width={300} height={300} />
}

ルートハンドラー

next build実行時、ルートハンドラーは静的レスポンスをレンダリングします。サポートされるのはGET HTTPメソッドのみです。これは、キャッシュありまたはなしのデータから静的HTML、JSON、TXT、その他のファイルを生成するために使用できます。例：

app/data.json/route.ts
export async function GET() {
  return Response.json({ name: 'Lee' })
}
app/data.json/route.js
export async function GET() {
  return Response.json({ name: 'Lee' })
}

上記のファイルapp/data.json/route.tsは、next build中に静的ファイルにレンダリングされ、{ name: 'Lee' }を含むdata.jsonが生成されます。

受信リクエストからの動的な値を読み取る必要がある場合、静的エクスポートは使用できません。

ブラウザAPI

クライアントコンポーネントはnext build中にHTMLに事前レンダリングされます。Web API（window、localStorage、navigatorなど）はサーバー上で利用できないため、ブラウザで実行する場合にのみ、これらのAPIに安全にアクセスする必要があります。例：

'use client';
 
import { useEffect } from 'react';
 
export default function ClientComponent() {
  useEffect(() => {
    // これで `window` にアクセスできます
    console.log(window.innerHeight);
  }, [])
 
  return ...;
}

サポートされていない機能

Node.jsサーバーを必要とする、またはビルドプロセス中に計算できない動的ロジックを伴う機能は、サポートされていません：

next devでこれらの機能のいずれかを使用しようとすると、ルートレイアウトでdynamicオプションをerrorに設定するのと同様のエラーが発生します。

export const dynamic = 'error'

デプロイ

静的エクスポートでは、Next.jsはHTML/CSS/JS静的アセットを提供できる任意のウェブサーバーにデプロイおよびホスティングできます。

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のような静的ホストを使用している場合、着信リクエストを正しいファイルにリライトするように設定できます：

nginx.conf
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.0next exportが"output": "export"に置き換えられました
v13.4.0App Router（安定版）がReactサーバーコンポーネントとルートハンドラを含む、拡張された静的エクスポートをサポートします。
v13.3.0next exportは非推奨となり、"output": "export"に置き換えられました