JavaScript 中错误正确处理方式,你用对了吗?

JavaScript的事件驱动范式增添了丰富的语言,也是让使用JavaScript编程变得更加多样化。如果将浏览器设想为JavaScript的事件驱动工具,那么当错误发生时,某个事件就会被抛出。理论上可以认为这些发生的错误只是JavaScript中的简单事件。

本文将会讨论客户端JavaScript中的错误处理。主要介绍JavaScript中的易犯错误、错误处理、异步代码编写等内容。

下面就让我们一起看看如何正确处理JavaScript中的错误。

Demo演示

本文中使用的demo(https://github.com/sitepoint-editors/ProperErrorHandlingJavaScript)可以在GitHub上找到,运行之后会是这样的页面:

image

每个按钮都会引发一个“错误(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 += ' ' + stack;

}

var xhr = new XMLHttpRequest();

xhr.open('POST', '/log', true);

// Fire an Ajax request with error details

xhr.send(message);

});

每个错误处理都具有单个目的,这样可以保持代码的DRY原则(目的单一,不要重复自己原则)。

在浏览器中,需要将事件处理添加到DOM。这意味着如果你正在构建第三方库,那么你的事件会与客户端代码共存。window.addEventListener( )会帮你进行处理,同时也不会抹去现有的事件。

这是服务器上日志的截图:

image

可以通过命令提示符查看日志,但是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原则。同时全局错误处理也能保证你的异步代码很干净。

以下是该异常处理在服务器上的报告内容。请注意,输出内容会根据浏览器的不同而不同。

image

从错误处理中可以看到,错误来自于异步代码的setTimeout( )功能。

结论

在进行错误处理时,不要隐藏问题,而应该及时发现问题,并采用各种方法追溯问题的根源以便解决问题。虽然编写代码时,时常难免会埋下错误,但是我们也无须为错误的发生过于感到羞愧,及时解决发现问题从而避免更大的问题发生,正是我们现在需要做的。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,098评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,213评论 2 380
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 149,960评论 0 336
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,519评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,512评论 5 364
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,533评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,914评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,574评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,804评论 1 296
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,563评论 2 319
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,644评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,350评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,933评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,908评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,146评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,847评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,361评论 2 342

推荐阅读更多精彩内容

  • 如果你相信墨菲定律的话,任何事情如果会出问题,那么就一定会出问题。对于代码,即使我们有100%的自信没有问题,依然...
    小b狸猫阅读 164评论 0 0
  • Lua 5.1 参考手册 by Roberto Ierusalimschy, Luiz Henrique de F...
    苏黎九歌阅读 13,724评论 0 38
  • "use strict";function _classCallCheck(e,t){if(!(e instanc...
    久些阅读 2,027评论 0 2
  • Emulate 动词,企图匹敌或超越之义,往往借助于模仿 刚开始就觉得热这个词熟,查了下,原来就是模仿的意思。以前...
    鱼子酱阅读 762评论 0 2
  • 我们以为 我们的未来太大了 大到任何可描绘的人生都装不下的程度 当然了 后来我们就发现 这世界其实小的不得了 小得...
    哀慕熙荣阅读 157评论 0 1