BUG!BUG!BUG!前端程序员在面对异常怎么办?这样就so easy

前端一直是距离用户最近的一层,随着产品的日益完善,我们会更加注重用户体验,而前端异常却如鲠在喉,甚是烦人。

一、为什么要处理异常?

异常是不可控的,会影响最终的呈现结果,但是我们有充分的理由去做这样的事情。

1.增强用户体验;

2.远程定位问题;

3.未雨绸缪,及早发现问题;

4.无法复线问题,尤其是移动端,机型,系统都是问题;

5.完善的前端方案,前端监控系统;

对于JS而言,我们面对的仅仅只是异常,异常的出现不会直接导致JS引擎崩溃,最多只会使当前执行的任务终止。

二、需要处理哪些异常?

对于前端来说,我们可做的异常捕获还真不少。总结一下,大概如下:

JS语法错误、代码异常

AJAX请求异常

静态资源加载异常

Promise异常

Iframe异常

跨域 Script error

崩溃和卡顿

下面我会针对每种具体情况来说明如何处理这些异常。

三、Try-Catch 的误区

try-catch只能捕获到同步的运行时错误,对语法和异步错误却无能为力,捕获不到。

1.同步运行时错误:

try {

let name = 'jartto';

console.log(nam);

} catch(e) {

console.log('捕获到异常:',e);

}

输出:

捕获到异常: ReferenceError: nam is not defined

at :3:15

2.不能捕获到语法错误,我们修改一下代码,删掉一个单引号:

try {

let name = 'jartto;

console.log(nam);

} catch(e) {

console.log('捕获到异常:',e);

}

输出:

Uncaught SyntaxError: Invalid or unexpected token

不过语法错误在我们开发阶段就可以看到,应该不会顺利上到线上环境。

3.异步错误

try {

setTimeout(() => {

undefined.map(v => v);

}, 1000)

} catch(e) {

console.log('捕获到异常:',e);

}

我们看看日志:

Uncaught TypeError: Cannot read property 'map' of undefined

at setTimeout (:3:11)

并没有捕获到异常,这是需要我们特别注意的地方。

四、window.onerror 不是万能的

当JS运行时错误发生时,window会触发一个ErrorEvent接口的error事件,并执行window.onerror()。

/**

* @param {String} message 错误信息

* @param {String} source 出错文件

* @param {Number} lineno 行号

* @param {Number} colno 列号

* @param {Object} error Error对象(对象)

*/

window.onerror = function(message, source, lineno, colno, error) {

console.log('捕获到异常:',{message, source, lineno, colno, error});

}

1.首先试试同步运行时错误

window.onerror = function(message, source, lineno, colno, error) {

// message:错误信息(字符串)。

// source:发生错误的脚本URL(字符串)

// lineno:发生错误的行号(数字)

// colno:发生错误的列号(数字)

// error:Error对象(对象)

console.log('捕获到异常:',{message, source, lineno, colno, error});

}

Jartto;

可以看到,我们捕获到了异常:

2.再试试语法错误呢?

window.onerror = function(message, source, lineno, colno, error) {

console.log('捕获到异常:',{message, source, lineno, colno, error});

}

let name = 'Jartto

控制台打印出了这样的异常:

Uncaught SyntaxError: Invalid or unexpected token

什么,竟然没有捕获到语法错误?

3.怀着忐忑的心,我们最后来试试异步运行时错误:

window.onerror = function(message, source, lineno, colno, error) {

console.log('捕获到异常:',{message, source, lineno, colno, error});

}

setTimeout(() => {

Jartto;

});

控制台输出了:

捕获到异常: {message: "Uncaught ReferenceError: Jartto is not defined", source: "http://127.0.0.1:8001/", lineno: 36, colno: 5, error: ReferenceError: Jartto is not defined

at setTimeout (http://127.0.0.1:8001/:36:5)}

4.接着,我们试试网络请求异常的情况:

window.onerror = function(message, source, lineno, colno, error) {

console.log('捕获到异常:',{message, source, lineno, colno, error});

return true;

}


我们发现,不论是静态资源异常,或者接口异常,错误都无法捕获到。

补充一点:window.onerror函数只有在返回true的时候,异常才不会向上抛出,否则即使是知道异常的发生控制台还是会显示Uncaught Error: xxxxx

window.onerror = function(message, source, lineno, colno, error) {

console.log('捕获到异常:',{message, source, lineno, colno, error});

return true;

}

setTimeout(() => {

Jartto;

});

控制台就不会再有这样的错误了:

Uncaught ReferenceError: Jartto is not defined

at setTimeout ((index):36)

需要注意:

onerror最好写在所有JS脚本的前面,否则有可能捕获不到错误;

onerror无法捕获语法错误;

到这里基本就清晰了:在实际的使用过程中,onerror主要是来捕获预料之外的错误,而try-catch则是用来在可预见情况下监控特定的错误,两者结合使用更加高效。

问题又来了,捕获不到静态资源加载异常怎么办?

五、window.addEventListener

当一项资源(如图片或脚本)加载失败,加载资源的元素会触发一个Event接口的error事件,并执行该元素上的onerror()处理函数。这些error事件不会向上冒泡到window,不过(至少在Firefox中)能被单一的window.addEventListener捕获。

window.addEventListener('error', (error) => {

console.log('捕获到异常:', error);

}, true)


控制台输出:

由于网络请求异常不会事件冒泡,因此必须在捕获阶段将其捕捉到才行,但是这种方式虽然可以捕捉到网络请求的异常,但是无法判断HTTP的状态是404还是其他比如500等等,所以还需要配合服务端日志才进行排查分析才可以。

需要注意:

不同浏览器下返回的error对象可能不同,需要注意兼容处理。

需要注意避免addEventListener重复监听。

六、Promise Catch

在promise中使用catch可以非常方便的捕获到异步error,这个很简单。

没有写catch的Promise中抛出的错误无法被onerror或try-catch捕获到,所以我们务必要在Promise中不要忘记写catch处理抛出的异常。

解决方案: 为了防止有漏掉的Promise异常,建议在全局增加一个对unhandledrejection的监听,用来全局监听Uncaught Promise Error。使用方式:

window.addEventListener("unhandledrejection", function(e){

console.log(e);

});

我们继续来尝试一下:

window.addEventListener("unhandledrejection", function(e){

e.preventDefault()

console.log('捕获到异常:', e);

return true;

});

Promise.reject('promise error');

可以看到如下输出:

那如果对Promise不进行catch呢?

window.addEventListener("unhandledrejection", function(e){

e.preventDefault()

console.log('捕获到异常:', e);

return true;

});

new Promise((resolve, reject) => {

reject('jartto: promise error');

});

嗯,事实证明,也是会被正常捕获到的。

所以,正如我们上面所说,为了防止有漏掉的Promise异常,建议在全局增加一个对unhandledrejection的监听,用来全局监听Uncaught Promise Error。

补充一点:如果去掉控制台的异常显示,需要加上:

event.preventDefault();

七、VUE errorHandler

Vue.config.errorHandler = (err, vm, info) => {

console.error('通过vue errorHandler捕获的错误');

console.error(err);

console.error(vm);

console.error(info);

}

八、React 异常捕获

React 16提供了一个内置函数componentDidCatch,使用它可以非常简单的获取到react下的错误信息

componentDidCatch(error, info) {

console.log(error, info);

}

除此之外,我们可以了解一下:error boundary

UI的某部分引起的JS错误不应该破坏整个程序,为了帮React的使用者解决这个问题,React 16介绍了一种关于错误边界(error boundary)的新观念。

需要注意的是: error boundaries 并不会捕捉下面这些错误。

1.事件处理器

2.异步代码

3.服务端的渲染代码

4.在error boundaries区域内的错误

我们来举一个小例子,在下面这个componentDIdCatch(error,info)里的类会变成一个error boundary:

class ErrorBoundary extends React.Component {

constructor(props) {

super(props);

this.state = { hasError: false };

}

componentDidCatch(error, info) {

// Display fallback UI

this.setState({ hasError: true });

// You can also log the error to an error reporting service

logErrorToMyService(error, info);

}

render() {

if (this.state.hasError) {

// You can render any custom fallback UI

return

Something went wrong.

;

}

return this.props.children;

}

}

然后我们像使用普通组件那样使用它:

componentDidCatch()方法像JS的catch{}模块一样工作,但是对于组件,只有class类型的组件(class component)可以成为一个error boundaries。

实际上,大多数情况下我们可以在整个程序中定义一个error boundary组件,之后就可以一直使用它了!

九、iframe 异常

对于iframe的异常捕获,我们还得借力window.onerror:

window.onerror = function(message, source, lineno, colno, error) {

console.log('捕获到异常:',{message, source, lineno, colno, error});

}

一个简单的例子可能如下:

<iframe src="./iframe.html" frameborder="0"></iframe>

<script>

window.frames[0].onerror = function (message, source, lineno, colno, error) {

console.log('捕获到 iframe 异常:',{message, source, lineno, colno, error});

return true;

};

十、Script error

一般情况,如果出现Script error这样的错误,基本上可以确定是出现了跨域问题。这时候,是不会有其他太多辅助信息的,但是解决思路无非如下:

跨源资源共享机制(CORS):我们为script标签添加crossOrigin属性。

<script src="http://jartto.wang/main.js" crossorigin></script>

或者动态去添加js脚本:

const script = document.createElement('script');

script.crossOrigin = 'anonymous';

script.src = url;

document.body.appendChild(script);

特别注意,服务器端需要设置:Access-Control-Allow-Origin

十一、崩溃和卡顿

卡顿也就是网页暂时响应比较慢,JS可能无法及时执行。但崩溃就不一样了,网页都崩溃了,JS都不运行了,还有什么办法可以监控网页的崩溃,并将网页崩溃上报呢?

崩溃和卡顿也是不可忽视的,也许会导致你的用户流失。

1.利用window对象的load和beforeunload事件实现了网页崩溃的监控。

不错的文章,推荐阅读:Logging Information on Browser Crashes

window.addEventListener('load', function () {

sessionStorage.setItem('good_exit', 'pending');

setInterval(function () {

sessionStorage.setItem('time_before_crash', new Date().toString());

}, 1000);

});

window.addEventListener('beforeunload', function () {

sessionStorage.setItem('good_exit', 'true');

});

if(sessionStorage.getItem('good_exit') &&

sessionStorage.getItem('good_exit') !== 'true') {

/*

insert crash logging code here

*/

alert('Hey, welcome back from your crash, looks like you crashed on: ' + sessionStorage.getItem('time_before_crash'));

}

2.基于以下原因,我们可以使用Service Worker来实现网页崩溃的监控:

Service Worker有自己独立的工作线程,与网页区分开,网页崩溃了,Service Worker一般情况下不会崩溃;

Service Worker生命周期一般要比网页还要长,可以用来监控网页的状态;

网页可以通过navigator.serviceWorker.controller.postMessage API向掌管自己的SW发送消息。

十二、错误上报

1.通过Ajax发送数据

因为Ajax请求本身也有可能会发生异常,而且有可能会引发跨域问题,一般情况下更推荐使用动态创建img标签的形式进行上报。

2.动态创建img标签的形式

function report(error) {

let reportUrl = 'http://jartto.wang/report';

new Image().src = `${reportUrl}?logs=${error}`;

}

收集异常信息量太多,怎么办?实际中,我们不得不考虑这样一种情况:如果你的网站访问量很大,那么一个必然的错误发送的信息就有很多条,这时候,我们需要设置采集率,从而减缓服务器的压力:

Reporter.send = function(data) {

// 只采集 30%

if(Math.random() < 0.3) {

send(data) // 上报错误信息

}

}

采集率应该通过实际情况来设定,随机数,或者某些用户特征都是不错的选择。

十三、总结

回到我们开头提出的那个问题,如何优雅的处理异常呢?

1.可疑区域增加Try-Catch

2.全局监控JS异常window.onerror

3.全局监控静态资源异常window.addEventListener

4.捕获没有Catch的Promise异常:unhandledrejection

5.VUE errorHandler和React componentDidCatch

6.监控网页崩溃:window对象的load和beforeunload

7.跨域crossOrigin解决

其实很简单,正如上文所说:采用组合方案,分类型的去捕获异常,这样基本 80%-90% 的问题都化于无形。

我自己是一名从事了多年前端开发的老程序员,辞职目前在做自己的私人定制课程,今年年初我花了一个月整理了一份最适合2019年学习的前端学习干货,从最基础的到深入的都有整理。送给每一位想学习的小伙伴。

学习讨论企鹅群:956766604

今天就整理这几个问题,后期再跟大家一起交流~

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 220,809评论 6 513
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 94,189评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 167,290评论 0 359
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 59,399评论 1 294
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 68,425评论 6 397
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 52,116评论 1 308
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,710评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,629评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 46,155评论 1 319
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,261评论 3 339
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,399评论 1 352
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 36,068评论 5 347
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,758评论 3 332
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,252评论 0 23
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,381评论 1 271
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,747评论 3 375
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,402评论 2 358

推荐阅读更多精彩内容

  • 现行有一些已经开源的前端异常监控库,如腾讯的badJs,全栈js监控fundebug,国外的sentry等。 错误...
    滚石_c2a6阅读 4,005评论 3 0
  • Promise 对象 Promise 的含义 Promise 是异步编程的一种解决方案,比传统的解决方案——回调函...
    neromous阅读 8,707评论 1 56
  • 最近在做一个前端监控的js 如图,一个大概的思路是这样的。 图片版 -----------------------...
    Estarsyang阅读 540评论 0 0
  • 前端可以说是最贴近用户的一层,当产品不断的迭代完善,产品的用户体验会更加趋向于完美,然而前端异常却是很另人头疼的一...
    编程鸭阅读 454评论 0 0
  • 我慈爱的外婆于5.16日凌晨去世,去了另一个世界。 一个月前,外婆被诊断出肺癌晚期。远在湖南的我,心里除了担心,就...
    女王萌阅读 216评论 0 0