原文出处: Camilo Reyes 译文出处:葡萄城控件 javascript
JavaScript的事件驱动范式增添了丰富的语言,也是让使用JavaScript编程变得更加多样化。若是将浏览器设想为JavaScript的事件驱动工具,那么当错误发生时,某个事件就会被抛出。理论上能够认为这些发生的错误只是JavaScript中的简单事件。html
本文将会讨论客户端JavaScript中的错误处理。主要介绍JavaScript中的易犯错误、错误处理、异步代码编写等内容。java
下面就让咱们一块儿看看如何正确处理JavaScript中的错误。git
本文中使用的demo能够在GitHub上找到,运行以后会是这样的页面: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上,不须要使用浏览器。bash
error( )定义一个空对象,而后尝试访问一个方法。由于bar( )在对象内不存在,因此就会引起异常。这种发生在像JavaScript这样的动态语言上的错误,每一个人可能都会遇到!服务器
经过如下代码,对上述错误进行处理:dom
# 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( )功能。
在进行错误处理时,不要隐藏问题,而应该及时发现问题,并采用各类方法追溯问题的根源以便解决问题。虽然编写代码时,时常不免会埋下错误,可是咱们也无须为错误的发生过于感到羞愧,及时解决发现问题从而避免更大的问题发生,正是咱们如今须要作的。