错误处理
了解如何在 Nuxt 中捕获和处理错误。
Nuxt 3 是一个全栈框架，这意味着在不同的上下文中可能会发生几种无法预防的用户运行时错误。
- 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) => {
// 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:created和app:beforeMount钩子 - 将您的 Vue 应用程序渲染到 HTML（在 SSR 期间）
- 挂载应用程序（在客户端），尽管您应该使用
onErrorCaptured或vue:error处理这种情况 - 处理
app:mounted钩子
Nitro 服务器错误
您目前无法为这些错误定义服务器端处理程序，但可以渲染错误页面，请参阅 渲染错误页面 部分。
JS 块错误
您可能会遇到由于网络连接故障或新部署（使您的旧哈希 JS 块 URL 无效）导致的块加载错误。Nuxt 提供内置支持，通过在路由导航期间块加载失败时执行硬重载来处理块加载错误。
您可以通过将 experimental.emitRouteChunkError 设置为 false（完全禁用挂钩到这些错误）或设置为 manual 来更改此行为，如果您想自己处理它们。如果您想手动处理块加载错误，可以查看 自动实现 以获取想法。
错误页面
fatal: true 创建的错误）时，它将要么渲染 JSON 响应（如果使用 Accept: application/json 标头请求），要么触发全屏错误页面。在服务器生命周期中，可能会在以下情况下发生错误
- 处理您的 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">Clear errors</button>
</div>
</template>
对于自定义错误，我们强烈建议使用 onErrorCaptured 可组合函数，该函数可以在页面/组件设置函数中调用，或者使用 vue:error 运行时 Nuxt 钩子，该钩子可以在 Nuxt 插件中配置。
export default defineNuxtPlugin(nuxtApp => {
nuxtApp.hook('vue:error', (err) => {
//
})
})
当您准备好删除错误页面时，您可以调用 clearError 辅助函数，该函数接受一个可选的重定向路径（例如，如果您想导航到一个“安全”页面）。
$route 或 useRouter）之前，请务必检查，因为如果插件抛出错误，则在您清除错误之前它不会重新运行。错误实用程序
useError
function useError (): Ref<Error | { url, statusCode, statusMessage, message, description, data }>
此函数将返回正在处理的全局 Nuxt 错误。
createError
function createError (err: { cause, data, message, name, stack, statusCode, statusMessage, fatal }): Error
创建一个带有额外元数据的错误对象。它可以在应用程序的 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: 'Page Not Found'
})
}
</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>
<!-- 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>