如何优雅地在Node应用中进行错误处理

不知道你有没有遇到这样一种情况，某天你写的代码在线上突然发生错误，然后你打开控制台，却对着打过包的错误信息毫无头绪？又或者说是代码在node端出现了问题，你查看错误日志的时候，却发现日志文件中都是杂乱的错误堆栈信息。

其实上面这些问题都可以通过在代码中引入合适的错误机制进行解决。大部分时候，由于程序员在开发过程中更加关注需求的实现，反而会忽视一些底层的工作。而错误处理机制就相当于我们代码上的最后一道保险，在程序发生已知或者意外的问题的时候，可以让开发者在第一时间获取信息，从而快速定位并解决问题。

常用的错误处理机制

首先我们来了解一下目前前端领域到底有哪些错误处理机制。

try catch

try...catch这种错误处理机制一定是大家最熟悉的，Javascript语言内置的错误处理机制可以在检测到代码异常的时候直接进行捕获并处理。

function test() {
  try {
    throw new Error("error");
  } catch(err) {
    console.log("some error happened:");
  }
}

test()

node原生错误处理机制

大多数Node.js核心API都提供的是利用回调函数处理错误，例如：

const fs = require('fs');

function read() {
    fs.readFile("/some/file/does-not-exist", (err, data) => {
    if(err) {
      throw new Error("file not exist");
    }
    console.log(data);
  });
}

read();

通过回调函数的err参数来检查是否出现错误，再进行处理。之所以Node.js采用这种错误处理机制，是因为异步方法所产生的方法并不能简单地通过try...catch机制进行拦截。

promise

Promise是用于处理异步调用的规范，而其提供的错误处理机制，是通过catch方法进行捕获。

fs.mkdir("./temp").then(() => {
    fs.writeFile("./temp/foobar.txt", "hello");
}).catch(err => {
    console.log(err)
});

async/await + try catch

第三种错误处理机制是采用async/await语法糖加上try...catch语句进行的。这样做的好处是异步和同步调用都能够使用统一的方式进行处理了。

async function one() {
    await two();
}

async function two() {
    await "hello";
    throw new Error("error");
}

async function test() {
    try {
        await one();
    } catch(error) {
        console.log(error);
    }
}

test();

解决方案

promisify

如果你的代码中充斥着多种不同的错误处理模式，那么维护起来是十分困难的。而且代码的可读性也会大大降低。因此，这里推荐采用的统一的解决方案。对于同步代码来说，直接使用try...catch方式进行捕获处理即可，而对于异步代码来说，建议转换成Promise然后采用async/await + try...catch这种方式进行处理。这样风格统一，程序的健壮性也大大加强。例如下面这个数据库请求的代码：

const database = require("database");

function promiseGet(query) {
    return new Promise((resolve, reject) => {
        database.get(query, (err, result) => {
            if (err) {
                reject(err);
            } else {
                resolve(result);
            }
        })
    })
}

async function main() {
    await promiseGet("foo");
}

main();

自定义错误类型

直接使用系统原生的错误信息通常会显得太过单薄，不利于后续进一步的分析和处理。所以为了让代码的错误处理机制的功能更加强大，我们势必要多花点精力进行额外的改造。

可以通过扩展基础的Error类型来达到这一目的。

一般来说，要根据错误发生的位置采用不同的错误类型。

首先是应用层错误，它会保存额外的线索数据：

class ApplicationError extends Error {
  constructor(message, options = {}) {
    assert(typeof message === 'string');
    assert(typeof options === 'object');
    assert(options !== null);
    super(message);

    // Attach relevant information to the error instance
    // (e.g., the username).
    for (const [key, value] of Object.entries(options)) {
      this[key] = value;
    }
  }

  get name() {
    return this.constructor.name;
  }
}

接着，可以再定义用户接口的错误类型，该类型主要用于直接返回给客户端，比如错误状态码等等。

class UserFacingError extends ApplicationError {
    constructor(message, options = {}) {
        super(message, options);
    }
}

class BadRequestError extends UserFacingError {
  get statusCode() {
    return 400
  }
}

class NotFoundError extends UserFacingError {
  get statusCode() {
    return 404
  }
}

