コンテンツにスキップ

インクリメンタル静的再生成 (ISR) の実装方法

インクリメンタル静的再生成 (ISR) を使用すると、

  • サイト全体を再構築せずに静的コンテンツを更新できます。
  • ほとんどのリクエストで事前レンダリングされた静的ページを提供することで、サーバー負荷を軽減します。
  • ページに適切な cache-control ヘッダーが自動的に追加されるようにします。
  • next build の時間が長くなることなく、大量のコンテンツページを処理できます。

最小限の例を以下に示します。

pages/blog/[id].tsx
import type { GetStaticPaths, GetStaticProps } from 'next'
 
interface Post {
  id: string
  title: string
  content: string
}
 
interface Props {
  post: Post
}
 
export const getStaticPaths: GetStaticPaths = async () => {
  const posts = await fetch('https://api.vercel.app/blog').then((res) =>
    res.json()
  )
  const paths = posts.map((post: Post) => ({
    params: { id: String(post.id) },
  }))
 
  return { paths, fallback: 'blocking' }
}
 
export const getStaticProps: GetStaticProps<Props> = async ({
  params,
}: {
  params: { id: string }
}) => {
  const post = await fetch(`https://api.vercel.app/blog/${params.id}`).then(
    (res) => res.json()
  )
 
  return {
    props: { post },
    // Next.js will invalidate the cache when a
    // request comes in, at most once every 60 seconds.
    revalidate: 60,
  }
}
 
export default function Page({ post }: Props) {
  return (
    <main>
      <h1>{post.title}</h1>
      <p>{post.content}</p>
    </main>
  )
}

この例の仕組みは以下のとおりです。

  1. next build 中に、既知のすべてのブログ記事が生成されます。
  2. これらのページへのリクエスト (例: /blog/1) はキャッシュされ、即座に返されます。
  3. 60秒経過すると、次回の要求でもキャッシュされた (古い) ページが返されます。
  4. キャッシュが無効化され、新しいバージョンのページがバックグラウンドで生成され始めます。
  5. 正常に生成されると、次回の要求で更新されたページが返され、以降のリクエストのためにキャッシュされます。
  6. /blog/26 がリクエストされ、それが存在する場合、ページはオンデマンドで生成されます。この動作は、異なる fallback 値を使用することで変更できます。ただし、投稿が存在しない場合は 404 が返されます。

リファレンス

関数

res.revalidate() によるオンデマンド検証

より正確な再検証方法として、API Router からオンデマンドで新しいページを生成するために res.revalidate を使用します。

たとえば、この API Route は /api/revalidate?secret=<token> で呼び出して、指定されたブログ記事を再検証できます。Next.js アプリのみが知っている秘密のトークンを作成します。この秘密は、再検証 API Route への不正アクセスを防ぐために使用されます。

pages/api/revalidate.ts
import type { NextApiRequest, NextApiResponse } from 'next'
 
export default async function handler(
  req: NextApiRequest,
  res: NextApiResponse
) {
  // Check for secret to confirm this is a valid request
  if (req.query.secret !== process.env.MY_SECRET_TOKEN) {
    return res.status(401).json({ message: 'Invalid token' })
  }
 
  try {
    // This should be the actual path not a rewritten path
    // e.g. for "/posts/[id]" this should be "/posts/1"
    await res.revalidate('/posts/1')
    return res.json({ revalidated: true })
  } catch (err) {
    // If there was an error, Next.js will continue
    // to show the last successfully generated page
    return res.status(500).send('Error revalidating')
  }
}

オンデマンド再検証を使用している場合、getStaticProps 内に revalidate 時間を指定する必要はありません。Next.js はデフォルト値の false (再検証なし) を使用し、res.revalidate() が呼び出されたときにのみページをオンデマンドで再検証します。

キャッチされない例外の処理

バックグラウンド生成の処理中に getStaticProps でエラーが発生した場合、または手動でエラーをスローした場合、最後に正常に生成されたページが表示され続けます。次回の要求で、Next.js は getStaticProps を再試行します。

pages/blog/[id].tsx
import type { GetStaticProps } from 'next'
 
interface Post {
  id: string
  title: string
  content: string
}
 
interface Props {
  post: Post
}
 
export const getStaticProps: GetStaticProps<Props> = async ({
  params,
}: {
  params: { id: string }
}) => {
  // If this request throws an uncaught error, Next.js will
  // not invalidate the currently shown page and
  // retry getStaticProps on the next request.
  const res = await fetch(`https://api.vercel.app/blog/${params.id}`)
  const post: Post = await res.json()
 
  if (!res.ok) {
    // If there is a server error, you might want to
    // throw an error instead of returning so that the cache is not updated
    // until the next successful request.
    throw new Error(`Failed to fetch posts, received status ${res.status}`)
  }
 
  return {
    props: { post },
    // Next.js will invalidate the cache when a
    // request comes in, at most once every 60 seconds.
    revalidate: 60,
  }
}

キャッシュ場所のカスタマイズ

キャッシュされたページやデータを永続ストレージに保存したい場合、または複数のコンテナや Next.js アプリケーションインスタンス間でキャッシュを共有したい場合は、Next.js のキャッシュ場所を設定できます。詳細はこちら

トラブルシューティング

ローカル開発でのキャッシュデータデバッグ

fetch API を使用している場合、どのリクエストがキャッシュされているか、またはされていないかを理解するために、追加のロギングを追加できます。logging オプションの詳細はこちら

next.config.js
module.exports = {
  logging: {
    fetches: {
      fullUrl: true,
    },
  },
}

本番環境での正しい動作の検証

本番環境でページが正しくキャッシュおよび再検証されていることを確認するには、next build を実行してから next start を実行して本番 Next.js サーバーを起動し、ローカルでテストできます。

これにより、本番環境での ISR の動作をテストできます。さらにデバッグするには、.env ファイルに次の環境変数を追加します。

.env
NEXT_PRIVATE_DEBUG_CACHE=1

これにより、Next.js サーバーが ISR のキャッシュヒットとミスをコンソールログに出力するようになります。出力を見て、next build 中にどのページが生成されたか、またパスがオンデマンドでアクセスされるにつれてページがどのように更新されるかを確認できます。

注意点

  • ISR は Node.js ランタイム (デフォルト) を使用している場合にのみサポートされます。
  • ISR は、静的エクスポートを作成する際にはサポートされていません。
  • オンデマンド ISR リクエストではプロキシは実行されないため、プロキシ内のパスリライトやロジックは適用されません。正確なパスを再検証していることを確認してください。たとえば、リライトされた /post-1 ではなく /post/1 です。

プラットフォームのサポート

デプロイメントオプションサポート
Node.jsサーバーはい
Dockerコンテナはい
静的エクスポートいいえ
アダプタープラットフォーム固有

Next.js をセルフホスティングする際に ISR を構成する方法については、こちらをご覧ください。

バージョン履歴

バージョン変更履歴
v14.1.0カスタム cacheHandler は安定しています。
v13.0.0App Router が導入されました。
v12.2.0Pages Router: オンデマンド ISR は安定しました。
v12.0.0Pages Router: Bot-aware ISR fallback が追加されました。
v9.5.0Pages Router: Stable ISR が導入されました