window.onerror 是前端錯誤收集最直接的入口。它看起來只有一行,但參數意義、觸發範圍、瀏覽器差異與跨域限制,每一項都有細節值得確認。
onerror 預設有三個入參:
・msg:錯誤訊息
・url:錯誤所在的檔案
・line:錯誤所在的程式碼行號(整數)
window.onerror = function (msg, url, line) {
// some code
};
若寫成 <body onerror="some code"> 的形式,則要透過 arguments[0]、arguments[1]、arguments[2] 依序取得這三個值。
最常見的用法是 JS 容錯:
window.onerror = function () { return true; }
透過設定 returnValue = true 或直接 return true,可以阻止瀏覽器顯示錯誤訊息。但要清楚它不會攔住 script debugger 彈出的除錯視窗。
另一個關鍵限制:只有執行期錯誤才會觸發 onerror,語法錯誤不會。這條規則解釋了很多「明明有錯卻沒被捕捉到」的困惑。
能引發 onerror 的情況有三類:
・執行期錯誤,例如無效的物件參照或安全限制
・載入錯誤,例如圖片讀不到
・在 IE9 中,取得多媒體資料失敗也會引發
另外,<script> 標籤本身不支援 onerror(詳見後面的相容性段落)。定義在 <body> 上的 onerror 屬性相當於 window.onerror——實測 Firefox、Opera 支援,IE9 與 Chrome 則無反應。
QuirksMode 整理的支援情況:
・Chrome 13+
・Firefox 6.1+
・Internet Explorer 5.5+
・Safari 5.1+
・Opera 11.61+(QuirksMode 測到 11.51 仍不支援)
除 window 物件外,支援 onerror 的元素:
・<img>:全瀏覽器支援
・<script>:IE9 / IE10 / Safari 5.1+ / Chrome 13+ 支援
・<css> 與 <iframe>:不支援 onerror
這是最容易讓人白忙一場的問題。對於引用自外部網域的 js 檔案,Webkit 與 Mozilla 系瀏覽器會竄改原始錯誤訊息,最後傳到 onerror 的三個參數會變成:
"Script error.", "", 0
也就是說,若 a.com/index.html 引入了 b.com/g.js,而 g.js 出錯,最終 onerror 收到的訊息會被抹掉,只剩一個固定字串。
瀏覽器這樣做是基於兩個事實:<script> 能執行非同源下的第三方檔案;而 <script> 會忽略載入檔案的 MIME 型別,一律當腳本執行。在攻擊場景中,惡意頁面引入正常頁面的 js,該 js 會自動執行,若發生異常而觸發報錯,錯誤訊息可能洩漏敏感資料,而這些訊息最終會被惡意頁面的 onerror 讀走。
實測存在此特性的瀏覽器(當時最新版)包含 Firefox、Chrome、Safari、Opera。
Adam Barth(Google Chrome 安全性團隊)建議的方案是使用 CORS(Cross-Origin Resource Sharing)。做法是在頁面中引入外部 js 時加上 crossorigin 屬性(類似 <img> 的 CORS 屬性):
<script src="//other.com/g.js" crossorigin></script>
伺服器收到請求時,在 HTTP Header 中加上授權欄位(可以是具體域名或 *):
Access-Control-Allow-Origin: *
瀏覽器確認該 js 已授權目前頁面所屬網域,就不再竄改傳遞給 onerror 的錯誤訊息。此方案已在較新版本的 Chrome 與 Firefox 中支援。
下面這個範例示範如何把三個參數印出來:
<SCRIPT>
window.onerror = fnErrorTrap;
function fnErrorTrap(sMsg, sUrl, sLine) {
oErrorLog.innerHTML = "<b>An error was thrown and caught.</b><p>";
oErrorLog.innerHTML += "Error: " + sMsg + "<br>";
oErrorLog.innerHTML += "Line: " + sLine + "<br>";
oErrorLog.innerHTML += "URL: " + sUrl + "<br>";
return false;
}
function fnThrow() {
eval(oErrorCode.value);
}
</SCRIPT>
<INPUT TYPE="text" ID="oErrorCode" VALUE="someObject.someProperty=true;">
<INPUT TYPE="button" VALUE="Throw Error" onclick="fnThrow()">
<P>
<DIV ID="oErrorLog"></DIV>
更簡潔的探測寫法是用 arguments 印出全部參數:
<script type="text/javascript">
window.onerror = testError;
function testError() {
arglen = arguments.length;
var errorMsg = "參數個數:" + arglen + "個";
for (var i = 0; i < arglen; i++) {
errorMsg += "/n參數" + (i + 1) + ":" + arguments[i];
}
alert(errorMsg);
window.onerror = null;
return true;
}
function test() { error }
test()
</script>
在 IE 中執行會看到:
參數個數:3個
參數1:'error' 未定義
參數2:file://E:/.../testError.html
參數3:14
由此可確認三個參數分別是錯誤訊息、錯誤頁面的 url、錯誤行號。
1. return true 可以壓掉系統錯誤提示。在函式末尾加上 return true,IE 就不會跳出系統級的錯誤視窗。
2. 只捕捉第一次錯誤。頁面若發生多次錯誤,onerror 只處理第一次,後續程式會被終止。
3. 並非所有錯誤都能捕捉。它能抓到函式外或函式內的執行錯誤,例如 adasdf; 或未定義變數的呼叫;但語法層面的錯誤(例如函式宣告寫壞)仍會直接彈出系統錯誤訊息。這與前面提到的「語法錯誤不觸發 onerror」是同一件事。
4. 跨瀏覽器行為一致。IE 與 Firefox 的觸發方式相同,都能拿到那三個參數。
值得一看的官方文件:
・IE:msdn.microsoft.com/en-us/library/cc197053.aspx
・Firefox:developer.mozilla.org/en/DOM/window.onerror
・Opera:dev.opera.com/articles/view/better-error-handling-with-window-onerror/
・W3C Wiki:www.w3.org/wiki/DOM/window.onerror
理解 onerror 的價值不只是「壓掉紅色錯誤」,而在於它是主動收集線上錯誤的唯一低成本入口——前提是你得知道它在跨域與語法錯誤這兩種情況下會什麼都不告訴你。