Node.js中出现未捕获异常的处理方法

 更新时间:2020年06月29日 08:33:55   作者:五月君  
这篇文章主要给大家介绍了关于Node.js中出现未捕获异常的处理方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面来一起学习学习吧

前言

Node.js 程序运行在单进程上,应用开发时一个难免遇到的问题就是异常处理,对于一些未捕获的异常处理起来,也不是一件容易的事情。

未捕获异常的程序

下面展示了一段简单的应用程序,如下所示:

const http = require('http');
const PORT = 3000;
const server = http.createServer((req, res) => {
 if (req.url === '/error') {
  a.b;
  res.end('error');
 } else {
  setTimeout(() => res.end('ok!'), 1000 * 10);
 }
});

 
server.listen(PORT, () => console.log(`port is listening on ${PORT}.`));

运行以上程序,在右侧第二个窗口中执行了 /error 路由,因为没有定义 a 这个对象,则会引发错误。

进程崩溃退出之后导致整个应用程序也将崩溃,左侧是一个延迟的响应,也将无法正常工作。

这是一个头疼的问题,不要紧,下文我们将会学到一个优雅退出的方案。

进程崩溃优雅退出

关于错误捕获,Node.js 官网曾提供了一个模块 domain 来实现,但是现在已废弃了所以就不再考虑了。

之前在看 CNPM 这个项目时看到了以下关于错误退出的一段代码:

// https://github.com/cnpm/cnpmjs.org/blob/master/worker.js#L18
graceful({
 server: [registry, web],
 error: function (err, throwErrorCount) {
  if (err.message) {
   err.message += ' (uncaughtException throw ' + throwErrorCount + ' times on pid:' + process.pid + ')';
  }
  console.error(err);
  console.error(err.stack);
  logger.error(err);
 }
});

上述使用的是 graceful 这个模块,在 NPM 上可以找到。

实现一个 graceful.js

实现一个 graceful 函数,初始化加载时注册 uncaughtException、unhandledRejection 两个错误事件,分别监听未捕获的错误信息和未捕获的 Promise 错误信息。

const http = require('http');

/**
 * graceful
 * @param { Number } options.killTimeout 超时时间
 * @param { Function } options.onError 产生错误信息会执行该回调函数
 * @param { Array } options.servers Http Server
 * @returns
 */
function graceful(options = {}) {
 options.killTimeout = options.killTimeout || 1000 * 30;
 options.onError = options.onError || function () {};
 options.servers= options.servers || [];
 process.on('uncaughtException', error => handleUncaughtException(error, options));
 process.on('unhandledRejection', error => handleUnhandledRejection(error, options));
}

handleUncaughtException、handleUnhandledRejection 分别接收相应的错误事件,执行应用传入的 onError() 将错误信息进行回传,最后调用 handleError()。

const throwCount = {
 uncaughtException: 0,
 unhandledRejection: 0
};
function handleUncaughtException(error, options) {
 throwCount.uncaughtException += 1;
 options.onError(error, 'uncaughtException', throwCount.uncaughtException);

 if (throwCount.uncaughtException > 1) return;
 handleError(options);
};

function handleUnhandledRejection(error, options) {
 throwCount.unhandledRejection += 1;
 options.onError(error, 'unhandledRejection', throwCount.unhandledRejection);

 if (throwCount.unhandledRejection > 1) return;
 handleError(options);
}

HandleError 方法为核心实现,首先遍历应用传入的 servers,监听 request 事件,在未捕获错误触发之后,如果还有请求链接,则关闭当前请求的链接。

之后,执行 setTimeout 延迟退出,也就是最大可能的等待之前链接处理完成。

function handleError(options) {
 const { servers, killTimeout } = options;
 // 关闭当前请求的链接
 for (const server of servers) {
  console.log('server instanceof http.Server: ', server instanceof http.Server);
  if (server instanceof http.Server) {
   server.on('request', (req, res) => {
    req.shouldKeepAlive = false;
    res.shouldKeepAlive = false;
    if (!res._header) {
     res.setHeader('Connection', 'close');
    }
   });
  }
 }

 // 延迟退出
 const timer = setTimeout(() => {
  process.exit(1);
 }, killTimeout);
 
 if (timer && timer.unref) {
  timer.unref();
 }
}
module.exports = graceful;

应用程序中使用上述实现

