前端一直是距离用户最近的一层,随着产品的日益完善,我们会更加注重用户体验,而前端异常却如鲠在喉,甚是烦人。
一、为什么要处理异常?
异常是不可控的,会影响最终的呈现结果,但是我们有充分的理由去做这样的事情。
- 增强用户体验;
- 远程定位问题;
- 未雨绸缪,及早发现问题;
- 无法复线问题,尤其是移动端,机型,系统都是问题;
- 完善的前端方案,前端监控系统;
对于 JS 而言,我们面对的仅仅只是异常,异常的出现不会直接导致 JS 引擎崩溃,最多只会使当前执行的任务终止。
二、需要处理哪些异常?
对于前端来说,我们可做的异常捕获还真不少。总结一下,大概如下:
- JS 语法错误、代码异常
- AJAX 请求异常
- 静态资源加载异常
- Promise 异常
- Iframe 异常
- 跨域 Script error
- 崩溃和卡顿
下面我会针对每种具体情况来说明如何处理这些异常。
三、Try-Catch 的误区
try-catch 只能捕获到同步的运行时错误,对语法和异步错误却无能为力,捕获不到。
1. 同步运行时错误:
![ec9fc0e623febc11021fe382e4b80bde.png](https://i-blog.csdnimg.cn/blog_migrate/5070b6bbcc089090266da8f244020d76.jpeg)
输出:
![6991e163af21ae96943aeb001b0a4bbe.png](https://i-blog.csdnimg.cn/blog_migrate/78793784f150bfcb4947c03da631203e.jpeg)
2. 不能捕获到语法错误,我们修改一下代码,删掉一个单引号
![ee33a4f8440bdfbd29e815d5a99703f2.png](https://i-blog.csdnimg.cn/blog_migrate/b469cc1ae77215b10a3ff60a2e3d2244.jpeg)
输出:
![bd635493e5f060581b5f07b12ba782d5.png](https://i-blog.csdnimg.cn/blog_migrate/47e79380508141adcaef644e084ed94d.jpeg)
不过语法错误在我们开发阶段就可以看到,应该不会顺利上到线上环境。
3.异步错误:
![d331fa7ab73b5321ff2704f43eb40d72.png](https://i-blog.csdnimg.cn/blog_migrate/102bed62ee23cd964ed05dfce427a98d.jpeg)
可以看看日志:
![6c59e0fa69986fd9458fc12a48a310fb.png](https://i-blog.csdnimg.cn/blog_migrate/36fbfe2c9495941af1826a739791d015.jpeg)
并没有捕获到异常,这是需要我们特别注意的地方。
4. window.onerror 不是万能的
当 JS 运行时错误发生时,window 会触发一个 ErrorEvent 接口的 error 事件,并执行 window.onerror()。
![cc536a59b6e2de449d05280b3e13273c.png](https://i-blog.csdnimg.cn/blog_migrate/9efd3049c8debda3f07c119f72452af9.jpeg)
首先试试同步运行时错误
![30fd7b3d9967a88282c7c1ef784763a8.png](https://i-blog.csdnimg.cn/blog_migrate/ed322008b4f3530cfa36cdb897bf7d1b.jpeg)
可以看到,我们捕获到了异常:
![2032a48b30e52b31b9a4c102745f8aa1.png](https://i-blog.csdnimg.cn/blog_migrate/8fe2ee184c608a0b048d8cf7f1865a7b.jpeg)
再试试语法错误呢?
![02f38ed4909669621402f9006a546dc0.png](https://i-blog.csdnimg.cn/blog_migrate/7e41f0b52b6fa2108993ee89024b09f5.jpeg)
控制台打印出了这样的异常:
![5032e1c4bc3a0a931981114cfa01f7a5.png](https://i-blog.csdnimg.cn/blog_migrate/033da878d21c2f8a24354b39bfb7576f.jpeg)
竟然没有捕获到语法错误?
怀着忐忑的心,我们最后来试试异步运行时错误:
![8151a62eec7eedd6891021bd7ca353b9.png](https://i-blog.csdnimg.cn/blog_migrate/a8ebbf9de98dd14ae4578a871f0fd878.jpeg)
控制台输出了:
![08efb9ba2dad86b5614c5efaa157e12d.png](https://i-blog.csdnimg.cn/blog_migrate/02e5bc8a613ed713510ac49dbd48d6f1.jpeg)
接着,我们试试网络请求异常的情况:
![e0afa18716510f2b301a2cf2892397f1.png](https://i-blog.csdnimg.cn/blog_migrate/40cc3c654cf37d4b0c477c761f60059b.jpeg)
我们发现,不论是静态资源异常,或者接口异常,错误都无法捕获到。
补充一点:window.onerror 函数只有在返回 true 的时候,异常才不会向上抛出,否则即使是知道异常的发生控制台还是会显示 Uncaught Error: xxxxx
![b60f3425905269d4960845e7352db87c.png](https://i-blog.csdnimg.cn/blog_migrate/ebaa94e9b455ad298cb0d18c7d7fc54f.jpeg)
控制台就不会再有这样的错误了:
![c35c49cb541aa9c73e922284c5022650.png](https://i-blog.csdnimg.cn/blog_migrate/fb5db47c5eb589dfb9f66e363b5df538.jpeg)
需要注意:
- onerror 最好写在所有 JS 脚本的前面,否则有可能捕获不到错误;
- onerror 无法捕获语法错误;
到这里基本就清晰了:在实际的使用过程中,onerror 主要是来捕获预料之外的错误,而 try-catch 则是用来在可预见情况下监控特定的错误,两者结合使用更加高效。
问题又来了,捕获不到静态资源加载异常怎么办?
window.addEventListener
当一项资源(如图片或脚本)加载失败,加载资源的元素会触发一个 Event 接口的 error 事件,并执行该元素上的 onerror() 处理函数。这些 error 事件不会向上冒泡到 window ,不过(至少在 Firefox 中)能被单一的 window.addEventListener 捕获。
![7f4e34f4f057ad78816e65a33608f736.png](https://i-blog.csdnimg.cn/blog_migrate/3e10caabb31ff26c86959ad25b80aa98.jpeg)
控制台输出:
![e100dcc2b9842d5ac295eedc96d0d64e.png](https://i-blog.csdnimg.cn/blog_migrate/b089235870a34b6456d21d9c926c3c1c.jpeg)
由于网络请求异常不会事件冒泡,因此必须在捕获阶段将其捕捉到才行,但是这种方式虽然可以捕捉到网络请求的异常,但是无法判断 HTTP 的状态是 404 还是其他比如 500 等等,所以还需要配合服务端日志才进行排查分析才可以。
需要注意:
- 不同浏览器下返回的 error 对象可能不同,需要注意兼容处理。
- 需要注意避免 addEventListener 重复监听。
二、Promise Catch
在 promise 中使用 catch 可以非常方便的捕获到异步 error ,这个很简单。没有写 catch 的 Promise 中抛出的错误无法被 onerror 或 try-catch 捕获到,所以我们务必要在 Promise 中不要忘记写 catch 处理抛出的异常。
解决方案:为了防止有漏掉的 Promise 异常,建议在全局增加一个对 unhandledrejection 的监听,用来全局监听Uncaught Promise Error。使用方式:
![b24868b64afaa876c7870f29d2b80442.png](https://i-blog.csdnimg.cn/blog_migrate/d6c277249d39dd2faf37d3d9ab1dd6fc.jpeg)
我们继续来尝试一下:
![eba320d2128c7b90d4b855a2399f55f4.png](https://i-blog.csdnimg.cn/blog_migrate/1da0bde1d7ac3beff7728de506b796eb.jpeg)
那如果对 Promise 不进行 catch 呢?
![57e70bc248fbf3c4ca7246e1c3ac528e.png](https://i-blog.csdnimg.cn/blog_migrate/39d589393d4a4921ad58d75067013ee8.jpeg)
嗯,事实证明,也是会被正常捕获到的。
所以,正如我们上面所说,为了防止有漏掉的 Promise 异常,建议在全局增加一个对 unhandledrejection 的监听,用来全局监听 Uncaught Promise Error。
补充一点:如果去掉控制台的异常显示,需要加上:
![fbacce84fa54db668c8330af3d4bdf20.png](https://i-blog.csdnimg.cn/blog_migrate/88ed7217819d37a0452524c7ee73cbbe.jpeg)
三、VUE errorHandler
![db4ab8f810ba4e1c5196cd8b143077f9.png](https://i-blog.csdnimg.cn/blog_migrate/a0d22d19ba81a12a3f972c6d8c47a69b.jpeg)
四、React 异常捕获
React 16 提供了一个内置函数 componentDidCatch,使用它可以非常简单的获取到 react 下的错误信息。
![3b7bfa49371a4d6943ea8cb0edcfeddc.png](https://i-blog.csdnimg.cn/blog_migrate/b6da6d46e458cef0200be511253c09a5.jpeg)
UI 的某部分引起的 JS 错误不应该破坏整个程序,为了帮 React 的使用者解决这个问题,React 16 介绍了一种关于错误边界(error boundary)的新观念。
需要注意的是:error boundaries 并不会捕捉下面这些错误。
- 事件处理器
- 异步代码
- 服务端的渲染代码
- 在 error boundaries 区域内的错误
我们来举一个小例子,在下面这个 componentDIdCatch(error,info) 里的类会变成一个 error boundary:
![60ac43dba70bdbe7d9d0c8e523f034a3.png](https://i-blog.csdnimg.cn/blog_migrate/13b21e7657c89ab1e55cdd652ca8a968.jpeg)
然后我们像使用普通组件那样使用它:
![d755822bdbb696fe61e78946eb508222.png](https://i-blog.csdnimg.cn/blog_migrate/35a002302c3c105bd7c3ff6845756c10.jpeg)
componentDidCatch() 方法像 JS 的 catch{} 模块一样工作,但是对于组件,只有 class 类型的组件(class component )可以成为一个 error boundaries 。
实际上,大多数情况下我们可以在整个程序中定义一个 error boundary 组件,之后就可以一直使用它了!
五、iframe 异常
对于 iframe 的异常捕获,我们还得借力 window.onerror:
![148740b615c13464ca1fbf2aff2c3cbb.png](https://i-blog.csdnimg.cn/blog_migrate/1febd0339912dcb5b27c61c4c35e738c.jpeg)
一个简单的例子可能如下:
![f8a67175356be80c6124f43308b20ab8.png](https://i-blog.csdnimg.cn/blog_migrate/4cbcb5e445c0472a9e80f10575dafe7b.jpeg)
六、Script error
一般情况,如果出现 Script error 这样的错误,基本上可以确定是出现了跨域问题。这时候,是不会有其他太多辅助信息的,但是解决思路无非如下:
跨源资源共享机制( CORS ):我们为 script 标签添加 crossOrigin 属性。
![014e6e703941d768bc0965ca8957b554.png](https://i-blog.csdnimg.cn/blog_migrate/c49afd0b4bca187a82388920840787d1.jpeg)
或者动态去添加 js 脚本:
![586a9e52d6af5f0fda97bb90fa659f93.png](https://i-blog.csdnimg.cn/blog_migrate/959ecbeae33f33d7e142bdd27d86ed80.jpeg)
特别注意,服务器端需要设置:Access-Control-Allow-Origin
此外,我们也可以试试这个-解决 Script Error 的另类思路:
![31b733ab99da74c35f012747e2f82e9f.png](https://i-blog.csdnimg.cn/blog_migrate/2970ce722f69d5f71b909c8cf127a993.jpeg)
简单解释一下:
改写了 EventTarget 的 addEventListener 方法;
对传入的 listener 进行包装,返回包装过的 listener,对其执行进行 try-catch;
浏览器不会对 try-catch 起来的异常进行跨域拦截,所以 catch 到的时候,是有堆栈信息的;
重新 throw 出来异常的时候,执行的是同域代码,所以 window.onerror 捕获的时候不会丢失堆栈信息;
利用包装 addEventListener,我们还可以达到「扩展堆栈」的效果:
![cb7e36d9d3812c8ea239866d3d3c277b.png](https://i-blog.csdnimg.cn/blog_migrate/33411bef14559eb5d7eb8a63eb213c88.jpeg)
七、崩溃和卡顿
卡顿也就是网页暂时响应比较慢, JS 可能无法及时执行。但崩溃就不一样了,网页都崩溃了,JS 都不运行了,还有什么办法可以监控网页的崩溃,并将网页崩溃上报呢?
崩溃和卡顿也是不可忽视的,也许会导致你的用户流失。
利用 window 对象的 load 和 beforeunload 事件实现了网页崩溃的监控。
![0b95c479277298545e11b1c55136bf3d.png](https://i-blog.csdnimg.cn/blog_migrate/be2a3ab1da868b04b6bec610c58c908d.jpeg)
基于以下原因,我们可以使用 Service Worker 来实现网页崩溃的监控:
- Service Worker 有自己独立的工作线程,与网页区分开,网页崩溃了,Service Worker 一般情况下不会崩溃;
- Service Worker 生命周期一般要比网页还要长,可以用来监控网页的状态;
- 网页可以通过 navigator.serviceWorker.controller.postMessage API 向掌管自己的 SW 发送消息。
八、错误上报
1. 通过 Ajax 发送数据:
因为 Ajax 请求本身也有可能会发生异常,而且有可能会引发跨域问题,一般情况下更推荐使用动态创建 img 标签的形式进行上报。
2.动态创建 img 标签的形式:
![d76f03940b517f97a82e4ad7da8386ea.png](https://i-blog.csdnimg.cn/blog_migrate/d8994e03a5f304fb6d2a3d06cecd8084.jpeg)
收集异常信息量太多,怎么办?实际中,我们不得不考虑这样一种情况:如果你的网站访问量很大,那么一个必然的错误发送的信息就有很多条,这时候,我们需要设置采集率,从而减缓服务器的压力:
![016431f596d8b82ddba930cf5d3e95e0.png](https://i-blog.csdnimg.cn/blog_migrate/1215f225341ac2b9a720077870aa0317.jpeg)
采集率应该通过实际情况来设定,随机数,或者某些用户特征都是不错的选择。
九、总结
回到我们开头提出的那个问题,如何优雅的处理异常呢?
- 可疑区域增加 Try-Catch
- 全局监控 JS 异常 window.onerror
- 全局监控静态资源异常 window.addEventListener
- 捕获没有 Catch 的 Promise 异常:unhandledrejection
- VUE errorHandler 和 React componentDidCatch
- 监控网页崩溃:window 对象的 load 和 beforeunload
- 跨域 crossOrigin 解决
其实很简单,采用组合方案,分类型的去捕获异常,这样基本 80%-90% 的问题都化于无形。
作者:coding小姐姐原文链接:https://segmentfault.com/a/1190000018754274