Nuxt Nation 大会即将到来。加入我们,时间为 11 月 12 日至 13 日。

错误处理

了解如何在 Nuxt 中捕获和处理错误。

Nuxt 是一个全栈框架,这意味着在不同的上下文中可能会发生一些无法避免的用户运行时错误。

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

Vue 错误

您可以使用 onErrorCaptured 钩入 Vue 错误。

此外,Nuxt 提供了一个 vue:error 钩子,如果任何错误传播到顶级,则会调用该钩子。

如果您使用的是错误报告框架,则可以通过 vueApp.config.errorHandler 提供全局处理程序。它将接收所有 Vue 错误,即使它们已处理。

plugins/error-handler.ts
export default 
defineNuxtPlugin
((
nuxtApp
) => {
nuxtApp
.
vueApp
.
config
.
errorHandler
= (
error
,
instance
,
info
) => {
// handle error, e.g. report to a service } // Also possible
nuxtApp
.
hook
('vue:error', (
error
,
instance
,
info
) => {
// handle error, e.g. report to a service }) })
请注意,vue:error 钩子基于 onErrorCaptured 生命周期钩子。

启动错误

如果在启动 Nuxt 应用程序时出现任何错误,Nuxt 将调用 app:error 钩子。

这包括

  • 运行 Nuxt 插件
  • 处理 app:createdapp:beforeMount 钩子
  • 将 Vue 应用程序渲染到 HTML(在 SSR 期间)
  • 挂载应用程序(在客户端),尽管您应该使用 onErrorCapturedvue:error 处理这种情况
  • 处理 app:mounted 钩子

Nitro 服务器错误

您目前无法为这些错误定义服务器端处理程序,但可以渲染错误页面,请参阅 渲染错误页面 部分。

JS 代码块错误

由于网络连接故障或新部署(使旧的、哈希化的 JS 代码块 URL 无效),您可能会遇到代码块加载错误。Nuxt 通过在路由导航期间代码块加载失败时执行硬刷新来提供处理代码块加载错误的内置支持。

您可以通过将 experimental.emitRouteChunkError 设置为 false(完全禁用挂钩到这些错误)或 manual(如果您想自己处理它们)来更改此行为。如果您想手动处理代码块加载错误,可以查看 自动实现 以获取思路。

错误页面

当 Nuxt 遇到致命错误(服务器上的任何未处理错误,或在客户端上使用 fatal: true 创建的错误)时,它将要么渲染 JSON 响应(如果使用 Accept: application/json 标头请求),要么触发全屏错误页面。

服务器生命周期中可能会发生错误,例如

  • 处理您的 Nuxt 插件
  • 将您的 Vue 应用程序渲染到 HTML
  • 服务器 API 路由抛出错误

它也可能在客户端发生,例如

  • 处理您的 Nuxt 插件
  • 挂载应用程序之前(app:beforeMount 钩子)
  • 挂载您的应用程序,如果错误未由 onErrorCapturedvue:error 钩子处理
  • Vue 应用程序在浏览器中初始化并挂载(app:mounted)。
了解所有 Nuxt 生命周期钩子。

通过在应用程序的源目录中添加 ~/error.vue(与 app.vue 并排)来自定义默认错误页面。

error.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">Clear errors</button>
  </div>
</template>
阅读有关 error.vue 及其用法的更多信息。

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

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

当您准备好删除错误页面时,您可以调用 clearError 帮助器函数,该函数接受一个可选的重定向路径(例如,如果您想导航到“安全”页面)。

在使用任何依赖于 Nuxt 插件的内容(例如 $routeuseRouter)之前,请确保进行检查,因为如果插件抛出错误,则在您清除错误之前不会重新运行它。
渲染错误页面是一个完全独立的页面加载,这意味着任何已注册的中介软件都将再次运行。您可以在中介软件中使用 useError 检查是否正在处理错误。
如果您在 Node 16 上运行并在渲染错误页面时设置了任何 Cookie,它们将 覆盖先前设置的 Cookie。我们建议使用更新版本的 Node,因为 Node 16 于 2023 年 9 月达到生命周期结束。

错误实用程序

useError

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

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

阅读有关 useError 组合式 API 的更多信息。

createError

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

创建一个包含附加元数据的错误对象。您可以传递一个字符串将其设置为错误 message 或包含错误属性的对象。它可在应用程序的 Vue 和服务器部分使用,并旨在抛出。

如果您使用 createError 抛出错误

  • 在服务器端,它将触发一个全屏错误页面,您可以使用 clearError 清除它。
  • 在客户端,它将抛出一个非致命错误供您处理。如果您需要触发全屏错误页面,则可以通过设置 fatal: true 来实现。
pages/movies/[slug].vue
<script setup lang="ts">
const 
route
=
useRoute
()
const {
data
} = await
useFetch
(`/api/movies/${
route
.
params
.
slug
}`)
if (!
data
.
value
) {
throw
createError
({
statusCode
: 404,
statusMessage
: 'Page Not Found'
}) } </script>
阅读有关 createError 实用程序的更多信息。

showError

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

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

建议改为使用 throw createError()

阅读有关 showError 实用程序的更多信息。

clearError

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

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

阅读有关 clearError 实用程序的更多信息。

在组件中渲染错误

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

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

#error 插槽将接收 error 作为道具。(如果您将 error 设置为 null,它将触发重新渲染默认插槽;您需要确保首先完全解决错误,否则错误插槽将再次渲染。)

如果您导航到另一个路由,错误将自动清除。
pages/index.vue
<template>
  <!-- some content -->
  <NuxtErrorBoundary @error="someErrorLogger">
    <!-- You use the default slot to render your content -->
    <template #error="{ error, clearError }">
      You can display the error locally here: {{ error }}
      <button @click="clearError">
        This will clear the error.
      </button>
    </template>
  </NuxtErrorBoundary>
</template>
文档 > 示例 > 高级 > 错误处理 中阅读和编辑实时示例。