【原译】javascript 中的正确错误处理
mumu_cyl
8年前
<h3><strong>摘要</strong></h3> <p>这是关于JavaScript中异常处理的故事。如果你相信墨菲定律，那么任何事情都可能出错，不，一定会出错!这篇文章中我们来看下JavaScript中的出错处理。文章会覆盖异常处理使用的正反例，然后看下ajax的异步处理。</p> <p>JavaScript的事件驱动机制让JavaScript更加丰富，浏览器好比就是一个事件驱动的机器，错误也是一种事件。当一个错误发生时，一个事件就在某个点抛出。理论上，有人会说错误是Javascript中的简单事件。如果你觉得是这样，那你就要好好去看看了。另外这篇文章只关注浏览器端的JavaScript的情况。</p> <p>这篇文章将在《 Exceptional Exception Handling in JavaScript 》这篇文章的概念基础上进行解释。解释起来就是，当发生错误时，JavaScript会去调用栈检查异常事件。如果你对此不熟悉建议先去看看基础的东西。我们的目的是探索处理异常的必要性，接下来你会看到一个 try...catch 块语句，你要认真思考。</p> <h3><strong>例子</strong></h3> <p>例子的代码在 github 上，而且最终展示成这样：</p> <p style="text-align:center"><img src="https://simg.open-open.com/show/0e270ef1c3ee5c1dd9f3d1df8e872c00.jpg"></p> <p>所有的按钮点击是都会触发"炸弹"，这个炸弹模拟了一个抛出的 TypeError 异常。下面是这个模块单元测试的定义：</p> <pre> <code class="language-javascript">function error() { var foo = {}; return foo.bar(); }</code></pre> <p>开始时，这个函数定义了一个空的对象 foo ，注意 bar() 没有在任何地方定义，我们用一个测试用例来看下它是如何引爆炸弹的。</p> <pre> <code class="language-javascript">it('throws a TypeError', function () { should.throws(target, TypeError); });</code></pre> <p>这个单元测试是用 mocha 和 should.js 写的。 mocha 是一个测试框架， should.js 是一个断言库。如果你熟悉它们后，你会感觉写起来很爽。测试一般使用 it('description') 开始，然后在 should 中使用 pass/fail 结束。好消息是测试用例可以在node端运行而不需要浏览器。我建议多关注这些测试，因为它们能帮助我们提升代码的质量。</p> <p>正如所显示的， error() 定义了一个空的对象，然后尝试访问一个方法，因为 bar() 方法在对象中不存在而会抛出一个异常。使用JavaScript这种动态语言运行一定会出错。</p> <h3><strong>错误的方式</strong></h3> <p>对于一些错误的处理，我从按钮的而事件中抽离出异常处理的方式，下面是单元测试函数的代码：</p> <pre> <code class="language-javascript">function badHandler(fn) { try { return fn(); } catch (e) { } return null; }</code></pre> <p>这个处理函数接收一个 fn 回调函数作为输入，这个函数然后在处理器函数里面被调用，单元测试如下：</p> <pre> <code class="language-javascript">it('returns a value without errors', function() { var fn = function() { return 1; }; var result = target(fn); result.should.equal(1); }); it('returns a null with errors', function() { var fn = function() { throw Error('random error'); }; var result = target(fn); should(result).equal(null); });</code></pre> <p>如你所见，这个糟糕的处理函数如果有地方出错就会返回null，回调函数 fn() 可以指向一个正确的方法或者一个异常，下面的点击处理函数会显示最终的处理结果。</p> <pre> <code class="language-javascript">(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));</code></pre> <p>可恶的是，这里返回了一个null，当我想找哪里出了问题时整个人都蒙逼了。这种失败沉默的方式会影响用户体验和数据混乱。更令人崩溃的是，我花了几个小时来进行debugg，但却没有使用 try-catch ，这个糟糕的处理函数吞没了错误并认为它没有问题， 这样继续执行下去不会降低代码质量，但是隐藏的错误未来会让你花几个小时来debugg。在一个多层的深调用时，基本上不可能发现哪里出了问题。而在这些少数的地方使用 try-catch 是正确的。但是一旦进入错误处理函数，就比较糟糕了。</p> <p>失败沉默策略会让你不容易发现错误所在，JavaScript提供了一个更优雅的方式来处理这些问题。</p> <h3><strong>比较差的方式</strong></h3> <p>继续，是时候说下一个稍微好点的方法了。我先跳过事件绑定到dom上的部分。这个函数处理和刚刚我们看到的没什么不同。所不同的是单元测试中它处理异常的方式。</p> <pre> <code class="language-javascript">function uglyHandler(fn) { try { return fn(); } catch (e) { throw Error('a new error'); } } it('returns a new error with errors', function () { var fn = function () { throw new TypeError('type error'); }; should.throws(function () { target(fn); }, Error); });</code></pre> <p>这里定义在原来的基础上改进了。这里异常事件在调用栈中进行冒泡，我喜欢的是现在错误现在会离开方便debugg的调用栈。在这个异常中，解释器会遍历整个栈寻找另一个错误处理函数。这样就可以有机会在调用栈的顶端处理这些错误。不幸的是，因为这个方法，我不知道错误是从哪个地方抛出来的。所以我又得反向遍历这个栈找到错误异常的源头。但至少我知道某个地方出错了，并能找到是哪个地方抛出的错误。</p> <h3><strong>离开调用栈</strong></h3> <p>所以，一个抛出异常处理的方法是直接调用栈的顶端使用 try-catch ，就像：</p> <pre> <code class="language-javascript">function main(bomb) { try { bomb(); } catch (e) { // Handle all the error things } }</code></pre> <p>但是，记住我说的浏览器是事件驱动的。是的，JavaScript中的错误也不过是一个事件。解释器在当前的执行上下文中执行后释放。结果是，我们可以利用一个 onerror 的全局异常事件处理函数，它大概是这样的：</p> <pre> <code class="language-javascript">if(window.addEventListener){ window.addEventListener('error', function (e) { var error = e.error; console.log(error); }); }else if(window.attachEvent){ window.attachEvent('onerror', function (e) { var error = e.error; console.log(error); }); }else{ window.onerror = function(e){ var error = e.error; console.log(error); } }</code></pre> <p>这个处理函数能捕获任何执行上下文中的错误异常。包括任何类型的任何错误。而且它能定位到代码中的错误处理。就像其它任何事件一样，你能捕获特定错误的具体信息。这样能使异常处理器只专注于一件事情，如果你允许这样做的话。这些处理函数也可以在任何时候注册，解释器会尽可能的遍历更多的处理函数，我们再也不用使用 try-catch 块这种带有瑕疵的debug方式了。尤其是在对待像JavaScript这类事件驱动机制的语言时，onerror的优势就更大了</p> <p>现在我们可以使用全局处理函数来离开栈了，我们可以用来干什么呢。毕竟，调用栈还是存在的。</p> <h3><strong>捕获栈信息</strong></h3> <p>调用栈在定位问题时超级有用。好消息是，浏览器提供了这个信息。理所当然，查看错误异常中的栈属性不是标准的一部分，但是只在新的浏览器中可以使用。所以，你就可以这样来把错误日志发送给服务器了。</p> <pre> <code class="language-javascript">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); xhr.send(message); });</code></pre> <p>可能从代码样例来说不是很明显，但是上面的代码一定会出错。上面提到了，每个处理函数都只处理一个功能。我关心的是这些信息是怎样被服务器捕获的。如下：</p> <p style="text-align:center"><img src="https://simg.open-open.com/show/a8ff1a9b8a33943c6cf22ac5f50c1af7.jpg"></p> <p>这些信息来自FireFox 46的开发版本，通过一个正确的错误处理函数，记录了出错的情况。这里没必要隐藏错误，我可以看到什么地方出现的什么错误。这样代码debugg就很爽了。这些信息也可以保存在持续化缓存中以便于以后分析。</p> <p>调用栈对于debugg来说是很有用的，永远不要低估调用栈的力量。</p> <h3><strong>异步处理</strong></h3> <p>处理异步时，JavaScript的异步处理代码不在当前的指向上下文中，这意味着 try-catch 语句会有问题（不能捕获到异常）：</p> <pre> <code class="language-javascript">function asyncHandler(fn) { try { setTimeout(function () { fn(); }, 1); } catch (e) { } }</code></pre> <p>单元测试的结果如下：</p> <pre> <code class="language-javascript">it('does not catch exceptions with errors', function () { var fn = function () { throw new TypeError('type error'); }; failedPromise(function() { target(fn); }).should.be.rejectedWith(TypeError); });function failedPromise(fn) { return new Promise(function(resolve, reject) { reject(fn); }); }</code></pre> <p>我必须用promise包含这个处理器来获取这个错误。注意的是，一个未被处理的异常发生时，尽管我将代码使用 try-catch 包含起来了，是的， try-catch 只能在单一的作用域内有效。在一个异常被抛出的同时，解释器就会从 try-catch 中离开，ajax也是一样的。所以有两种选择，一种是在异步调用里面捕获异常：</p> <pre> <code class="language-javascript">setTimeout(function () { try { fn(); } catch (e) { // Handle this async error } }, 1);</code></pre> <p>这种方法很有效，但是很多地方可以改进。首先， try-catch 块在这里用很混乱。实际上，之前是这么做的，但是有问题。另外，V8引擎不鼓励 在函数中使用try-catch (V8 是chrome和nodejs中的JavaScript引擎)。它们的建议是最外层写这些块。</p> <p>所以我们该怎么办？我说过全局异常处理可以在任何执行上下文中执行，如果给window对象增加一个错误处理函数，就OK了。这样是不是既能处理捕获处理错误又能保持代码的优雅呢。全局的错误处理能让你的代码干净整洁。</p> <p>下面是服务器收集到的错误日志，注意的是如果你使用同样的代码再不同浏览器上执行，你会看到收集到的日志也是不同的：</p> <p style="text-align:center"><img src="https://simg.open-open.com/show/8b1d071cb4019de264a5939ae7b29bc3.jpg"></p> <p>这个处理函数甚至告诉我们错误是从异步代码中抛出的吗，它告诉我们来至 setTimeout() 函数。</p> <h3><strong>结论</strong></h3> <p>总得来说，进行异常处理至少有两种方法。一个是失败沉默的方法，在错误发生时忽略错误不作为而不影响后面的继续执行。另一种是发生后迅速找到错误发生的地方。明显我们知道那种方法更具有优势。我的选择是：不要隐藏错误。没人会因为你代码中有问题而鄙视你，用户多试一次是可以接受的。代码距离完美是很远的，错误也是不可避免的，重要的是你发现错误后会怎么做。</p> <p> </p> <p>来自：http://mp.weixin.qq.com/s?__biz=MzAwNzA0NTMzMQ==&mid=2653201956&idx=1&sn=f7b79ca27fffcaccfac71e8802d0bb37&scene=4#wechat_redirect</p> <p> </p>