如何優(yōu)雅處理前端異常坯汤?

一虐唠、為什么要處理異常?

異常是不可控的惰聂,會影響最終的呈現(xiàn)結(jié)果疆偿,但是我們有充分的理由去做這樣的事情。

增強(qiáng)用戶體驗(yàn)搓幌;遠(yuǎn)程定位問題杆故;未雨綢繆,及早發(fā)現(xiàn)問題溉愁;無法復(fù)線問題处铛,尤其是移動端,機(jī)型拐揭,系統(tǒng)都是問題撤蟆;完善的前端方案,前端監(jiān)控系統(tǒng)堂污;

對于 JS 而言家肯,我們面對的僅僅只是異常,異常的出現(xiàn)不會直接導(dǎo)致 JS 引擎崩潰盟猖,最多只會使當(dāng)前執(zhí)行的任務(wù)終止息楔。

二寝贡、需要處理哪些異常?

對于前端來說值依,我們可做的異常捕獲還真不少圃泡。總結(jié)一下愿险,大概如下:

JS 語法錯誤颇蜡、代碼異常AJAX 請求異常靜態(tài)資源加載異常Promise 異常Iframe 異常跨域 Script error崩潰和卡頓

下面我會針對每種具體情況來說明如何處理這些異常辆亏。

三风秤、Try-Catch 的誤區(qū)

try-catch 只能捕獲到同步的運(yùn)行時錯誤,對語法和異步錯誤卻無能為力扮叨,捕獲不到缤弦。

1. 同步運(yùn)行時錯誤:

try{letname ='jartto';console.log(nam);}catch(e) {console.log('捕獲到異常:',e);}

輸出:

捕獲到異常: ReferenceError: namisnotdefinedat:3:15

2. 不能捕獲到語法錯誤,我們修改一下代碼彻磁,刪掉一個單引號:

