DIV CSS 佈局教程網

JavaScript 異常處理完整指南:從 try-catch 到跨源腳本的 Script error.
編輯:關於JavaScript     

每個前端工程師都知道 throw new Error(),但絕大多數人從沒想過要把這些異常收集起來。反正出錯就請使用者重新整理,瀏覽器不會當機,當作什麼都沒發生就好——這個假設在單頁應用程式普及之前還算成立,現在則完全不是那回事了。

為什麼現在必須收集異常

單頁應用程式的狀態複雜得超乎想像。使用者可能填了十分鐘表單、翻過二十頁內容才走到當前這一步,此時一個未捕獲的錯誤讓畫面卡死,你叫他「重新整理一下」?那之前的操作全都得重來。

所以我們需要捕獲、上報、分析這些異常,然後在它以同樣的方式傷害下一位使用者之前修掉它。

捕獲異常的三種途徑

1. 自己 throw 的

最好辦。我們很清楚 throw 寫在哪一行,用 try-catch 包住即可。

2. 已知會拋錯的瀏覽器 API

有些 API 在規格裡就註明會拋出異常。例如 window.localStorage 在寫入超過容量限制時會拋 QuotaExceededError,在 Safari 的無痕模式下也會。

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

3. 回呼函式內部的錯誤

回呼的程式碼是我們無法控制的:不知道品質如何、不知道它會不會去呼叫其他會拋錯的 API。若不包住,回呼一旦出錯,後續的程式碼全部無法執行。

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

4. try-catch 覆蓋不到的地方:window.onerror

其餘所有未捕獲的異常,只能靠全域監聽:

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

注意不要試著用 window.addEventListener('error', ...) 或 attachEvent 來監聽 window.onerror。很多瀏覽器只實作了 window.onerror 這一個形式,或者只有它是標準的。既然規格草案定義的就是 window.onerror,那就用它。

屬性丟失問題

假設 reportError 負責收集異常並批次送到伺服器。我們想知道什麼?錯誤型別(name)、錯誤訊息(message)、腳本網址(script)、行號(line)、列號(column)、堆疊追蹤(stack)。

如果異常是由 try-catch 捕到的,這些資訊都在 Error 物件上,主流瀏覽器都支援。但如果是 window.onerror 捕到的,這個函式只有三個參數——其他資訊全都丟了。

解法一:序列化到 message

如果 Error 物件是我們自己建立的,error.message 就由我們掌控。把關注的屬性 JSON.stringify 後塞進 message,再在 window.onerror 裡讀出來反序列化即可(瀏覽器頂多幫你加上 'Uncaught Error: ' 前綴)。當然,這招只對自製的 Error 有效。

解法二:第五個參數

瀏覽器廠商也知道這個限制,於是開始擴充 window.onerror 的簽名。順序有點像一段協商紀錄:

  • IE 注意到「只有行號沒有列號不太對稱」,把列號放在第四個參數。
  • Firefox 認為大家更想要完整堆疊,把 stack 放在第五個參數。
  • 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 normalize(error) {
  return {
    message: error.message,
    script:  error.filename || error.script || '',
    line:    error.lineno   || error.line   || 0,
    column:  error.colno    || error.column || 0,
    stack:   error.stack    || ''
  };
}

堆疊追蹤的格式 similarly 各家不同,得再維護一份正則表,從純文字中抽出每一幀的函式名、檔案、行號、列號。雖然瀏覽器會更新,但人手維護這份對映表並不算難。

最惱人的問題:Script error.

如果你見過訊息只有 'Script error.'、其他屬性全空的錯誤,這裡就是原因。這是瀏覽器對跨源腳本的安全限制。

理由這樣想就明白了:假設某家網銀對已登入使用者回傳的 HTML 與匿名使用者不同,那麼一個第三方網站只要把網銀的某個網址放進 <script src>,HTML 當然會解析失敗並拋出異常,而這個第三方網站就能從異常發生的位置推斷使用者是否已登入。為了堵住這個側信道,瀏覽器把跨源腳本拋出的異常一律過濾成一句不變的 'Script error.'。

