错误处理

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>

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

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 作为一个显示属性。（如果您设置 error = null，将触发默认插槽的重新渲染；您需要确保错误已完全解决，否则错误插槽将再次被渲染。）

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