DIV CSS 佈局教程網

完整捕獲與分析 JavaScript 錯誤的實務指南
編輯:JavaScript綜合知識     

JavaScript 有基本的異常處理能力:我們可以 throw new Error(),瀏覽器也會在呼叫 API 出錯時拋出異常。但絕大多數前端工程師從沒想過要收集這些異常資訊——反正出錯後重新整理就不復現,使用者自己按 F5 就好了,瀏覽器又不會當掉。

這個假設在單頁應用程式流行之前還算成立。但現在的 SPA 運行一段時間後狀態複雜無比,使用者可能操作了十幾個步驟才走到這裡,你跟他說「請重新整理」?之前的輸入全得重來。所以我們還是有必要捕獲並分析這些異常,才能在不影響使用者體驗的前提下修正問題。

一、捕獲異常的三種途徑

自己寫的 throw new Error() 當然好捕,因為我們清楚丟在哪。但瀏覽器 API 拋出的異常就未必:有些 API 在標準裡明定會拋異常,有些則只有個別瀏覽器因實作差異或缺陷而拋。前者能用 try-catch,後者必須靠全域監聽。

1. try-catch

已知會拋異常的 API,就應該把呼叫包進 try-catch,避免整個程式進入非法狀態。例如 window.localStorage 在寫入超過容量限制時會拋異常,Safari 的無痕模式也是如此:

try {
  localStorage.setItem('date', Date.now());
} catch (error) {
  reportError(error);
}

另一個常見場景是回呼。因為回呼函式的程式碼品質我們無法掌控,不確定它會不會呼叫其他會拋異常的 API。为了不因為回呼出錯而導致後續程式碼無法執行,把呼叫包進 try-catch 是必要的:

listeners.forEach(function (listener) {
  try {
    listener();
  } catch (error) {
    reportError(error);
  }
});

2. window.onerror

try-catch 覆蓋不到的地方,就只能靠 window.onerror:

window.onerror =
  function (errorMessage, scriptURI, lineNumber) {
    reportError({
      message: errorMessage,
      script: scriptURI,
      line: lineNumber
    });
  };

注意不要耍小聰明改用 window.addEventListener 或 attachEvent 去監聽 error 事件。很多瀏覽器只實作了 window.onerror,或者只有它的實作符合標準。既然標準草案定義的也是 window.onerror,那就用它。

3. 未處理的 Promise 拒絕

window.addEventListener('unhandledrejection', function (e) {
  reportError(e.reason);
});

二、屬性會在途中丟失

假設 reportError 會把捕到的異常批次送到伺服器,那我們想收集哪些資訊?有用的包括:錯誤型別(name)、錯誤訊息(message)、腳本網址(script)、行號(line)、列號(column)、堆疊追蹤(stack)。

如果異常是透過 try-catch 捕到的,這些資訊都在 Error 物件上(主流瀏覽器都支援),所以 reportError 收得齊。但如果是透過 window.onerror 捕到的,這個事件函式只有 3 個參數,其餘資訊就丟了。

三、把資訊塞進 message

如果 Error 物件是我們自己建立的,那 error.message 就由我們控制。基本上放什麼進去,window.onerror 的第一個參數就會是什麼(瀏覽器可能會加上 'Uncaught Error: ' 之類的前綴)。因此可以把我們關注的屬性序列化後放進 message,再在 onerror 裡反序列化取出:

throw new Error(JSON.stringify({ userId: 42, step: 'checkout' }));

但這招只對自己建立的 Error 有效。

四、第五個參數

瀏覽器廠商也知道大家受限於三個參數,於是開始擴充。IE 先把列號放在第四個參數;Firefox 提議把堆疊放第五個;Chrome 則主張直接放整個 Error 物件——這樣想讀什麼屬性都可以,包括自訂屬性。由於 Chrome 30 動作最快,標準草案也就跟著這樣定義:

window.onerror = function (
  errorMessage,
  scriptURI,
  lineNumber,
  columnNumber,
  error
) {
  if (error) {
    reportError(error);          // 有 Error 物件時直接用,資訊最完整
  } else {
    reportError({
      message: errorMessage,
      script: scriptURI,
      line: lineNumber,
      column: columnNumber
    });
  }
};

五、屬性正規化

上面提到的屬性名稱都是基於 Chrome 的命名,但各家瀏覽器並不一致——腳本網址在 Chrome 叫 script,在 Firefox 叫 filename。所以需要一個專門的函式做映射:

function normalizeError(error) {
  return {
    name:    error.name,
    message: error.message,
    script:  error.script  || error.filename,
    line:    error.line    || error.lineno,
    column:  error.column  || error.colno,
    stack:   error.stack
  };
}

堆疊追蹤(stack)也一樣:它是純文字,各家格式不同,需要維護一份正則表達式從中擷取每一幀的函式名、檔案、行號與列號。雖然瀏覽器實作會演進,但人手維護這份對照表並不算難。

六、安全限制:'Script error.'

如果你見過訊息是 'Script error.' 的錯誤,就會明白問題所在——這是瀏覽器對跨來源(origin)腳本的安全限制。