問題是現在稍有規模的網站都把腳本放在 CDN 上,就算是小站也會直接引用 jQuery、Vue 等公共 CDN 版本。結果就是我們從 Chrome 和 Firefox 收到的一大堆異常,全是無用的 'Script error.'。

解法一:CORS 加 crossorigin 屬性

最簡單的正規解法是讓 CDN 回傳 Access-Control-Allow-Origin 標頭,並在 script 標籤上加 crossorigin:

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

crossorigin="anonymous" 相當於匿名 CORS,"use-credentials" 則帶認證。

瀏覽器支援度上,Chrome 與 Firefox 完全沒問題。Safari 有個歷史問題:它會把 anonymous 當成 use-credentials 處理,因此若 CDN 只支援匿名 CORS,Safari 會判定認證失敗。由於 CDN 為了效能只回傳靜態內容,無法依請求動態產生認證 CORS 所需的標頭,Safari 也就無法用這招解決。

解法二:用 XHR 取回後內嵌注入

如果不方便改 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 非阻塞下載時就能跑,現在必須人為讓它等 step1 完成。

於是我們需要一組排程函式:

<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 永遠不會被呼叫,它只是個容器,讓原本的程式碼不必轉義就能原封不動保留下來,又不會被立即執行。這兩個排程函式必須在第一個外部 script 標籤之前定義好。

解法二的副作用:行號衝突

把所有腳本都變成頁面內嵌之後,新問題來了。原本靠 error.script 能定位到唯一檔案,再用 error.line 定位行號。現在多個 <script> 標籤無法用 script 欄位區分,而每個標籤內部的行號都從 1 重新算起,於是異常資訊就再也無法對回原始檔案了。

解法有點暴力但有效:故意浪費行號,讓各標籤使用的行號區間互不重疊。

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

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

實作時不必死板地每段配 1000 行。依各腳本實際行數動態分配區間即可,只要保證不重疊就行——小檔案配小區間,能省下不少無謂的空行。

另一個靈感來源:img 與 crossorigin

瀏覽器對跨源內容的限制不只發生在 <script> 上。<img> 引用跨源圖片時,一旦該圖片被用於 <canvas> 繪圖,canvas 就會進入「只寫」狀態(tainted),確保網站無法用 JS 讀取未授權的跨源圖片資料。

<img> 後來用 crossorigin 屬性解決了這個問題,接著 <script> 也沿用同樣的設計。這是一個很好的例子,說明瀏覽器的安全機制其實有內在一致性:同源政策限制的是「讀取」,而不是「載入」,而 CORS 就是那個受控的例外通道。

現代補充

今天若要處理全域錯誤,除了 window.onerror,還應該知道:

  • window.addEventListener('unhandledrejection', ...) — 攔截未被 catch 的 Promise 拒絕。在 async/await 普及後,這往往比 window.onerror 更重要。
  • window.addEventListener('error', ..., true) — 用捕獲階段監聽資源載入失敗(img、script、link)。這類事件不冒泡,所以必須在捕獲階段攔。
  • Source Map — 上報堆疊裡的壓縮行號,在伺服器端對回原始碼位置。這比前面那套行號反查優雅得多,前提是原始碼不外流。
  • Error.captureStackTrace / Error() 的 stack 屬性 — 主動建立參照點,讓非同步流程也能串起呼叫鏈。

總結

JavaScript 的異常處理表面上看起來跟別的語言沒兩樣,但真要把所有異常都捕到、把屬性都正確解析出來,牽涉到的東西出乎意料地多:瀏覽器實作差異、同源政策與 CORS、非同步的錯誤傳播、Source Map 的建置流程。

現在已經有 Sentry、Bugsnag 等成熟服務把這些細節都處理好了,實務上請直接用。但親手做過一遍,你會對「瀏覽器裡的錯誤到底怎麼產生、怎麼被攔截、又為什麼會被抹掉」有完全不同的理解——而這份理解,在你排查那些查不到線索的線上錯誤時會非常值錢。

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