本文將會討論客戶端JavaScript中的錯誤處理。主要介紹JavaScript中的易犯錯、錯誤處理、非同步程式碼編寫等內容。以下就讓我們一起來看看如何正確處理JavaScript中的錯誤
JavaScript的事件驅動範式增添了豐富的語言,也是讓使用JavaScript程式設計變得更加多元。如果將瀏覽器設想為JavaScript的事件驅動工具,那麼當錯誤發生時,某個事件就會被拋出。理論上可以認為這些發生的錯誤只是JavaScript中的簡單事件。
本文將會討論客戶端JavaScript中的錯誤處理。主要介紹JavaScript中的易犯錯、錯誤處理、非同步程式碼編寫等內容。
下面就讓我們一起看看如何正確處理JavaScript中的錯誤。
Demo示範
本文所使用的demo可以在GitHub上找到,運作之後會是這樣的頁面:
每個按鈕都會引發一個“錯誤(Exception)”,同時這個錯誤會模擬出一個被拋出的例外TypeError。下面是模組的定義:
// scripts/error.js function error() { var foo = {}; return foo.bar(); }
首先,這個函數宣告了一個空物件foo。需要注意的是,bar( )未在任何地方定義。接下來驗證這個單元測試是否會引發「錯誤」:
// tests/scripts/errorTest.js it('throws a TypeError', function () { should.throws(error, TypeError); });
這個單元測試在Mocha中,同時在 Should.js中有測試宣告。 Mocha是測試運行工具,而Should.js是斷言函式庫。這個單元測試運行在Node上,不需要使用瀏覽器。
error( )定義一個空對象,然後嘗試存取一個方法。因為bar( )在物件內不存在,所以就會引發異常。這種發生在像JavaScript這樣的動態語言上的錯誤,每個人可能都會遇到!
錯誤處理(一)
透過以下程式碼,對上述錯誤進行處理:
// scripts/badHandler.js function badHandler(fn) { try { return fn(); } catch (e) { } return null; }
此處理程序將fn當作輸入參數,然後fn在處理函數內部會被呼叫。單元測試會反映上述錯誤處理程序的作用:
// tests/scripts/badHandlerTest.js it('returns a value without errors', function() { var fn = function() { return 1; }; var result = badHandler(fn); result.should.equal(1); }); it('returns a null with errors', function() { var fn = function() { throw new Error('random error'); }; var result = badHandler(fn); should(result).equal(null); });
如果出現問題,錯誤處理程序就會傳回null。 fn( )回呼函數可以指向一個合法的方法或錯誤。
以下的點擊事件會繼續進行事件處理:
// scripts/badHandlerDom.js (function (handler, bomb) { var badButton = document.getElementById('bad'); if (badButton) { badButton.addEventListener('click', function () { handler(bomb); console.log('Imagine, getting promoted for hiding mistakes'); }); } }(badHandler, error));
這種處理方式在程式碼中隱藏了一個錯誤,並且很難發現。隱藏的錯誤可能會花費好幾個小時的調試時間。尤其是在具有深度呼叫堆疊的多層解決方案中,這個錯誤會更難發現。所以這是一種很差的錯誤處理方式。
錯誤處理(二)
下面是另一個錯誤處理方式。
// scripts/uglyHandler.js function uglyHandler(fn) { try { return fn(); } catch (e) { throw new Error('a new error'); } }
處理異常的方式如下所示:
// tests/scripts/uglyHandlerTest.js it('returns a new error with errors', function () { var fn = function () { throw new TypeError('type error'); }; should.throws(function () { uglyHandler(fn); }, Error); });
以上對錯誤的處理程序有明顯的改進。在這裡異常會呼叫堆疊進行冒泡。同時錯誤會展開堆疊,這對偵錯非常有幫助。除了拋出異常,解釋器還會沿著堆疊尋找另外的處理。這也帶來了可以從堆疊頂部處理錯誤的可能。但這還是一種較差的錯誤處理,需要我們從堆疊中一步步追溯原始的異常。
可以採用一種替代方案,用自訂的錯誤方式來結束這種較差的錯誤處理。當你在錯誤中添加更多詳細資訊時,會讓這種方法變得很有幫助。
例如:
// scripts/specifiedError.js // Create a custom error var SpecifiedError = function SpecifiedError(message) { this.name = 'SpecifiedError'; this.message = message || ''; this.stack = (new Error()).stack; }; SpecifiedError.prototype = new Error(); SpecifiedError.prototype.constructor = SpecifiedError; // scripts/uglyHandlerImproved.js function uglyHandlerImproved(fn) { try { return fn(); } catch (e) { throw new SpecifiedError(e.message); } } // tests/scripts/uglyHandlerImprovedTest.js it('returns a specified error with errors', function () { var fn = function () { throw new TypeError('type error'); }; should.throws(function () { uglyHandlerImproved(fn); }, SpecifiedError); });
指定的錯誤會新增更多詳細資訊並保留原始的錯誤訊息。有了這個改進,以上的處理不再是較差的處理方式了,而是一個清晰有用的方式。
經過了上面的處理,我們也收到了一個未處理的例外。接下來讓我們來看看瀏覽器在處理錯誤時,有什麼幫助。
展開堆疊
處理異常的一種方式是在呼叫堆疊的頂部加入try...catch。
比如說:
function main(bomb) { try { bomb(); } catch (e) { // Handle all the error things } }
但是,瀏覽器是事件驅動的, JavaScript中的例外也是一個事件。發生異常時,解釋器會暫停執行並展開:
// scripts/errorHandlerDom.js window.addEventListener('error', function (e) { var error = e.error; console.log(error); });
此事件處理程序會擷取任何執行上下文中發生的錯誤。各個目標發生的錯誤事件會觸發各種類型的錯誤。這種集中在程式碼中的錯誤處理是非常激進的。你可以使用菊花鏈處理方式來處理特定的錯誤。如果你遵循SOLID原則,就可以採用單一目的錯誤處理方式。這些處理程序可以隨時進行註冊,解釋器會循環執行需要執行的處理程序。程式碼庫可以從try...catch區塊中釋放出來,這也使得調試變得容易。在JavaScript中,把錯誤處理當作事件處理很重要。
捕获堆栈
在解决问题时,调用堆栈会非常有用,同时浏览器正好可以提供这些信息。虽然堆栈属性不是标准的一部分,但是最新的浏览器已经可以查看这些信息了。
下面是在服务器上记录错误的示例:
// scripts/errorAjaxHandlerDom.js window.addEventListener('error', function (e) { var stack = e.error.stack; var message = e.error.toString(); if (stack) { message += '\n' + stack; } var xhr = new XMLHttpRequest(); xhr.open('POST', '/log', true); // Fire an Ajax request with error details xhr.send(message); });
每个错误处理都具有单个目的,这样可以保持代码的DRY原则(目的单一,不要重复自己原则)。
在浏览器中,需要将事件处理添加到DOM。这意味着如果你正在构建第三方库,那么你的事件会与客户端代码共存。window.addEventListener( )会帮你进行处理,同时也不会抹去现有的事件。
这是服务器上日志的截图:
可以通过命令提示符查看日志,但是Windows上,日志是非动态的。
通过日志可以清楚的看到,具体什么情况触发了什么错误。在调试时调用堆栈也会非常有用,所以不要低估调用堆栈的作用。
在JavaScript中,错误信息仅适用于单个域。因为在使用来自不用域的脚本时,将会看不到任何错误详细信息。
一种解决方案是重新抛出错误,同时保留错误消息:
一旦重新启动了错误备
try { return fn(); } catch (e) { throw new Error(e.message); }
份,全局错误处理程序就会完成其余的工作。确保你的错误处理处在相同域中,这样会保留原始消息,堆栈和自定义错误对象。
异步处理
JavaScript在运行异步代码时,进行下面的异常处理,会产生一个问题:
// scripts/asyncHandler.js function asyncHandler(fn) { try { // This rips the potential bomb from the current context setTimeout(function () { fn(); }, 1); } catch (e) { } }
通过单元测试来查看问题:
// tests/scripts/asyncHandlerTest.js it('does not catch exceptions with errors', function () { // The bomb var fn = function () { throw new TypeError('type error'); }; // Check that the exception is not caught should.doesNotThrow(function () { asyncHandler(fn); }); });
这个异常没有被捕获,我们通过单元测试来验证。尽管代码包含了try...catch,但是try...catch语句只能在单个执行上下文中工作。当异常被抛出时,解释器已经脱离了try...catch,所以异常未被处理。Ajax调用也会发生同样的情况。
所以,一种解决方案是在异步回调中捕获异常:
setTimeout(function () { try { fn(); } catch (e) { // Handle this async error } }, 1);
这种做法会比较奏效,但仍有很大的改进空间。
首先,这些try...catch block在整个区域纠缠不清。事实上,V8浏览器引擎不鼓励在函数内使用try ... catch block。V8是Chrome浏览器和Node中使用的JavaScript引擎。一种做法是将try...catch block移动到调用堆栈的顶部,但这却不适用于异步代码编程。
由于全局错误处理可以在任何上下文中执行,所以如果为错误处理添加一个窗口对象,那么就能保证代码的DRY和SOLID原则。同时全局错误处理也能保证你的异步代码很干净。
以下是该异常处理在服务器上的报告内容。请注意,输出内容会根据浏览器的不同而不同。
从错误处理中可以看到,错误来自于异步代码的setTimeout( )功能。
结论
在进行错误处理时,不要隐藏问题,而应该及时发现问题,并采用各种方法追溯问题的根源以便解决问题。虽然编写代码时,时常难免会埋下错误,但是我们也无须为错误的发生过于感到羞愧,及时解决发现问题从而避免更大的问题发生,正是我们现在需要做的。
总结
以上是JavaScript中錯誤正確處理小結的詳細內容。更多資訊請關注PHP中文網其他相關文章!