前端異常處理最佳實踐

前端可以說是最貼近用戶的一層,當產品不斷的迭代完善,產品的用戶體驗會更加趨向於完美,然而前端異常卻是很另人頭疼的一個問題,我們應該怎麼去對待這些異常呢?

一、為什麼要處理異常?

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

  1. 增強用戶體驗;
  2. 遠程定位問題;
  3. 未雨綢繆,及早發現問題;
  4. 無法複線問題,尤其是移動端,機型,系統都是問題;
  5. 完善的前端方案,前端監控系統;

對於 JS 而言,我們面對的僅僅只是異常,異常的出現不會直接導致 JS 引擎崩潰,最多隻會使當前執行的任務終止。

二、需要處理哪些異常?

對於前端來說,我們可做的異常捕獲還真不少。總結一下,大概如下:

  • JS 語法錯誤、代碼異常
  • AJAX 請求異常
  • 靜態資源加載異常
  • Promise 異常
  • Iframe 異常
  • 跨域 Script error
  • 崩潰和卡頓

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

三、Try-Catch 的誤區

try-catch 只能捕獲到同步的運行時錯誤,對語法和異步錯誤卻無能為力,捕獲不到。

1、同步運行時錯誤:

前端異常處理最佳實踐


輸出:

前端異常處理最佳實踐


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

前端異常處理最佳實踐


輸出:

前端異常處理最佳實踐


不過語法錯誤在我們開發階段就可以看到,應該不會順利上到線上環境。

3、異步錯誤

前端異常處理最佳實踐


可以看看日誌:

前端異常處理最佳實踐


並沒有捕獲到異常,這是需要我們特別注意的地方。

四、window.onerror 不是萬能的

當 JS 運行時錯誤發生時,window 會觸發一個 ErrorEvent 接口的 error 事件,並執行 window.onerror()。

前端異常處理最佳實踐


1、首先試試同步運行時錯誤

前端異常處理最佳實踐

可以看到,我們捕獲到了異常:

前端異常處理最佳實踐

2、再試試語法錯誤呢?

前端異常處理最佳實踐

控制檯打印出了這樣的異常:

前端異常處理最佳實踐

竟然沒有捕獲到語法錯誤?

3、懷著忐忑的心,我們最後來試試異步運行時錯誤:

前端異常處理最佳實踐

控制檯輸出了:

前端異常處理最佳實踐

4、接著,我們試試網絡請求異常的情況:

前端異常處理最佳實踐

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

補充一點:window.onerror 函數只有在返回 true 的時候,異常才不會向上拋出,否則即使是知道異常的發生控制檯還是會顯示 Uncaught Error: xxxxx

前端異常處理最佳實踐

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

前端異常處理最佳實踐

需要注意:

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

到這裡基本就清晰了:在實際的使用過程中,onerror 主要是來捕獲預料之外的錯誤,而 try-catch 則是用來在可預見情況下監控特定的錯誤,兩者結合使用更加高效。

問題又來了,捕獲不到靜態資源加載異常怎麼辦?

一、window.addEventListener

當一項資源(如圖片或腳本)加載失敗,加載資源的元素會觸發一個 Event 接口的 error 事件,並執行該元素上的onerror() 處理函數。這些 error 事件不會向上冒泡到 window ,不過(至少在 Firefox 中)能被單一的window.addEventListener 捕獲。


前端異常處理最佳實踐


控制檯輸出:

前端異常處理最佳實踐


由於網絡請求異常不會事件冒泡,因此必須在捕獲階段將其捕捉到才行,但是這種方式雖然可以捕捉到網絡請求的異常,但是無法判斷 HTTP 的狀態是 404 還是其他比如 500 等等,所以還需要配合服務端日誌才進行排查分析才可以。

需要注意:

不同瀏覽器下返回的 error 對象可能不同,需要注意兼容處理。

需要注意避免 addEventListener 重複監聽。

二、Promise Catch

在 promise 中使用 catch 可以非常方便的捕獲到異步 error ,這個很簡單。沒有寫 catch 的 Promise 中拋出的錯誤無法被 onerror 或 try-catch 捕獲到,所以我們務必要在 Promise 中不要忘記寫 catch 處理拋出的異常。

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

