エラーの処理方法
エラーは予期されるエラーと未捕捉の例外の2つのカテゴリに分けることができます。このページではNext.jsアプリケーションでこれらのエラーを処理する方法を説明します。
予期されるエラーの処理
予期されるエラーとは、サーバーサイドのフォームバリデーションやリクエストの失敗など、アプリケーションの通常の操作中に発生する可能性のあるエラーです。これらのエラーは明示的に処理し、クライアントに返す必要があります。
Server Actions
useActionState
フックを使用してServer Functionsの状態を管理し、予期されるエラーを処理できます。予期されるエラーにはtry
/catch
ブロックを使用しないでください。代わりに、予期されるエラーはスローされる例外ではなく、戻り値としてモデル化できます。
'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
を使用してエラーメッセージを表示できます。
'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>
)
}
Server Components
Server Component内でデータをフェッチする場合、レスポンスを使用して条件付きでエラーメッセージをレンダリングしたり、redirect
したりできます。
export default async function Page() {
const res = await fetch(`https://...`)
const data = await res.json()
if (!res.ok) {
return 'There was an error.'
}
return '...'
}
Not found
ルートセグメント内でnotFound
関数を呼び出し、not-found.js
ファイルを使用して404 UIを表示できます。
import { getPostBySlug } from '@/lib/posts'
export default async function Page({ params }: { params: { slug: string } }) {
const post = getPostBySlug((await params).slug)
if (!post) {
notFound()
}
return <div>{post.title}</div>
}
export default function NotFound() {
return <div>404 - Page Not Found</div>
}
未捕捉の例外の処理
未捕捉の例外は、アプリケーションの通常のフローでは発生しないはずのバグや問題を示す予期しないエラーです。これらはエラーをスローすることで処理され、そのエラーはエラーバウンダリによって捕捉されます。
ネストされたエラーバウンダリ
Next.jsは未捕捉の例外を処理するためにエラーバウンダリを使用します。エラーバウンダリは子コンポーネントのエラーを捕捉し、クラッシュしたコンポーネントツリーの代わりにフォールバックUIを表示します。
ルートセグメント内にerror.js
ファイルを追加し、Reactコンポーネントをエクスポートすることでエラーバウンダリを作成できます:
'use client' // エラーバウンダリはクライアントコンポーネントである必要があります
import { useEffect } from 'react'
export default function Error({
error,
reset,
}: {
error: Error & { digest?: string }
reset: () => void
}) {
useEffect(() => {
// エラーをエラー報告サービスに記録する
console.error(error)
}, [error])
return (
<div>
<h2>Something went wrong!</h2>
<button
onClick={
// セグメントの再レンダリングを試みて回復を試みる
() => reset()
}
>
Try again
</button>
</div>
)
}
エラーは最も近い親のエラーバウンダリにバブルアップします。これにより、ルート階層の異なるレベルにerror.tsx
ファイルを配置することで、きめ細かいエラー処理が可能になります。
グローバルエラー
あまり一般的ではありませんが、国際化を活用する場合でも、ルートappディレクトリにあるglobal-error.js
ファイルを使用して、ルートレイアウトのエラーを処理できます。グローバルエラーUIは、アクティブな場合にルートレイアウトまたはテンプレートを置き換えるため、独自の<html>
タグと<body>
タグを定義する必要があります。
'use client' // エラーバウンダリはクライアントコンポーネントである必要があります
export default function GlobalError({
error,
reset,
}: {
error: Error & { digest?: string }
reset: () => void
}) {
return (
// global-errorはhtmlとbodyタグを含める必要があります
<html>
<body>
<h2>Something went wrong!</h2>
<button onClick={() => reset()}>Try again</button>
</body>
</html>
)
}