问答题1352/1593你是怎么处理vue项目中的错误的?

难度:
2021-07-04 创建

参考答案:

一、错误类型

任何一个框架,对于错误的处理都是一种必备的能力

Vue 中,则是定义了一套对应的错误处理规则给到使用者,且在源代码级别,对部分必要的过程做了一定的错误处理。

主要的错误来源包括:

  • 后端接口错误
  • 代码中本身逻辑错误

二、如何处理

后端接口错误

通过axiosinterceptor实现网络请求的response先进行一层拦截

1apiClient.interceptors.response.use( 2 response => { 3 return response; 4 }, 5 error => { 6 if (error.response.status == 401) { 7 router.push({ name: "Login" }); 8 } else { 9 message.error("出错了"); 10 return Promise.reject(error); 11 } 12 } 13);

代码逻辑问题

全局设置错误处理

设置全局错误处理函数

1Vue.config.errorHandler = function (err, vm, info) { 2 // handle error 3 // `info` 是 Vue 特定的错误信息,比如错误所在的生命周期钩子 4 // 只在 2.2.0+ 可用 5}

errorHandler指定组件的渲染和观察期间未捕获错误的处理函数。这个处理函数被调用时,可获取错误信息和 Vue 实例

不过值得注意的是,在不同 Vue 版本中,该全局 API 作用的范围会有所不同:

从 2.2.0 起,这个钩子也会捕获组件生命周期钩子里的错误。同样的,当这个钩子是 undefined 时,被捕获的错误会通过 console.error 输出而避免应用崩

从 2.4.0 起,这个钩子也会捕获 Vue 自定义事件处理函数内部的错误了

从 2.6.0 起,这个钩子也会捕获 v-on DOM 监听器内部抛出的错误。另外,如果任何被覆盖的钩子或处理函数返回一个 Promise 链 (例如 async 函数),则来自其 Promise 链的错误也会被处理

生命周期钩子

errorCaptured是 2.5.0 新增的一个生命钩子函数,当捕获到一个来自子孙组件的错误时被调用

基本类型

1(err: Error, vm: Component, info: string) => ?boolean

此钩子会收到三个参数:错误对象、发生错误的组件实例以及一个包含错误来源信息的字符串。此钩子可以返回 false 以阻止该错误继续向上传播

参考官网,错误传播规则如下:

  • 默认情况下,如果全局的 config.errorHandler 被定义,所有的错误仍会发送它,因此这些错误仍然会向单一的分析服务的地方进行汇报
  • 如果一个组件的继承或父级从属链路中存在多个 errorCaptured 钩子,则它们将会被相同的错误逐个唤起。
  • 如果此 errorCaptured 钩子自身抛出了一个错误,则这个新错误和原本被捕获的错误都会发送给全局的 config.errorHandler
  • 一个 errorCaptured 钩子能够返回 false 以阻止错误继续向上传播。本质上是说“这个错误已经被搞定了且应该被忽略”。它会阻止其它任何会被这个错误唤起的 errorCaptured 钩子和全局的 config.errorHandler

下面来看个例子

定义一个父组件cat

1Vue.component('cat', { 2 template:` 3 <div> 4 <h1>Cat: </h1> 5 <slot></slot> 6 </div>`, 7 props:{ 8 name:{ 9 required:true, 10 type:String 11 } 12 }, 13 errorCaptured(err,vm,info) { 14 console.log(`cat EC: ${err.toString()}\ninfo: ${info}`); 15 return false; 16 } 17 18});

定义一个子组件kitten,其中dontexist()并没有定义,存在错误

1Vue.component('kitten', { 2 template:'<div><h1>Kitten: {{ dontexist() }}</h1></div>', 3 props:{ 4 name:{ 5 required:true, 6 type:String 7 } 8 } 9});

页面中使用组件

1<div id="app" v-cloak> 2 <cat name="my cat"> 3 <kitten></kitten> 4 </cat> 5</div>

在父组件的errorCaptured则能够捕获到信息

1cat EC: TypeError: dontexist is not a function 2info: render

三、源码分析

异常处理源码

源码位置:/src/core/util/error.js

1// Vue 全局配置,也就是上面的Vue.config 2import config from '../config' 3import { warn } from './debug' 4// 判断环境 5import { inBrowser, inWeex } from './env' 6// 判断是否是Promise,通过val.then === 'function' && val.catch === 'function', val !=== null && val !== undefined 7import { isPromise } from 'shared/util' 8// 当错误函数处理错误时,停用deps跟踪以避免可能出现的infinite rendering 9// 解决以下出现的问题https://github.com/vuejs/vuex/issues/1505的问题 10import { pushTarget, popTarget } from '../observer/dep' 11 12export function handleError (err: Error, vm: any, info: string) { 13 // Deactivate deps tracking while processing error handler to avoid possible infinite rendering. 14 pushTarget() 15 try { 16 // vm指当前报错的组件实例 17 if (vm) { 18 let cur = vm 19 // 首先获取到报错的组件,之后递归查找当前组件的父组件,依次调用errorCaptured 方法。 20 // 在遍历调用完所有 errorCaptured 方法、或 errorCaptured 方法有报错时,调用 globalHandleError 方法 21 while ((cur = cur.$parent)) { 22 const hooks = cur.$options.errorCaptured 23 // 判断是否存在errorCaptured钩子函数 24 if (hooks) { 25 // 选项合并的策略,钩子函数会被保存在一个数组中 26 for (let i = 0; i < hooks.length; i++) { 27 // 如果errorCaptured 钩子执行自身抛出了错误, 28 // 则用try{}catch{}捕获错误,将这个新错误和原本被捕获的错误都会发送给全局的config.errorHandler 29 // 调用globalHandleError方法 30 try { 31 // 当前errorCaptured执行,根据返回是否是false值 32 // 是false,capture = true,阻止其它任何会被这个错误唤起的 errorCaptured 钩子和全局的 config.errorHandler 33 // 是true capture = fale,组件的继承或父级从属链路中存在的多个 errorCaptured 钩子,会被相同的错误逐个唤起 34 // 调用对应的钩子函数,处理错误 35 const capture = hooks[i].call(cur, err, vm, info) === false 36 if (capture) return 37 } catch (e) { 38 globalHandleError(e, cur, 'errorCaptured hook') 39 } 40 } 41 } 42 } 43 } 44 // 除非禁止错误向上传播,否则都会调用全局的错误处理函数 45 globalHandleError(err, vm, info) 46 } finally { 47 popTarget() 48 } 49} 50// 异步错误处理函数 51export function invokeWithErrorHandling ( 52handler: Function, 53 context: any, 54 args: null | any[], 55 vm: any, 56 info: string 57 ) { 58 let res 59 try { 60 // 根据参数选择不同的handle执行方式 61 res = args ? handler.apply(context, args) : handler.call(context) 62 // handle返回结果存在 63 // res._isVue an flag to avoid this being observed,如果传入值的_isVue为ture时(即传入的值是Vue实例本身)不会新建observer实例 64 // isPromise(res) 判断val.then === 'function' && val.catch === 'function', val !=== null && val !== undefined 65 // !res._handled _handle是Promise 实例的内部变量之一,默认是false,代表onFulfilled,onRejected是否被处理 66 if (res && !res._isVue && isPromise(res) && !res._handled) { 67 res.catch(e => handleError(e, vm, info + ` (Promise/async)`)) 68 // avoid catch triggering multiple times when nested calls 69 // 避免嵌套调用时catch多次的触发 70 res._handled = true 71 } 72 } catch (e) { 73 // 处理执行错误 74 handleError(e, vm, info) 75 } 76 return res 77 } 78 79//全局错误处理 80function globalHandleError (err, vm, info) { 81 // 获取全局配置,判断是否设置处理函数,默认undefined 82 // 已配置 83 if (config.errorHandler) { 84 // try{}catch{} 住全局错误处理函数 85 try { 86 // 执行设置的全局错误处理函数,handle error 想干啥就干啥💗 87 return config.errorHandler.call(null, err, vm, info) 88 } catch (e) { 89 // 如果开发者在errorHandler函数中手动抛出同样错误信息throw err 90 // 判断err信息是否相等,避免log两次 91 // 如果抛出新的错误信息throw err Error('你好毒'),将会一起log输出 92 if (e !== err) { 93 logError(e, null, 'config.errorHandler') 94 } 95 } 96 } 97 // 未配置常规log输出 98 logError(err, vm, info) 99} 100 101// 错误输出函数 102function logError (err, vm, info) { 103 if (process.env.NODE_ENV !== 'production') { 104 warn(`Error in ${info}: "${err.toString()}"`, vm) 105 } 106 /* istanbul ignore else */ 107 if ((inBrowser || inWeex) && typeof console !== 'undefined') { 108 console.error(err) 109 } else { 110 throw err 111 } 112}

小结

  • handleError在需要捕获异常的地方调用,首先获取到报错的组件,之后递归查找当前组件的父组件,依次调用errorCaptured 方法,在遍历调用完所有 errorCaptured 方法或 errorCaptured 方法有报错时,调用 globalHandleError 方法
  • globalHandleError 调用全局的 errorHandler 方法,再通过logError判断环境输出错误信息
  • invokeWithErrorHandling更好的处理异步错误信息
  • logError判断环境,选择不同的抛错方式。非生产环境下,调用warn方法处理错误

最近更新时间:2024-08-10

赞赏支持

预览

题库维护不易,您的支持就是我们最大的动力!