错误处理
错误可以分为两类:预期错误和未捕获的异常
- 将预期错误建模为返回值:避免在服务器行为中对预期错误使用
try
/catch
。使用useActionState
来管理这些错误并将它们返回给客户端。 - 使用错误边界处理意外错误:使用
error.tsx
和global-error.tsx
文件实现错误边界,以处理意外错误并提供回退 UI。
处理预期错误
预期错误是在应用程序正常运行期间可能发生的错误,例如来自服务器端表单验证或失败请求的错误。这些错误应被显式处理并返回给客户端。
处理来自服务器行为的预期错误
使用 useActionState
Hook 来管理服务器行为的状态,包括处理错误。这种方法避免了对预期错误使用 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
Hook,并使用返回的 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>
)
}
你还可以使用返回的状态从客户端组件显示 Toast 消息。
处理来自服务器组件的预期错误
当在服务器组件内部获取数据时,你可以使用响应来有条件地渲染错误消息或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
文件放置在路由层级结构中的不同级别来实现细粒度的错误处理。


处理全局错误
虽然不太常见,但即使在使用国际化时,你也可以使用位于根 app 目录中的 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>
)
}
这有帮助吗?