kaikeba

如何優雅地處理前端異常?

前端一直是距離用戶最近的一層,隨著產品的日益完善,我們會更加注重用戶體驗,而前端異常卻如鯁在喉,甚是煩人。

一、為什么要處理異常?

異常是不可控的,會影響最終的呈現結果,但是我們有充分的理由去做這樣的事情。

  • 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 <anonymous>: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 (<anonymous>: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.接著,我們試試網絡請求異常的情況:

<script>
window.onerror = function(message, source, lineno, colno, error) {
console.log('捕獲到異常:',{message, source, lineno, colno, error});
return true;
}
</script>
<img src="./jartto.png">

我們發現,不論是靜態資源異常,或者接口異常,錯誤都無法捕獲到。

補充一點: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?捕獲。

<scritp>
window.addEventListener('error', (error) => {
console.log('捕獲到異常:', error);
}, true)
</script>
<img src="./jartto.png">

控制臺輸出:

由于網絡請求異常不會事件冒泡,因此必須在捕獲階段將其捕捉到才行,但是這種方式雖然可以捕捉到網絡請求的異常,但是無法判斷?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 <h1>Something went wrong.</h1>;
}
return this.props.children;
}
}

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

<ErrorBoundary>
<MyWidget />
</ErrorBoundary>

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>

十、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% 的問題都化于無形。

十四、參考

發表我的評論

取消評論
表情 插代碼

Hi,您需要填寫昵稱和郵箱!

  • 必填項
  • 必填項
22选5今晚开奖公告