try{ letname= 'jartto; console.log(nam);} catch(e) { console.log('捕獲到異常:',e);}

輸出:

Uncaught SyntaxError: Invalidorunexpectedtoken

不過語法錯誤在我們開發(fā)階段就可以看到碍沐,應(yīng)該不會順利上到線上環(huán)境。

3. 異步錯誤

try{ setTimeout(()=>{undefined.map(v=>v); },1000)}catch(e) {console.log('捕獲到異常:',e);}

我們看看日志:

UncaughtTypeError: Cannot read property'map'ofundefinedat setTimeout (:3:11)

并沒有捕獲到異常衷蜓,這是需要我們特別注意的地方累提。

四、window.onerror 不是萬能的

當(dāng) JS 運(yùn)行時錯誤發(fā)生時磁浇,window 會觸發(fā)一個 ErrorEvent 接口的 error 事件斋陪,并執(zhí)行 window.onerror()。

/*** @param{String}message錯誤信息* @param{String}source出錯文件* @param{Number}lineno行號* @param{Number}colno列號* @param{Object}errorError對象(對象)*/window.onerror = function(message, source, lineno, colno, error) { console.log('捕獲到異常:',{message, source, lineno, colno, error});}

1. 首先試試同步運(yùn)行時錯誤

window.onerror = function(message,source, lineno, colno,error) {// message:錯誤信息(字符串)置吓。// source:發(fā)生錯誤的腳本URL(字符串)// lineno:發(fā)生錯誤的行號(數(shù)字)// colno:發(fā)生錯誤的列號(數(shù)字)// 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: Invalidorunexpectedtoken

什么衍锚,竟然沒有捕獲到語法錯誤骑科?

3. 懷著忐忑的心,我們最后來試試異步運(yùn)行時錯誤:

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. 接著构拳,我們試試網(wǎng)絡(luò)請求異常的情況:

window.onerror =function(message, source, lineno, colno, error){console.log('捕獲到異常:',{message, source, lineno, colno, error});returntrue;}

我們發(fā)現(xiàn)咆爽,不論是靜態(tài)資源異常,或者接口異常置森,錯誤都無法捕獲到斗埂。

補(bǔ)充一點(diǎn):window.onerror 函數(shù)只有在返回 true 的時候,異常才不會向上拋出凫海,否則即使是知道異常的發(fā)生控制臺還是會顯示 Uncaught Error: xxxxx

window.onerror =function(message, source, lineno, colno, error){console.log('捕獲到異常:',{message, source, lineno, colno, error});returntrue;}setTimeout(()=>{ Jartto;});

控制臺就不會再有這樣的錯誤了:

Uncaught ReferenceError: JarttoisnotdefinedatsetTimeout ((index):36)

需要注意:

onerror 最好寫在所有 JS 腳本的前面呛凶,否則有可能捕獲不到錯誤;

onerror 無法捕獲語法錯誤行贪;

到這里基本就清晰了:在實(shí)際的使用過程中漾稀,onerror 主要是來捕獲預(yù)料之外的錯誤模闲,而 try-catch 則是用來在可預(yù)見情況下監(jiān)控特定的錯誤,兩者結(jié)合使用更加高效崭捍。

問題又來了尸折,捕獲不到靜態(tài)資源加載異常怎么辦?

五殷蛇、window.addEventListener

當(dāng)一項資源(如圖片或腳本)加載失敗实夹,加載資源的元素會觸發(fā)一個 Event 接口的 error 事件,并執(zhí)行該元素上的onerror() 處理函數(shù)粒梦。這些 error 事件不會向上冒泡到 window 亮航,不過(至少在 Firefox 中)能被單一的window.addEventListener 捕獲。

控制臺輸出:

由于網(wǎng)絡(luò)請求異常不會事件冒泡匀们,因此必須在捕獲階段將其捕捉到才行缴淋,但是這種方式雖然可以捕捉到網(wǎng)絡(luò)請求的異常,但是無法判斷 HTTP 的狀態(tài)是 404 還是其他比如 500 等等泄朴,所以還需要配合服務(wù)端日志才進(jìn)行排查分析才可以重抖。

需要注意:

不同瀏覽器下返回的 error 對象可能不同,需要注意兼容處理叼旋。需要注意避免 addEventListener 重復(fù)監(jiān)聽。

六沦辙、Promise Catch

在 promise 中使用 catch 可以非常方便的捕獲到異步 error 夫植,這個很簡單。

沒有寫 catch 的 Promise 中拋出的錯誤無法被 onerror 或 try-catch 捕獲到油讯,所以我們務(wù)必要在 Promise 中不要忘記寫 catch 處理拋出的異常详民。

解決方案: 為了防止有漏掉的 Promise 異常,建議在全局增加一個對 unhandledrejection 的監(jiān)聽陌兑,用來全局監(jiān)聽Uncaught Promise Error沈跨。使用方式:

window.addEventListener("unhandledrejection",function(e){console.log(e);});

我們繼續(xù)來嘗試一下:

window.addEventListener("unhandledrejection",function(e){ e.preventDefault()console.log('捕獲到異常:', e);returntrue;});Promise.reject('promise error');

可以看到如下輸出:

那如果對 Promise 不進(jìn)行 catch 呢?

window.addEventListener("unhandledrejection",function(e){ e.preventDefault()console.log('捕獲到異常:', e);returntrue;});newPromise((resolve, reject) =>{ reject('jartto: promise error');});

嗯兔综,事實(shí)證明饿凛,也是會被正常捕獲到的。

所以软驰,正如我們上面所說涧窒,為了防止有漏掉的 Promise 異常,建議在全局增加一個對 unhandledrejection 的監(jiān)聽锭亏,用來全局監(jiān)聽 Uncaught Promise Error纠吴。

補(bǔ)充一點(diǎn):如果去掉控制臺的異常顯示,需要加上:

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 提供了一個內(nèi)置函數(shù) componentDidCatch固该,使用它可以非常簡單的獲取到 react 下的錯誤信息

componentDidCatch(error,info) { console.log(error,info);}

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

UI 的某部分引起的 JS 錯誤不應(yīng)該破壞整個程序糖儡,為了幫 React 的使用者解決這個問題伐坏,React 16 介紹了一種關(guān)于錯誤邊界(error boundary)的新觀念。

需要注意的是: error boundaries 并不會捕捉下面這些錯誤休玩。

事件處理器異步代碼服務(wù)端的渲染代碼在 error boundaries 區(qū)域內(nèi)的錯誤

我們來舉一個小例子著淆,在下面這個 componentDIdCatch(error,info) 里的類會變成一個 error boundary:

classErrorBoundaryextendsReact.Component{ constructor(props) {super(props);this.state = { hasError:false}; }? componentDidCatch(error, info) {// Display fallback UIthis.setState({ hasError:true});// You can also log the error to an error reporting servicelogErrorToMyService(error, info); }? render() {if(this.state.hasError) {// You can render any custom fallback UIreturn

Somethingwent wrong.

; }returnthis.props.children; }}

然后我們像使用普通組件那樣使用它:

<ErrorBoundary><MyWidget /></ErrorBoundary>

componentDidCatch() 方法像 JS 的 catch{} 模塊一樣工作,但是對于組件拴疤,只有 class 類型的組件(class component )可以成為一個 error boundaries 永部。

實(shí)際上,大多數(shù)情況下我們可以在整個程序中定義一個 error boundary 組件呐矾,之后就可以一直使用它了苔埋!

九、iframe 異常

對于 iframe 的異常捕獲蜒犯,我們還得借力 window.onerror:

window.onerror = function(message,source, lineno, colno,error) { console.log('捕獲到異常:',{message,source, lineno, colno,error});}

一個簡單的例子可能如下:

window.frames[0].onerror =function(message, source, lineno, colno, error){console.log('捕獲到 iframe 異常:',{message, source, lineno, colno, error});returntrue; };

十组橄、Script error

一般情況,如果出現(xiàn) Script error 這樣的錯誤罚随,基本上可以確定是出現(xiàn)了跨域問題玉工。這時候,是不會有其他太多輔助信息的淘菩,但是解決思路無非如下:

跨源資源共享機(jī)制( CORS ):我們?yōu)?script 標(biāo)簽添加 crossOrigin 屬性遵班。

