Node.js ERROR 带你快速理解 Node.js 的错误处理机制

ERROR简介

Node.js 的错误分为四类:

  • 标准 JavaScript 错误,如 EvalErrorSynctaxErrorRangeErrorReferenceErrorTypeErrorURIError
  • 系统错误,如通过程序我们想打开一个文件,但是系统中不存在这个文件,就会抛出系统错误
  • 通过程序代码 throw() 抛出的错误
  • 断言错误,通过模块 assert 抛出的错误

同步API和异步API

Node.js的API主要有两种风格,同步和异步,如何区分呢,大部分异步API一般都有一个回调函数 callback 作为其参数,而大部分同步API则不会,例如:

// 异步 API
const fs = require('fs');
fs.readFile('/etc/passwd', (err, data) => {
  if (err) console.log(err);
  else console.log(data);
});

// 同步 API
fs.readFileSync('/etc/passwd');

Node.js 风格的回调

Node.js 大部分的异步方法都接受一个回调函数作为参数,我们通过该回调函数的第一个参数来判断是否发生了错误,如果是 null,则没有发生错误,如果不是 null,则调用该方法出现了错误,我们管这种回调叫做 Node.js 风格的回调

const fs = require('fs');

fs.readFile('/some/file/that/does-not-exist', function(err, data){
  if (err) {
    console.error('There was an error', err);
    return;
  }
  console.log(data);
});

注意:如果想在异步方法的回调函数里面抛出错误,不要放在 try / catch 代码块中,这样不仅不会捕获到异常,而且未捕获的异常可能会造成程序停止

// 这样不会捕获异常:
const fs = require('fs');

try {
  fs.readFile('/some/file/that/does-not-exist', (err, data) => {
    // mistaken assumption: throwing here...
    if (err) {
      throw err; // 抛出错误,但是无法被捕获到
    }
  });
} catch (err) {
  // 无法被捕获到
  console.error(err);
}

因回调函数还没有执行,try / catch 代码已经执行完毕并退出,所以无法捕获错误。如果想捕获错误,可以使用 process.on('uncaughtException') (或者 Domain 模块来处理,但 Domain 模块已被新版本弃用,这里只是提一嘴,不推荐使用)方法来处理,可以把上面的代码改造成:

const fs = require('fs');

fs.readFile('/some/file/that/does-not-exist', (err, data) => {
    // mistaken assumption: throwing here...
    if(err) {
        throw err; 
    }
});

process.on('uncaughtException', (err) => {
    console.log(err);
})

错误传播和拦截

Node.js 支持多种机制来处理应用程序运行时发生的错误。如何处理这些错误完全取决于错误的类型和被调用的 API 的风格,所有的 JavaScript 错误和大部分同步 API 都用 try / catch 机制处理:

const fs = require('fs');
try {
  const m = 1;
  const n = m + z; // javaScript 错误
  fs.readFileSync('./test.js');  // 同步API
} catch (err) {
  // 在这处理错误
}

异步 API 分为两种处理方式:一种是 Node.js 回调风格的 API,前面已有介绍另一种方式:如果一个对象是一个 EventEmitter 时,如 StreamEvent 等模块,调用这个对象的异步方法时可以通过这个对象的 error 事件处理:

const net = require('net');
const connection = net.connect('localhost'); // EventEmitter

// 绑定 error 事件
connection.on('error', (err) => {
  // 处理 err
  console.error(err);
});

connection.pipe(process.stdout);

注意:如果不用 error 事件处理,我们的程序将会崩溃,该错误也可以用 process.on('uncaughtException') 来捕获

CLASS Error

Node.js 的错误机制不会解释为什么会发生错误,它只会通过追踪栈信息来尽可能的描述该错误

new Error(message)

创建一个 Error 实例,message 是个字符串,也可以是一个对象(如果是对象,则 Node.js 先会把这个对象转化成字符串,再调用 new Error(message)

Error.captureStackTrace(targetObject[, constructorOpt])

targetObject 对象设置一个 stack 属性,记录 targetObject 的追踪栈信息,constructorOpt是一个函数,如果传了该参数,则该参数会在追踪栈信息中隐藏:

function MyError() {
  Error.captureStackTrace(this, MyError); // MyError会在结果中隐藏
}
new MyError().stack;
Error.stackTraceLimit

追踪栈信息的条数,默认值是 10,可以设置为其他值,如果设置的不是数字或者是负数,则不会追踪任何栈信息

Error Object
  • error.code 错误码,参照 Node.js Error Codes
  • error.message 错误信息
  • error.stack 追踪栈信息
try {
  Error.stackTraceLimit = 15;
  const m = z++;
} catch (e) {
  console.log(e.stack);
}
// ReferenceError: z is not defined
//   at Object.<anonymous> (C:\Users\papa_\.WebStorm2017.3\config\consoles\ide\ide-scripting.js:78:13)
//   at Module._compile (module.js:635:30)
//   at Object.Module._extensions..js (module.js:646:10)
//   at Module.load (module.js:554:32)
//   at tryModuleLoad (module.js:497:12)
//   at Function.Module._load (module.js:489:3)
//   at Function.Module.runMain (module.js:676:10)
//   at startup (bootstrap_node.js:187:16)
//   at bootstrap_node.js:608:3
  • C:\Users\papa_\.WebStorm2017.3\config\consoles\ide\ide-scripting.js:78:13 带有有绝对路径的一般表示用户程序的调用
  • module.js:635:30 没有绝对路径的一般表示 Node.js 的调用
  • native 一个方法描述一般表示 V8 引擎的调用

结语:本文介绍了 Node.js 的错误异常处理机制,跟原生JS还是有很大的差别,合理的处理 ERROR 会使我们的程序更健壮也会让开发人员更容易地确定问题并解决;原文档中有关系统错误做了详细的说明,因为跟 linux 的系统错误类似,在这就不做解释了;大部分异步同步 API 的处理方式都是与本文所述一致的的,但有一些特殊的 API 可能处理的方式不同,使用的时候请查阅文档

简书作者 小菜荔枝原创 转载请联系作者获得授权

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

推荐阅读更多精彩内容

  • topics: 1.The Node.js philosophy 2.The reactor pattern 3....
    宫若石阅读 1,080评论 0 1
  • # 模块机制 node采用模块化结构,按照CommonJS规范定义和使用模块,模块与文件是一一对应关系,即加载一个...
    RichRand阅读 2,508评论 0 3
  • 虽然我是个不折不扣的女汉子,可是听当我到那些静静流淌的曲调却还是会突然变得沉默,会觉得很伤心,像是身在一条船上,...
    高卷卷咯阅读 272评论 0 0
  • #过一个传统年#幼儿园的时候我就知道元宵节要吃月饼(难道不是汤圆么)和做灯笼了,过年前,我在c+和小朋友们每个人都...
    bdc031d36324阅读 299评论 0 0
  • 今天是14号啦~大猫已经从太原回来两天了。将近三个多月没有见吧,可是回来到我身边的时候自然而熟悉。我想,他或者就是...
    余暖Ti阅读 341评论 1 0