加载上述 graceful.js 使用起来很简单只需要在文件尾部,加载 graceful 函数并传入相应参数即可。

const graceful = require('./graceful.js');
...
server.listen(PORT, () => console.log(`port is listening on ${PORT}.`));

graceful({
 servers: [server],
 onError: (error, type, throwErrorCount) => {
  console.log('[%s] [pid: %s] [throwErrorCount: %s] %s: %s', new Date(), process.pid, throwErrorCount, type, error.stack || error);
 }
});

再次运行应用程序,看看效果:

这一次,即使右侧 /error 路由产生未捕获异常,也将不会引起左侧请求无法正常响应。

Graceful 模块

最后推荐一个 NPM 模块 graceful,引用文档中的一句话:“It's the best way to handle uncaughtException on current situations.”

该模块还提供了对于 Node.js 中 Cluster 模块的支持。

安装

$ npm install graceful -S

应用

如果一个进程中有多个 Server,将它们添加到 servers 中即可。

const graceful = require('graceful');
...

graceful({
 servers: [server1, server2, restapi],
 killTimeout: '15s',
});

总结

如果你正在使用 Node.js 对于异常你需要有些了解,上述讲解的两个异常事件可以做为你的最后补救措施,但是不应该当作 On Error Resume Next(出了错误就恢复让它继续)的等价机制。

到此这篇关于Node.js中出现未捕获异常处理方法的文章就介绍到这了,更多相关Node.js未捕获异常内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

Reference

  • nodejs.cn/api/process.html
  • www.npmjs.com/package/graceful

相关文章

  • 深入理解Node.js中通用基础设计模式

    深入理解Node.js中通用基础设计模式

    大家在谈到设计模式时最先想到的就是 singletons, observers(观察者) 或 factories(工厂方法)。本文重点给大家介绍Node.JS一些基础模式的实现方法,感兴趣的朋友跟随脚本之家小编一起学习吧
    2017-09-09
  • Node.js DES加密的简单实现

    Node.js DES加密的简单实现

    下面小编就为大家带来一篇Node.js DES加密的简单实现。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2016-07-07
  • nodejs关于中间件解析

    nodejs关于中间件解析

    这篇文章主要介绍了nodejs关于中间件解析,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-12-12
  • 解决下载了nodejs但npm -v没有反应问题的全过程

    解决下载了nodejs但npm -v没有反应问题的全过程

    最近工作中遇到了个问题,node安装成功,但npm无法使用,所以下面这篇文章主要给大家介绍了关于下载了nodejs但npm -v没有反应问题解决的相关资料,需要的朋友可以参考下
    2022-08-08
  • Node.js中,在cmd界面,进入退出Node.js运行环境的方法

    Node.js中,在cmd界面,进入退出Node.js运行环境的方法

    今天小编就为大家分享一篇Node.js中,在cmd界面,进入退出Node.js运行环境的方法,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2018-05-05
  • node.js去水印方法实例分析

    node.js去水印方法实例分析

    这篇文章主要介绍了node.js去水印方法,结合实例形式分析了node.js基于第三方平台实现去水印的相关交互与操作技巧,需要的朋友可以参考下
    2023-04-04
  • 详解如何优雅在webpack项目实现mock服务器

    详解如何优雅在webpack项目实现mock服务器

    这篇文章主要为大家介绍了详解如何优雅在webpack项目实现mock服务器,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-02-02
  • node中modules.exports与exports导出的区别

    node中modules.exports与exports导出的区别

    这篇文章主要介绍了node中modules.exports与exports导出的区别,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-06-06
  • 详解Node.js如何处理ES6模块

    详解Node.js如何处理ES6模块

    学习JavaScript语言,你会发现它有两种格式的模块。一种是ES6模块,简称ESM;另一种是Node.js专用的CommonJS模块,简称 CJS。这两种模块不兼容。很多人使用Node.js,只会用require()加载模块,遇到ES6模块就不知道该怎么办。本文就来谈谈ES6模块在Node.js里面怎么使用。
    2021-05-05
  • Nodejs实现多人同时在线移动鼠标的小游戏分享

    Nodejs实现多人同时在线移动鼠标的小游戏分享

    这篇文章主要介绍了Nodejs实现多人同时在线移动鼠标的小游戏分享,本文给出了服务器端和客户端代码以及运行方法,需要的朋友可以参考下
    2014-12-12

最新评论