コンテンツにスキップ

エラーハンドリング

エラーは、予期されたエラーキャッチされない例外の2つのカテゴリに分けられます。

  • 予期されたエラーを戻り値としてモデル化する: サーバーアクションでは、予期されたエラーに対してtry/catchの使用を避けてください。useActionStateフックを使用してこれらのエラーを管理し、クライアントに返します。
  • 予期しないエラーにはエラー境界を使用する: 予期しないエラーを処理し、フォールバックUIを提供するために、error.tsxおよびglobal-error.tsxファイルを使用してエラー境界を実装します。

予期されたエラーの処理

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

サーバーアクションからの予期されたエラーの処理

useActionStateフックを使用して、エラー処理を含むサーバーアクションの状態を管理します。このアプローチでは、予期されたエラーに対するtry/catchブロックを回避します。予期されたエラーは、スローされた例外ではなく戻り値としてモデル化されるべきです。

app/actions.ts
'use server'
 
import { redirect } from 'next/navigation'
 
export async function createUser(prevState: any, formData: FormData) {
  const res = await fetch('https://...')
  const json = await res.json()
 
  if (!res.ok) {
    return { message: 'Please enter a valid email' }
  }
 
  redirect('/dashboard')
}

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

app/ui/signup.tsx
'use client'
 
import { useActionState } from 'react'
import { createUser } from '@/app/actions'
 
const initialState = {
  message: '',
}
 
export function Signup() {
  const [state, formAction, pending] = useActionState(createUser, initialState)
 
  return (
    <form action={formAction}>
      <label htmlFor="email">Email</label>
      <input type="text" id="email" name="email" required />
      {/* ... */}
      <p aria-live="polite">{state?.message}</p>
      <button disabled={pending}>Sign up</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 '...'
}

キャッチされない例外

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

  • 一般的: ルートレイアウト以下のキャッチされないエラーはerror.jsで処理します。
  • 任意: ネストされたerror.jsファイル(例: app/dashboard/error.js)を使用して、詳細なキャッチされないエラーを処理します。
  • 稀: ルートレイアウト内のキャッチされないエラーはglobal-error.jsで処理します。

エラー境界の使用

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

ルートセグメント内にerror.tsxファイルを追加し、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コンポーネントをレンダリングする際にthrowすることができます。

ネストされたルートでのエラー処理

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

Nested Error Component Hierarchy

グローバルエラーの処理

稀ではありますが、国際化を活用している場合でも、ルートアプリディレクトリにあるapp/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>
  )
}