Menu

Error Handling

错误可以分为两类:预期错误未捕获的异常。本页面将引导你了解如何在 Next.js 应用程序中处理这些错误。

处理预期错误

预期错误是指在应用程序正常运行过程中可能发生的错误,例如来自服务端表单验证或失败的请求。这些错误应该被明确处理并返回给客户端。

Server Functions

你可以使用 useActionState hook 来处理 Server Functions 中的预期错误。

对于这些错误,避免使用 try/catch 块和抛出错误。相反,将预期错误建模为返回值。

app/actions.ts
TypeScript
'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: '创建文章失败' }
  }
}

你可以将你的 action 传递给 useActionState hook,并使用返回的 state 来显示错误消息。

app/ui/form.tsx
TypeScript
'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">标题</label>
      <input type="text" id="title" name="title" required />
      <label htmlFor="content">内容</label>
      <textarea id="content" name="content" required />
      {state?.message && <p aria-live="polite">{state.message}</p>}
      <button disabled={pending}>创建文章</button>
    </form>
  )
}

Server Components

在 Server Component 内部获取数据时,你可以使用响应来有条件地渲染错误消息或 redirect

app/page.tsx
TypeScript
export default async function Page() {
  const res = await fetch(`https://...`)
  const data = await res.json()
 
  if (!res.ok) {
    return '发生了一个错误。'
  }
 
  return '...'
}

Not found

你可以在路由段内调用 notFound 函数,并使用 not-found.js 文件来显示 404 UI。

app/blog/[slug]/page.tsx
TypeScript
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
TypeScript
export default function NotFound() {
  return <div>404 - 页面未找到</div>
}

处理未捕获的异常

未捕获的异常是指示 bug 或问题的意外错误,这些错误不应在应用程序的正常流程中发生。这些应该通过抛出错误来处理,然后由错误边界捕获。

嵌套错误边界

Next.js 使用错误边界来处理未捕获的异常。错误边界捕获其子组件中的错误,并显示回退 UI,而不是崩溃的组件树。

通过在路由段内添加 error.js 文件并导出一个 React 组件来创建错误边界:

app/dashboard/error.tsx
TypeScript
'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>出错了!</h2>
      <button
        onClick={
          // 尝试通过重新渲染段来恢复
          () => reset()
        }
      >
        重试
      </button>
    </div>
  )
}

错误将冒泡到最近的父错误边界。这允许通过在路由层次结构的不同级别放置 error.tsx 文件来实现精细的错误处理。

嵌套错误组件层次结构

错误边界不会捕获事件处理程序内部的错误。它们旨在捕获渲染期间的错误,以显示回退 UI,而不是使整个应用程序崩溃。

一般来说,事件处理程序或异步代码中的错误不会被错误边界处理,因为它们在渲染之后运行。

要处理这些情况,手动捕获错误并使用 useStateuseReducer 存储它,然后更新 UI 以通知用户。

'use client'
 
import { useState } from 'react'
 
export function Button() {
  const [error, setError] = useState(null)
 
  const handleClick = () => {
    try {
      // 做一些可能失败的工作
      throw new Error('异常')
    } catch (reason) {
      setError(reason)
    }
  }
 
  if (error) {
    /* 渲染回退 UI */
  }
 
  return (
    <button type="button" onClick={handleClick}>
      点击我
    </button>
  )
}

注意,来自 useTransitionstartTransition 内部的未处理错误将冒泡到最近的错误边界。

'use client'
 
import { useTransition } from 'react'
 
export function Button() {
  const [pending, startTransition] = useTransition()
 
  const handleClick = () =>
    startTransition(() => {
      throw new Error('异常')
    })
 
  return (
    <button type="button" onClick={handleClick}>
      点击我
    </button>
  )
}

全局错误

虽然不太常见,但你可以使用位于根应用程序目录中的 global-error.js 文件来处理根布局中的错误,即使在利用国际化时也是如此。全局错误 UI 必须定义自己的 <html><body> 标签,因为它在激活时会替换根布局或模板。

app/global-error.tsx
TypeScript
'use client' // 错误边界必须是客户端组件
 
export default function GlobalError({
  error,
  reset,
}: {
  error: Error & { digest?: string }
  reset: () => void
}) {
  return (
    // global-error 必须包含 html 和 body 标签
    <html>
      <body>
        <h2>出错了!</h2>
        <button onClick={() => reset()}>重试</button>
      </body>
    </html>
  )
}