错误处理

Nuxt 是一个全栈框架，这意味着在不同上下文中可能会发生多种不可避免的用户运行时错误：

• Vue 渲染生命周期中的错误（SSR 和 CSR）
• 服务器和客户端启动错误（SSR + CSR）
• Nitro 服务器生命周期中的错误（server/ 目录）
• 下载 JS 块时的错误

Vue 错误

你可以使用 onErrorCaptured 钩子捕获 Vue 错误。

此外，Nuxt 提供了一个 vue:error 钩子，当任何错误传播到顶层时会被调用。

如果你使用的是错误报告框架，可以通过 vueApp.config.errorHandler 提供一个全局处理程序。它将接收所有 Vue 错误，即使这些错误已被处理。

export default defineNuxtPlugin((nuxtApp) => {
  nuxtApp.vueApp.config.errorHandler = (error, instance, info) => {
    // 处理错误，例如报告给服务
  }

  // 也可以这样做
  nuxtApp.hook('vue:error', (error, instance, info) => {
    // 处理错误，例如报告给服务
  })
})

启动错误

如果 Nuxt 应用启动时发生任何错误，Nuxt 将调用 app:error 钩子。

这包括：

• 运行 Nuxt 插件
• 处理 app:created 和 app:beforeMount 钩子
• 将 Vue 应用渲染为 HTML（在 SSR 期间）
• 挂载应用（在客户端），不过这种情况应通过 onErrorCaptured 或 vue:error 处理
• 处理 app:mounted 钩子

Nitro 服务器错误

目前无法为这些错误定义服务器端处理程序，但可以渲染一个错误页面，参见 渲染错误页面 部分。

JS 块错误

由于网络连接失败或新部署（导致旧的哈希 JS 块 URL 失效），你可能会遇到块加载错误。Nuxt 提供内置支持，通过在路由导航期间块加载失败时执行硬重载来处理这些错误。

你可以通过将 experimental.emitRouteChunkError 设置为 false（完全禁用对此类错误的钩子）或 manual（如果你想自己处理）来更改此行为。如果你想手动处理块加载错误，可以参考 自动实现 获取灵感。

错误页面

错误可能在以下服务器生命周期中发生：

• 处理 Nuxt 插件
• 将 Vue 应用渲染为 HTML
• 服务器 API 路由抛出错误

也可能在客户端发生：

• 处理 Nuxt 插件
• 在挂载应用之前（app:beforeMount 钩子）
• 如果错误未通过 onErrorCaptured 或 vue:error 钩子处理，则在挂载应用时
• Vue 应用在浏览器中初始化并挂载（app:mounted）。

通过在应用源目录中添加 ~/error.vue（与 app.vue 同级）来自定义默认错误页面。

<script setup lang="ts">
import type { NuxtError } from '#app'

const props = defineProps({
  error: Object as () => NuxtError
})

const handleError = () => clearError({ redirect: '/' })
</script>

<template>
  <div>
    <h2>{{ error.statusCode }}</h2>
    <button @click="handleError">清除错误</button>
  </div>
</template>

对于自定义错误，我们强烈建议使用可在页面/组件 setup 函数中调用的 onErrorCaptured 组合式函数，或在 Nuxt 插件中配置的 vue:error 运行时钩子。

export default defineNuxtPlugin(nuxtApp => {
  nuxtApp.hook('vue:error', (err) => {
    //
  })
})

当你准备移除错误页面时，可以调用 clearError 辅助函数，它接受一个可选的重定向路径（例如，如果你想导航到“安全”页面）。

错误工具

useError

function useError (): Ref<Error | { url, statusCode, statusMessage, message, description, data }>

此函数将返回正在处理的全局 Nuxt 错误。

createError

function createError (err: string | { cause, data, message, name, stack, statusCode, statusMessage, fatal }): Error

创建带有额外元数据的错误对象。你可以传递一个字符串作为错误 message，或传递一个包含错误属性的对象。它可在应用的 Vue 和服务器部分使用，并应被抛出。

如果你抛出使用 createError 创建的错误：

• 在服务器端，它将触发全屏错误页面，你可以使用 clearError 清除。
• 在客户端，它将抛出非致命错误供你处理。如果需要触发全屏错误页面，可以通过设置 fatal: true 实现。

<script setup lang="ts">
const route = useRoute()
const { data } = await useFetch(`/api/movies/${route.params.slug}`)

if (!data.value) {
  throw createError({
    statusCode: 404,
    statusMessage: '页面未找到'
  })
}
</script>

showError

function showError (err: string | Error | { statusCode, statusMessage }): Error

你可以在客户端的任何时候调用此函数，或者在服务器端的中间件、插件或 setup() 函数中直接调用。它将触发全屏错误页面，你可以使用 clearError 清除。

建议使用 throw createError() 代替。

clearError

function clearError (options?: { redirect?: string }): Promise<void>

此函数将清除当前处理的 Nuxt 错误。它还接受一个可选的重定向路径（例如，如果你想导航到“安全”页面）。

在组件中渲染错误

Nuxt 还提供了 <NuxtErrorBoundary> 组件，允许你在应用中处理客户端错误，而无需用错误页面替换整个站点。

此组件负责处理其默认插槽中发生的错误。在客户端，它将阻止错误冒泡到顶层，并渲染 #error 插槽。

#error 插槽将接收 error 作为 prop。（如果你将 error = null，它将触发重新渲染默认插槽；你需要确保错误已完全解决，否则错误插槽将再次渲染。）

<template>
  <!-- 一些内容 -->
  <NuxtErrorBoundary @error="someErrorLogger">
    <!-- 使用默认插槽渲染你的内容 -->
    <template #error="{ error, clearError }">
      你可以在这里本地显示错误：{{ error }}
      <button @click="clearError">
        这将清除错误。
      </button>
    </template>
  </NuxtErrorBoundary>
</template>