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


Posted in Javascript onJune 29, 2020

前言

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中出现未捕获异常的处理方法

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

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

进程崩溃优雅退出

关于错误捕获,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);
 }
});

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

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

这一次,即使右侧 /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
Javascript 相关文章推荐
InnerHtml和InnerText的区别分析
Mar 13 Javascript
jQuery图片切换插件jquery.cycle.js使用示例
Jun 16 Javascript
AngularJS实现textarea记录只能输入规定数量的字符并显示
Apr 26 Javascript
jQuery Easyui Datagrid实现单行的上移下移及保存移动的结果
Aug 15 Javascript
jquery 属性选择器(匹配具有指定属性的元素)
Sep 06 Javascript
Bootstrap table两种分页示例
Dec 23 Javascript
深入理解Angularjs向指令传递数据双向绑定机制
Dec 31 Javascript
实例详解JavaScript中setTimeout函数的执行顺序
Jul 12 Javascript
vue 利用路由守卫判断是否登录的方法
Sep 29 Javascript
详解微信小程序缓存--缓存时效性
May 02 Javascript
Taro小程序自定义顶部导航栏功能的实现
Dec 17 Javascript
TS 类型兼容教程示例详解
Sep 23 Javascript
在Vue中使用antv的示例代码
Jun 29 #Javascript
vue实现一个6个输入框的验证码输入组件功能的实例代码
Jun 29 #Javascript
纯JS开发baguetteBox.js响应式画廊插件
Jun 28 #Javascript
JavaScript图片旋转效果实现方法详解
Jun 28 #Javascript
javascript+css实现俄罗斯方块小游戏
Jun 28 #Javascript
详解小程序横屏方案对比
Jun 28 #Javascript
微信小程序实现上传多张图片、删除图片
Jul 29 #Javascript
You might like
POSIX 风格和兼容 Perl 风格两种正则表达式主要函数的类比(preg_match, preg_replace, ereg, ereg_replace)
2010/10/12 PHP
PHP输出英文时间日期的安全方法(RFC 1123格式)
2014/06/13 PHP
laravel5.4生成验证码的实例讲解
2017/08/05 PHP
php输出控制函数和输出函数生成静态页面
2019/06/27 PHP
javascript getElementsByName()的用法说明
2009/07/31 Javascript
js防止表单重复提交实现代码
2012/09/05 Javascript
jQuery入门基础知识学习指南
2015/08/14 Javascript
JavaScript的设计模式经典之建造者模式
2016/02/24 Javascript
jQuery侧边栏实现代码
2016/05/06 Javascript
jQuery模仿单选按钮选中效果
2016/06/24 Javascript
jquery datatable服务端分页
2016/08/31 Javascript
打造自己的jQuery插件入门教程
2016/09/23 Javascript
微信小程序  简单实例(阅读器)的实例开发
2016/09/29 Javascript
js时间戳格式化成日期格式的多种方法介绍
2017/02/16 Javascript
vue模板语法-插值详解
2017/03/06 Javascript
基于angular-utils-ui-breadcrumbs使用心得(分享)
2017/11/03 Javascript
解决vue项目nginx部署到非根目录下刷新空白的问题
2018/09/27 Javascript
详解vue如何使用rules对表单字段进行校验
2018/10/17 Javascript
在JavaScript中使用严格模式(Strict Mode)
2019/06/13 Javascript
JavaScript基于用户照片姓名生成海报
2020/05/29 Javascript
JS数据类型判断的几种常用方法
2020/07/07 Javascript
Vue使用CDN引用项目组件,减少项目体积的步骤
2020/10/30 Javascript
浅谈python和C语言混编的几种方式(推荐)
2017/09/27 Python
matlab中二维插值函数interp2的使用详解
2020/04/22 Python
Python-for循环的内部机制
2020/06/12 Python
Python手动或自动协程操作方法解析
2020/06/22 Python
英国家用电器购物网站:Hughes
2018/02/23 全球购物
意大利辅助药品、药物和补品在线销售:FarmaEurope
2020/04/29 全球购物
网络工程师面试(三木通信技术有限公司)
2013/06/05 面试题
财务人员个人自荐信范文
2013/09/26 职场文书
平安校园建设方案
2014/05/02 职场文书
大学生交通专业求职信
2014/09/01 职场文书
2014年计生工作总结
2014/11/21 职场文书
2015年班主任个人工作总结
2015/03/31 职场文书
大学军训心得体会800字
2016/01/11 职场文书
攻略丨滑雪究竟该选哪款对讲机?
2022/02/18 无线电