JavaScript的事件驅(qū)動(dòng)范式增添了豐富的語(yǔ)言腊脱,也是讓使用JavaScript編程變得更加多樣化。如果將瀏覽器設(shè)想為JavaScript的事件驅(qū)動(dòng)工具龙亲,那么當(dāng)錯(cuò)誤發(fā)生時(shí)陕凹,某個(gè)事件就會(huì)被拋出。理論上可以認(rèn)為這些發(fā)生的錯(cuò)誤只是JavaScript中的簡(jiǎn)單事件鳄炉。
本文將會(huì)討論客戶端JavaScript中的錯(cuò)誤處理杜耙。主要介紹JavaScript中的易犯錯(cuò)誤、錯(cuò)誤處理拂盯、異步代碼編寫(xiě)等內(nèi)容佑女。
下面就讓我們一起看看如何正確處理JavaScript中的錯(cuò)誤。
Demo演示
本文中使用的demo(https://github.com/sitepoint-editors/ProperErrorHandlingJavaScript)可以在GitHub上找到谈竿,運(yùn)行之后會(huì)是這樣的頁(yè)面:
每個(gè)按鈕都會(huì)引發(fā)一個(gè)“錯(cuò)誤(Exception)”团驱,同時(shí)這個(gè)錯(cuò)誤會(huì)模擬出一個(gè)被拋出的異常TypeError。下面是模塊的定義:
// scripts/error.js
function error() {
var foo = {};
return foo.bar();
}
首先空凸,這個(gè)函數(shù)聲明了一個(gè)空對(duì)象foo店茶。需要注意的是,bar( )未在任何地方定義劫恒。接下來(lái)驗(yàn)證這個(gè)單元測(cè)試是否會(huì)引發(fā)“錯(cuò)誤”:
// tests/scripts/errorTest.js
it('throws a TypeError', function () {
should.throws(error, TypeError);
});
這個(gè)單元測(cè)試在Mocha中,同時(shí)在 Should.js中有測(cè)試聲明轿腺。Mocha是測(cè)試運(yùn)行工具两嘴,而Should.js是斷言庫(kù)。這個(gè)單元測(cè)試運(yùn)行在Node上族壳,不需要使用瀏覽器憔辫。
error( )定義一個(gè)空對(duì)象,然后嘗試訪問(wèn)一個(gè)方法仿荆。因?yàn)閎ar( )在對(duì)象內(nèi)不存在贰您,所以就會(huì)引發(fā)異常坏平。這種發(fā)生在像JavaScript這樣的動(dòng)態(tài)語(yǔ)言上的錯(cuò)誤,每個(gè)人可能都會(huì)遇到锦亦!
錯(cuò)誤處理(一)
通過(guò)以下代碼舶替,對(duì)上述錯(cuò)誤進(jìn)行處理:
// scripts/badHandler.js
function badHandler(fn) {
try {
return fn();
} catch (e) { }
return null;
}
該處理程序?qū)n作為輸入?yún)?shù),然后fn在處理函數(shù)內(nèi)部會(huì)被調(diào)用杠园。單元測(cè)試會(huì)體現(xiàn)出以上錯(cuò)誤處理程序的作用:
// 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);
});
如果出現(xiàn)問(wèn)題顾瞪,錯(cuò)誤處理程序就會(huì)返回null。fn( )回調(diào)函數(shù)可以指向一個(gè)合法的方法或錯(cuò)誤抛蚁。
以下的點(diǎn)擊事件會(huì)繼續(xù)進(jìn)行事件處理:
// 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));
這種處理方式在代碼中隱藏了一個(gè)錯(cuò)誤陈醒,并且很難發(fā)現(xiàn)。隱藏的錯(cuò)誤可能會(huì)花費(fèi)好幾個(gè)小時(shí)的調(diào)試時(shí)間瞧甩。尤其是在具有深度調(diào)用堆棧的多層解決方案中钉跷,這個(gè)錯(cuò)誤會(huì)更難發(fā)現(xiàn)。所以這是一種很差的錯(cuò)誤處理方式肚逸。
錯(cuò)誤處理(二)
下面是另一個(gè)錯(cuò)誤處理方式爷辙。
// 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);
});
以上對(duì)錯(cuò)誤的處理程序有明顯的改進(jìn)。在這里異常會(huì)調(diào)用堆棧進(jìn)行冒泡吼虎。同時(shí)錯(cuò)誤會(huì)展開(kāi)堆棧犬钢,這對(duì)調(diào)試非常有幫助。除了拋出異常思灰,解釋器還會(huì)沿著棧尋找另外的處理玷犹。這也帶來(lái)了可以從堆棧頂部處理錯(cuò)誤的可能。但這還是一種較差的錯(cuò)誤處理洒疚,需要我們從堆棧中一步步追溯原始的異常歹颓。
可以采用一種替代方案,用自定義的錯(cuò)誤方式來(lái)結(jié)束這種較差的錯(cuò)誤處理油湖。當(dāng)你向錯(cuò)誤中添加更多詳細(xì)信息時(shí)巍扛,會(huì)讓這種方法變得很有幫助。
例如:
// 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);
});
指定的錯(cuò)誤會(huì)添加更多詳細(xì)信息并保留原始的錯(cuò)誤消息乏德。有了這個(gè)改進(jìn)撤奸,以上的處理不再是較差的處理方式了,而是一個(gè)清晰有用的方式喊括。
經(jīng)過(guò)了上面的處理胧瓜,我們還收到了一個(gè)未處理的異常。接下來(lái)讓我們看看瀏覽器在處理錯(cuò)誤時(shí)郑什,有什么幫助府喳。
展開(kāi)堆棧
處理異常的一種方式是在調(diào)用堆棧的頂部加入try…catch。
比如說(shuō):
function main(bomb) {
try {
bomb();
} catch (e) {
// Handle all the error things
}
}
但是蘑拯,瀏覽器是事件驅(qū)動(dòng)的, JavaScript中的異常也是一個(gè)事件钝满。發(fā)生異常時(shí)兜粘,解釋器會(huì)暫停執(zhí)行并展開(kāi):
// scripts/errorHandlerDom.js
window.addEventListener('error', function (e) {
var error = e.error;
console.log(error);
});
此事件處理程序會(huì)捕獲任何執(zhí)行上下文中發(fā)生的錯(cuò)誤。各個(gè)目標(biāo)發(fā)生的錯(cuò)誤事件會(huì)觸發(fā)各種類型的錯(cuò)誤弯蚜。這種集中在代碼中的錯(cuò)誤處理是非常激進(jìn)的孔轴。你可以使用菊花鏈處理方式來(lái)處理特定的錯(cuò)誤。如果你遵循SOLID原則熟吏,就可以采用具有單一目的錯(cuò)誤處理方式距糖。這些處理程序可以隨時(shí)進(jìn)行注冊(cè),解釋器會(huì)循環(huán)執(zhí)行需要執(zhí)行的處理程序牵寺。代碼庫(kù)可以從try…catch塊中釋放出來(lái)悍引,這也使得調(diào)試變得容易。在JavaScript中帽氓,把錯(cuò)誤處理當(dāng)作事件處理很重要趣斤。
捕獲堆棧
在解決問(wèn)題時(shí),調(diào)用堆棧會(huì)非常有用黎休,同時(shí)瀏覽器正好可以提供這些信息浓领。雖然堆棧屬性不是標(biāo)準(zhǔn)的一部分,但是最新的瀏覽器已經(jīng)可以查看這些信息了势腮。
下面是在服務(wù)器上記錄錯(cuò)誤的示例:
// scripts/errorAjaxHandlerDom.js
window.addEventListener('error', function (e) {
var stack = e.error.stack;
var message = e.error.toString();
if (stack) {
message += ' ' + stack;
}
var xhr = new XMLHttpRequest();
xhr.open('POST', '/log', true);
// Fire an Ajax request with error details
xhr.send(message);
});
每個(gè)錯(cuò)誤處理都具有單個(gè)目的联贩,這樣可以保持代碼的DRY原則(目的單一,不要重復(fù)自己原則)捎拯。
在瀏覽器中泪幌,需要將事件處理添加到DOM。這意味著如果你正在構(gòu)建第三方庫(kù)署照,那么你的事件會(huì)與客戶端代碼共存祸泪。window.addEventListener( )會(huì)幫你進(jìn)行處理,同時(shí)也不會(huì)抹去現(xiàn)有的事件建芙。
這是服務(wù)器上日志的截圖:
可以通過(guò)命令提示符查看日志没隘,但是Windows上,日志是非動(dòng)態(tài)的禁荸。
通過(guò)日志可以清楚的看到右蒲,具體什么情況觸發(fā)了什么錯(cuò)誤。在調(diào)試時(shí)調(diào)用堆棧也會(huì)非常有用赶熟,所以不要低估調(diào)用堆棧的作用品嚣。
在JavaScript中,錯(cuò)誤信息僅適用于單個(gè)域钧大。因?yàn)樵谑褂脕?lái)自不用域的腳本時(shí),將會(huì)看不到任何錯(cuò)誤詳細(xì)信息罩旋。
一種解決方案是重新拋出錯(cuò)誤啊央,同時(shí)保留錯(cuò)誤消息:
try {
return fn();
} catch (e) {
throw new Error(e.message);
}
一旦重新啟動(dòng)了錯(cuò)誤備份眶诈,全局錯(cuò)誤處理程序就會(huì)完成其余的工作。確保你的錯(cuò)誤處理處在相同域中瓜饥,這樣會(huì)保留原始消息逝撬,堆棧和自定義錯(cuò)誤對(duì)象。
異步處理
JavaScript在運(yùn)行異步代碼時(shí)乓土,進(jìn)行下面的異常處理宪潮,會(huì)產(chǎn)生一個(gè)問(wèn)題:
// scripts/asyncHandler.js
function asyncHandler(fn) {
try {
// This rips the potential bomb from the current context setTimeout(function () { fn(); }, 1);
} catch (e) { }
}
通過(guò)單元測(cè)試來(lái)查看問(wèn)題:
// 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);
});
});
這個(gè)異常沒(méi)有被捕獲,我們通過(guò)單元測(cè)試來(lái)驗(yàn)證趣苏。盡管代碼包含了try…catch狡相,但是try…catch語(yǔ)句只能在單個(gè)執(zhí)行上下文中工作。當(dāng)異常被拋出時(shí)食磕,解釋器已經(jīng)脫離了try…catch尽棕,所以異常未被處理。Ajax調(diào)用也會(huì)發(fā)生同樣的情況彬伦。
所以滔悉,一種解決方案是在異步回調(diào)中捕獲異常:
setTimeout(function () {
try {
fn();
} catch (e) {
// Handle this async error
}
}, 1);
這種做法會(huì)比較奏效,但仍有很大的改進(jìn)空間单绑。
首先回官,這些try…catch block在整個(gè)區(qū)域糾纏不清。事實(shí)上搂橙,V8瀏覽器引擎不鼓勵(lì)在函數(shù)內(nèi)使用try … catch block歉提。V8是Chrome瀏覽器和Node中使用的JavaScript引擎。一種做法是將try…catch block移動(dòng)到調(diào)用堆棧的頂部份氧,但這卻不適用于異步代碼編程唯袄。
由于全局錯(cuò)誤處理可以在任何上下文中執(zhí)行,所以如果為錯(cuò)誤處理添加一個(gè)窗口對(duì)象蜗帜,那么就能保證代碼的DRY和SOLID原則恋拷。同時(shí)全局錯(cuò)誤處理也能保證你的異步代碼很干凈。
以下是該異常處理在服務(wù)器上的報(bào)告內(nèi)容厅缺。請(qǐng)注意蔬顾,輸出內(nèi)容會(huì)根據(jù)瀏覽器的不同而不同。
從錯(cuò)誤處理中可以看到湘捎,錯(cuò)誤來(lái)自于異步代碼的setTimeout( )功能诀豁。
結(jié)論
在進(jìn)行錯(cuò)誤處理時(shí),不要隱藏問(wèn)題窥妇,而應(yīng)該及時(shí)發(fā)現(xiàn)問(wèn)題舷胜,并采用各種方法追溯問(wèn)題的根源以便解決問(wèn)題。雖然編寫(xiě)代碼時(shí)活翩,時(shí)常難免會(huì)埋下錯(cuò)誤烹骨,但是我們也無(wú)須為錯(cuò)誤的發(fā)生過(guò)于感到羞愧翻伺,及時(shí)解決發(fā)現(xiàn)問(wèn)題從而避免更大的問(wèn)題發(fā)生,正是我們現(xiàn)在需要做的沮焕。