或者動態(tài)去添加 js 腳本:

constscript = document.createElement('script');script.crossOrigin ='anonymous';script.src = url;document.body.appendChild(script);

特別注意,服務(wù)器端需要設(shè)置:Access-Control-Allow-Origin

此外潮改,我們也可以試試這個-解決 Script Error 的另類思路:

constoriginAddEventListener = EventTarget.prototype.addEventListener;EventTarget.prototype.addEventListener =function(type, listener, options){constwrappedListener =function(...args){try{returnlistener.apply(this, args); }catch(err) {throwerr; } }returnoriginAddEventListener.call(this, type, wrappedListener, options);}

簡單解釋一下:

改寫了 EventTarget 的 addEventListener 方法狭郑;對傳入的 listener 進(jìn)行包裝,返回包裝過的 listener汇在,對其執(zhí)行進(jìn)行 try-catch翰萨;瀏覽器不會對 try-catch 起來的異常進(jìn)行跨域攔截,所以 catch 到的時候糕殉,是有堆棧信息的亩鬼;重新 throw 出來異常的時候,執(zhí)行的是同域代碼阿蝶,所以 window.onerror 捕獲的時候不會丟失堆棧信息辛孵;

利用包裝 addEventListener,我們還可以達(dá)到「擴(kuò)展堆椛陌酰」的效果:

(() => {constoriginAddEventListener = EventTarget.prototype.addEventListener; EventTarget.prototype.addEventListener =function(type, listener, options){+// 捕獲添加事件時的堆棧+constaddStack =newError(`Event (${type})`).stack;constwrappedListener =function(...args){try{returnlistener.apply(this, args); }catch(err) {+// 異常發(fā)生時魄缚,擴(kuò)展堆棧+ err.stack +='\n'+ addStack;throwerr; } }returnoriginAddEventListener.call(this, type, wrappedListener, options); } })();

十一、崩潰和卡頓

卡頓也就是網(wǎng)頁暫時響應(yīng)比較慢, JS 可能無法及時執(zhí)行冶匹。但崩潰就不一樣了习劫,網(wǎng)頁都崩潰了,JS 都不運(yùn)行了嚼隘,還有什么辦法可以監(jiān)控網(wǎng)頁的崩潰诽里,并將網(wǎng)頁崩潰上報呢?

崩潰和卡頓也是不可忽視的飞蛹,也許會導(dǎo)致你的用戶流失谤狡。

1. 利用 window 對象的 load 和 beforeunload 事件實(shí)現(xiàn)了網(wǎng)頁崩潰的監(jiān)控。

不錯的文章卧檐,推薦閱讀:Logging Information on Browser Crashes墓懂。

window.addEventListener('load',function(){ sessionStorage.setItem('good_exit','pending'); setInterval(function(){ sessionStorage.setItem('time_before_crash',newDate().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 來實(shí)現(xiàn)網(wǎng)頁崩潰的監(jiān)控:

Service Worker 有自己獨(dú)立的工作線程霉囚,與網(wǎng)頁區(qū)分開捕仔,網(wǎng)頁崩潰了,Service Worker一般情況下不會崩潰盈罐;Service Worker 生命周期一般要比網(wǎng)頁還要長榜跌,可以用來監(jiān)控網(wǎng)頁的狀態(tài);網(wǎng)頁可以通過 navigator.serviceWorker.controller.postMessage API 向掌管自己的 SW發(fā)送消息盅粪。

十二钓葫、錯誤上報

1. 通過 Ajax 發(fā)送數(shù)據(jù)

因?yàn)?Ajax 請求本身也有可能會發(fā)生異常,而且有可能會引發(fā)跨域問題票顾,一般情況下更推薦使用動態(tài)創(chuàng)建 img 標(biāo)簽的形式進(jìn)行上報础浮。

2. 動態(tài)創(chuàng)建 img 標(biāo)簽的形式

functionreport(error){letreportUrl ='http://jartto.wang/report';newImage().src =`${reportUrl}?logs=${error}`;}

收集異常信息量太多,怎么辦库物?實(shí)際中霸旗,我們不得不考慮這樣一種情況:如果你的網(wǎng)站訪問量很大贷帮,那么一個必然的錯誤發(fā)送的信息就有很多條戚揭,這時候,我們需要設(shè)置采集率撵枢,從而減緩服務(wù)器的壓力:

Reporter.send =function(data){// 只采集 30%if(Math.random() <0.3) { send(data)// 上報錯誤信息}}

采集率應(yīng)該通過實(shí)際情況來設(shè)定民晒,隨機(jī)數(shù),或者某些用戶特征都是不錯的選擇锄禽。

十三潜必、總結(jié)

回到我們開頭提出的那個問題,如何優(yōu)雅的處理異常呢沃但?

可疑區(qū)域增加 Try-Catch全局監(jiān)控 JS 異常 window.onerror全局監(jiān)控靜態(tài)資源異常 window.addEventListener捕獲沒有 Catch 的 Promise 異常:unhandledrejectionVUE errorHandler 和 React componentDidCatch監(jiān)控網(wǎng)頁崩潰:window 對象的 load 和 beforeunload跨域 crossOrigin 解決

其實(shí)很簡單磁滚,正如上文所說:采用組合方案,分類型的去捕獲異常,這樣基本 80%-90% 的問題都化于無形垂攘。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末维雇,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子晒他,更是在濱河造成了極大的恐慌吱型,老刑警劉巖,帶你破解...
    沈念sama閱讀 219,589評論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件陨仅,死亡現(xiàn)場離奇詭異津滞,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)灼伤,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,615評論 3 396
  • 文/潘曉璐 我一進(jìn)店門触徐,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人饺蔑,你說我怎么就攤上這事锌介。” “怎么了猾警?”我有些...
    開封第一講書人閱讀 165,933評論 0 356
  • 文/不壞的土叔 我叫張陵孔祸,是天一觀的道長。 經(jīng)常有香客問我发皿,道長崔慧,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,976評論 1 295
  • 正文 為了忘掉前任穴墅,我火速辦了婚禮惶室,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘玄货。我一直安慰自己皇钞,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,999評論 6 393
  • 文/花漫 我一把揭開白布松捉。 她就那樣靜靜地躺著夹界,像睡著了一般。 火紅的嫁衣襯著肌膚如雪隘世。 梳的紋絲不亂的頭發(fā)上可柿,一...
    開封第一講書人閱讀 51,775評論 1 307
  • 那天,我揣著相機(jī)與錄音丙者,去河邊找鬼段化。 笑死紊扬,一個胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播港谊,決...
    沈念sama閱讀 40,474評論 3 420
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起键俱,我...
    開封第一講書人閱讀 39,359評論 0 276
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎世分,沒想到半個月后编振,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,854評論 1 317
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡臭埋,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 38,007評論 3 338
  • 正文 我和宋清朗相戀三年踪央,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片瓢阴。...
    茶點(diǎn)故事閱讀 40,146評論 1 351
  • 序言:一個原本活蹦亂跳的男人離奇死亡畅蹂,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出荣恐,到底是詐尸還是另有隱情液斜,我是刑警寧澤,帶...
    沈念sama閱讀 35,826評論 5 346
  • 正文 年R本政府宣布叠穆,位于F島的核電站少漆,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏硼被。R本人自食惡果不足惜示损,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,484評論 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望嚷硫。 院中可真熱鬧检访,春花似錦、人聲如沸仔掸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,029評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽起暮。三九已至卖氨,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間鞋怀,已是汗流浹背双泪。 一陣腳步聲響...
    開封第一講書人閱讀 33,153評論 1 272
  • 我被黑心中介騙來泰國打工持搜, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留密似,地道東北人。 一個月前我還...
    沈念sama閱讀 48,420評論 3 373
  • 正文 我出身青樓葫盼,卻偏偏與公主長得像残腌,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,107評論 2 356

推薦閱讀更多精彩內(nèi)容