理由是這樣的:假設一家網銀對已登入使用者回傳的 HTML 與匿名使用者不同,某個第三方網站就能把網銀的 URL 放進 script.src。HTML 當然不可能被當成 JS 解析,所以瀏覽器會拋出異常,而這個第三方網站可以從異常發生的位置推斷使用者是否已登入。為了堵住這個漏洞,瀏覽器對跨來源腳本拋出的異常一律過濾,只留下 'Script error.' 這條不變的訊息。

對有一定規模的網站來說,腳本放在 CDN 上是常態;就算只是小站,jQuery、Backbone 這類常見框架也常直接引用公共 CDN 以加速下載。所以這個限制確實造成麻煩:從 Chrome 和 Firefox 收到的異常全是無用的 'Script error.'。

七、用 CORS 繞過限制

解法是確保腳本與頁面同源。但把檔案從 CDN 移回自己的主機又會拖慢下載。折衷方案是:檔案繼續放 CDN,用 XMLHttpRequest 透過 CORS 把內容抓回來,再建立 <script> 標籤注入頁面——注入的程式碼屬於頁面內嵌,自然是同源的。

說起來簡單,實作起來細節很多。以下面三個標籤為例:

<script src="https://cdn.com/step1.js"></script>
<script>
(function step2() {})();
</script>
<script src="https://cdn.com/step3.js"></script>

如果 step1、step2、step3 之間有依賴關係,就必須嚴格按順序執行。瀏覽器可以並行下載 step1 與 step3,但執行順序有保證。若改由我們自己用 XHR 抓取,就得自行維護順序;而且别忘了 step2——當 step1 還在非阻塞下載時,step2 早就可以執行了,所以我們必須人為讓它等 step1 完成。

因此原本輸出 <script> 標籤的那套工具要改寫成:

<script>
scheduleRemoteScript('https://cdn.com/step1.js');
</script>
<script>
scheduleInlineScript(function code() {
  (function step2() {})();
});
</script>
<script>
scheduleRemoteScript('https://cdn.com/step3.js');
</script>

注意原本立即執行的 step2 被放進一個更大的 code 函式裡。code 不會被執行,它只是個容器,讓 step2 的程式碼不必轉義就能原樣保留,又不會被立即執行。接著再實作一套機制,讓 scheduleRemoteScript 下載回來的內容與 scheduleInlineScript 取得的程式碼能依正確順序逐一執行。

八、行號衝突與反查

CORS 注入繞過了安全限制,卻帶來新問題:行號衝突。原本靠 error.script 能定位到唯一的檔案,再用 error.line 定位行號。現在全是頁面內嵌程式碼,多個 <script> 標籤無法從 script 欄位區分,而每個標籤內部的行號都從 1 算起,結果就無法定位了。

解法是故意浪費行號,讓每個標籤實際使用的行號區間互不重疊。假設每段程式不超過 1000 行:第一段佔 1–1000,第二段前面插入 1000 行空行佔 1001–2000,第三段插入 2000 行空行佔 2001–3000,依此類推。再用 data-* 屬性記錄這些資訊以便反查:

<script data-src="https://cdn.com/step1.js" data-line-start="1">
  // code for step 1
</script>
<script data-line-start="1001">
  // 1000 行空行
  // code for step 2
</script>
<script data-src="https://cdn.com/step3.js" data-line-start="2001">
  // 2000 行空行
  // code for step 3
</script>

這樣若某個錯誤的 error.line 是 3005,就代表實際檔案是 step3.js、實際行號是 5。這項反查可以在 reportError 裡完成。

實際上不必固定配 1000 行:只要依各檔實際行數分配區間,並保證互不重疊即可。這麼做還能順便節省網路傳輸量。

九、crossorigin 屬性

瀏覽器對跨來源內容的限制不只作用於 <script>。<img> 引用跨來源圖片同樣受限:一旦這種圖片被用於 canvas 繪圖,該 canvas 會變成「只寫」狀態,以確保網站無法竊取未授權的圖片資料。後來 <img> 引入了 crossorigin 屬性來解決:

  • crossorigin="anonymous":等同匿名 CORS。
  • crossorigin="use-credentials":等同帶認證的 CORS。

既然 img 可以,script 為什麼不行?於是瀏覽器廠商為 <script> 也加入了同樣的屬性。目前 Chrome 與 Firefox 支援良好。

Safari 則有個問題:它會把 crossorigin="anonymous" 當成 use-credentials 處理,所以若伺服器只支援匿名 CORS,Safari 會視為認證失敗。由於 CDN 基於效能考量只回傳靜態內容,無法依請求動態產生認證 CORS 所需的 HTTP Header,Safari 等於用不上這個特性。

因此使用時請記得在伺服器端設定 Access-Control-Allow-Origin,並搭配:

<script src="https://cdn.com/app.js" crossorigin="anonymous"></script>

十、總結

JavaScript 的異常處理看起來跟其他語言沒兩樣,但真的要把異常都捕下來、再把屬性正規化分析,其實一點都不簡單。市面上已有第三方服務提供類似 Google Analytics 的 JS 異常收集,但若想弄懂其中的細節與原理,還是得自己動手做一次。

如果你只想記住結論,那就是這三點:已知會拋錯的 API 用 try-catch、其餘靠 window.onerror 並讀第五個參數拿完整 Error、跨來源腳本加上 crossorigin 屬性並在伺服器設定 CORS 標頭。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved