Skip to main content

错误处理

错误可以分为两类：预期错误和未捕获的异常。本页将指导你如何在 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 界面。

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 使用错误边界来处理未捕获的异常。错误边界捕获其子组件中的错误，并显示备用界面而不是崩溃的组件树。

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

app/dashboard/error.tsx
'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 文件来进行细粒度的错误处理。

嵌套错误组件层次结构嵌套错误组件层次结构

错误边界不会捕获事件处理器内的错误。它们被设计为捕获渲染期间的错误，以显示备用界面而不是崩溃整个应用程序。

通常，事件处理器或异步代码中的错误不会被错误边界处理，因为它们是在渲染之后运行的。

要处理这些情况，手动捕获错误并使用 useState 或 useReducer 存储它，然后更新界面以通知用户。

'use client'

import { useState } from 'react'

export function Button() {
  const [error, setError] = useState(null)

  const handleClick = () => {
    try {
      // 执行可能失败的工作
      throw new Error('Exception')
    } catch (reason) {
      setError(reason)
    }
  }

  if (error) {
    /* 渲染备用界面 */
  }

  return (
    <button type="button" onClick={handleClick}>
      Click me
    </button>
  )
}

请注意，来自 useTransition 的 startTransition 内未处理的错误会冒泡到最近的错误边界。

'use client'

import { useTransition } from 'react'

export function Button() {
  const [pending, startTransition] = useTransition()

  const handleClick = () =>
    startTransition(() => {
      throw new Error('Exception')
    })

  return (
    <button type="button" onClick={handleClick}>
      Click me
    </button>
  )
}

全局错误​

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

app/global-error.tsx
'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>
  )
}
Last updated on