エラーの処理方法

エラーは、予期されるエラーとキャッチされない例外の2つのカテゴリに分けられます。このページでは、Next.js アプリケーションでこれらのエラーを処理する方法について説明します。

予期されるエラーの処理

予期されるエラーは、サーバーサイドフォームの検証やリクエストの失敗など、アプリケーションの通常の操作中に発生する可能性があるエラーです。これらのエラーは明示的に処理され、クライアントに返されるべきです。

サーバー関数

useActionState フックを使用して、サーバー関数で予期されるエラーを処理できます。

これらのエラーについては、try/catch ブロックの使用を避け、エラーをスローしないようにしてください。代わりに、予期されるエラーを戻り値としてモデル化してください。

app/actions.ts

'use server'
 
export async function createPost(prevState: any, formData: FormData) {
  const title = formData.get('title')
  const content = formData.get('content')
 
  const res = await fetch('https://api.vercel.app/posts', {
    method: 'POST',
    body: { title, content },
  })
  const json = await res.json()
 
  if (!res.ok) {
    return { message: 'Failed to create post' }
  }
}

アクションを useActionState フックに渡し、返される state を使用してエラーメッセージを表示できます。

app/ui/form.tsx

'use client'
 
import { useActionState } from 'react'
import { createPost } from '@/app/actions'
 
const initialState = {
  message: '',
}
 
export function Form() {
  const [state, formAction, pending] = useActionState(createPost, initialState)
 
  return (
    <form action={formAction}>
      <label htmlFor="title">Title</label>
      <input type="text" id="title" name="title" required />
      <label htmlFor="content">Content</label>
      <textarea id="content" name="content" required />
      {state?.message && <p aria-live="polite">{state.message}</p>}
      <button disabled={pending}>Create Post</button>
    </form>
  )
}

サーバーコンポーネント

サーバーコンポーネント内でデータを取得する場合、そのレスポンスを使用してエラーメッセージを条件付きでレンダリングしたり、redirectしたりできます。

app/page.tsx

export default async function Page() {
  const res = await fetch(`https://...`)
  const data = await res.json()
 
  if (!res.ok) {
    return 'There was an error.'
  }
 
  return '...'
}

見つかりません

ルートセグメント内でnotFound関数を呼び出し、not-found.jsファイルを使用して404 UIを表示できます。

app/blog/[slug]/page.tsx

import { getPostBySlug } from '@/lib/posts'
 
export default async function Page({ params }: { params: { slug: string } }) {
  const { slug } = await params
  const post = getPostBySlug(slug)
 
  if (!post) {
    notFound()
  }
 
  return <div>{post.title}</div>
}

app/blog/[slug]/not-found.tsx

export default function NotFound() {
  return <div>404 - Page Not Found</div>
}

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

キャッチされない例外とは、バグや、アプリケーションの通常のフローでは発生すべきではない問題を示す予期せぬエラーです。これらはエラーをスローすることで処理され、その後エラー境界によってキャッチされます。

ネストされたエラー境界

Next.js はキャッチされない例外を処理するためにエラー境界を使用します。エラー境界は子コンポーネント内のエラーをキャッチし、クラッシュしたコンポーネントツリーの代わりに代替 UI を表示します。

ルートセグメント内にerror.jsファイルを追加し、React コンポーネントをエクスポートすることでエラー境界を作成します

app/dashboard/error.tsx

'use client' // Error boundaries must be Client Components
 
import { useEffect } from 'react'
 
export default function Error({
  error,
  reset,
}: {
  error: Error & { digest?: string }
  reset: () => void
}) {
  useEffect(() => {
    // Log the error to an error reporting service
    console.error(error)
  }, [error])
 
  return (
    <div>
      <h2>Something went wrong!</h2>
      <button
        onClick={
          // Attempt to recover by trying to re-render the segment
          () => reset()
        }
      >
        Try again
      </button>
    </div>
  )
}

エラーは最も近い親のエラー境界に伝播します。これにより、ルーティング階層の異なるレベルにerror.tsxファイルを配置することで、きめ細かなエラー処理が可能になります。

グローバルエラー

一般的ではありませんが、国際化を活用している場合でも、ルートアプリディレクトリにあるglobal-error.jsファイルを使用してルートレイアウトのエラーを処理できます。グローバルエラーUIは、アクティブになるとルートレイアウトまたはテンプレートを置き換えるため、独自の<html>と<body>タグを定義する必要があります。

app/global-error.tsx

'use client' // Error boundaries must be Client Components
 
export default function GlobalError({
  error,
  reset,
}: {
  error: Error & { digest?: string }
  reset: () => void
}) {
  return (
    // global-error must include html and body tags
    <html>
      <body>
        <h2>Something went wrong!</h2>
        <button onClick={() => reset()}>Try again</button>
      </body>
    </html>
  )
}

エラーの処理方法

予期されるエラーの処理

サーバー関数

サーバーコンポーネント

見つかりません

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

ネストされたエラー境界

グローバルエラー

API リファレンス

redirect

error.js

notFound

not-found.js