另外，对于底层的数据库错误来说，可能需要更加细节的错误信息。此时也可以根据业务需要进行自定义：

class DatabaseError extends ApplicationError {
  get toString() {
    return "Errored happend in query: " + this.query + "\n" + this.message;
  }
}

// 使用的话
throw new DatabaseError("Other message", {
  query: query
});

化繁为简，集中处理

express

有了基础的错误数据类型后，我们可以在代码里针对不同的错误类型采取不同的解决方案。
接下来，以Express应用为例讲解一下使用方法。

app.use('/user', (req, res, next) => {
  const data = await database.getData(req.params.userId);
  if (!data) {
    throw new NotFoundError("User not found")
  }
  
  // do other thing
});

// 错误处理中间件
app.use(async (err, req, res, next) => {
  if (err instanceof UserFacingError) {
    res.sendStatus(err.statusCode);
    // or
    res.status(err.statusCode).send(err.errorCode)
  } else {
    res.sendStatus(500)
  }
  
  // 记录日志
  await logger.logError(err, 'parameter:', req.params, 'User Data:', req.user);
    // 发送邮件
  await sendMailToAdminIfCritical();
})

具体到实际场景中，需要在不同的路由中抛出不同的错误类型，然后我们就可以通过在错误处理中间件中进行统一的处理。比如根据不同的错误类型返回不同的错误码。还可以进行记录日志，发送邮件等操作。

database

数据库发生错误的时候，除了常规的抛出错误，有时候你可能还需要进行额外的重试或回退操作，如：

// 发生网络错误的时候隔200ms,重试3次
function query(queryStr, token, repeatTime = 0, delay = 200) {
  try {
    await db.query(queryStr);
  } catch (err) {
    if (err instanceof NetworkError && repeatTime < 3) {
      query(queryStr, token, repeatTime + 1, delay);
    }
    
    throw err;
  }
}

未处理错误

对于未处理的错误来说，我们可以使用node.js的unhandledRejection事件进行监听：

process.on('unhandledRejection', error => {

  console.error('unhandledRejection', error);
    // To exit with a 'failure' code
  process.exit(1);
});

而且从Node.js 12.0开始，可以使用以下命令启动程序：

node app.js --unhandled-rejections

这样也能够在发现未处理异常的时候进行处理，官方支持了三种对应的处理模式：

strict: Raise the unhandled rejection as an uncaught exception.

warn: Always trigger a warning, no matter if the unhandledRejection hook is set or not but do not print the deprecation warning.

none: Silence all warnings.

总结

最后，总结一下。为了实现可扩展和可维护的错误处理机制，我们可以需要注意以下几个方面:

  • 使用自定义Error类，后续还能根据业务需要进行扩展
  • 将异步代码转换成Promise,然后统一使用async/await + try...catch的形式进行错误捕获
  • 尽量采用统一的错误处理中间件函数
  • 保持Error信息可理解，返回合适的错误状态和代码
  • 对于未处理的错误，要即使捕获并记录

——--转载请注明出处--———

微信扫描二维码，关注我的公众号.jpg

最后，欢迎大家关注我的公众号，一起学习交流。

参考资料

https://youtu.be/ArfAzp_bSq4
https://softwareontheroad.com/error-handling-nodejs/
https://github.com/goldbergyoni/nodebestpractices/blob/master/sections/errorhandling/centralizedhandling.md
https://michalzalecki.com/an-elegant-solution-for-handling-errors-in-express/
https://khalilstemmler.com/articles/enterprise-typescript-nodejs/functional-error-handling/

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 194,319评论 5赞 459
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 81,801评论 2赞 371
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 141,567评论 0赞 319
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 52,156评论 1赞 263
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 61,019评论 4赞 355
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 46,090评论 1赞 272
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 36,500评论 3赞 381
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 35,192评论 0赞 253
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 39,474评论 1赞 290
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,566评论 2赞 309
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,338评论 1赞 326
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 32,212评论 3赞 312
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 37,572评论 3赞 298
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,890评论 0赞 17
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,169评论 1赞 250
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 41,478评论 2赞 341
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 40,661评论 2赞 335