前端異常處理最佳實踐


我們繼續來嘗試一下:

前端異常處理最佳實踐


那如果對 Promise 不進行 catch 呢?

前端異常處理最佳實踐


嗯,事實證明,也是會被正常捕獲到的。

所以,正如我們上面所說,為了防止有漏掉的 Promise 異常,建議在全局增加一個對 unhandledrejection 的監聽,用來全局監聽 Uncaught Promise Error。

補充一點:如果去掉控制檯的異常顯示,需要加上:

前端異常處理最佳實踐


三、VUE errorHandler

前端異常處理最佳實踐


四、React 異常捕獲

React 16 提供了一個內置函數 componentDidCatch,使用它可以非常簡單的獲取到 react 下的錯誤信息

前端異常處理最佳實踐

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

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

  1. 事件處理器
  2. 異步代碼
  3. 服務端的渲染代碼
  4. 在 error boundaries 區域內的錯誤

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

前端異常處理最佳實踐


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

前端異常處理最佳實踐

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

實際上,大多數情況下我們可以在整個程序中定義一個 error boundary 組件,之後就可以一直使用它了!

五、iframe 異常

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

前端異常處理最佳實踐


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

前端異常處理最佳實踐


六、Script error

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

跨源資源共享機制( CORS ):我們為>

前端異常處理最佳實踐


或者動態去添加 js 腳本:

前端異常處理最佳實踐

特別注意,服務器端需要設置:Access-Control-Allow-Origin

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

前端異常處理最佳實踐

簡單解釋一下:

改寫了 EventTarget 的 addEventListener 方法;

對傳入的 listener 進行包裝,返回包裝過的 listener,對其執行進行 try-catch;

瀏覽器不會對 try-catch 起來的異常進行跨域攔截,所以 catch 到的時候,是有堆棧信息的;

重新 throw 出來異常的時候,執行的是同域代碼,所以 window.onerror 捕獲的時候不會丟失堆棧信息;

利用包裝 addEventListener,我們還可以達到「擴展堆棧」的效果

前端異常處理最佳實踐

七、崩潰和卡頓

卡頓也就是網頁暫時響應比較慢, JS 可能無法及時執行。但崩潰就不一樣了,網頁都崩潰了,JS 都不運行了,還有什麼辦法可以監控網頁的崩潰,並將網頁崩潰上報呢?

崩潰和卡頓也是不可忽視的,也許會導致你的用戶流失。

1、利用window對象的load和beforeunload事件實現了對網頁崩潰的監控。

前端異常處理最佳實踐

2、基於以下原因,我們可以使用service Worker來實現對網頁崩潰的監控。

  • Service Worker 有自己獨立的工作線程,與網頁區分開,網頁崩潰了,Service Worker 一般情況下不會崩潰;
  • Service Worker 生命週期一般要比網頁還要長,可以用來監控網頁的狀態;
  • 網頁可以通過 navigator.serviceWorker.controller.postMessage API 向掌管自己的 SW 發送消息。

八、錯誤上報

1、通過 Ajax 發送數據

因為 Ajax 請求本身也有可能會發生異常,而且有可能會引發跨域問題,一般情況下更推薦使用動態創建 img 標籤的形式進行上報。

2、動態創建 img 標籤的形式

前端異常處理最佳實踐

收集異常信息量太多,怎麼辦?實際中,我們不得不考慮這樣一種情況:如果你的網站訪問量很大,那麼一個必然的錯誤發送的信息就有很多條,這時候,我們需要設置採集率,從而減緩服務器的壓力:

前端異常處理最佳實踐


採集率應該通過實際情況來設定,隨機數,或者某些用戶特徵都是不錯的選擇。

九、總結

回到我們開頭提出的那個問題,如何優雅的處理異常呢?

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

十五年編程經驗,今年1月整理了一批2019年最新WEB前端教學視頻,不論是零基礎想要學習前端還是學完在工作想要提升自己,這些資料都會給你帶來幫助,從HTML到各種框架,幫助所有想要學好前端的同學,學習規劃、學習路線、學習資料、問題解答。只要關注我的頭條號,後臺私信我【前端】兩個字,即可免費獲取。


分享到:


相關文章: