NodeJS处理Express中异步错误


Posted in NodeJs onMarch 26, 2017

摘要

比起回调函数,使用 Promise 来处理异步错误要显得优雅许多。

结合 Express 内置的错误处理机制和 Promise 极大地降低产生未捕获错误(uncaught exception)的可能性。

Promise 在ES6中是默认选项。如果使用 Babel 转译,它也可以与 Generators 或者 Async/Await 相结合。

本文主要阐述如何在 Express 中使用错误处理中间件(error-handling middleware)来高效处理异步错误。在 Github 上有对应 代码实例 可供参考。

首先,让我们一起了解 Express 提供的开箱即用的错误处理工具。然后,我们将探讨如何使用 Promise, Generators 以及 ES7 的 async/await 来简化错误处理流程。

Express 内置的异步错误处理

在默认情况下,Express 会捕获所有在路由处理函数中的抛出的异常,然后将它传给下一个错误处理中间件:

app.get('/', function (req, res) {
 throw new Error('oh no!')
})
app.use(function (err, req, res, next) {
 console.log(err.message) // 噢!不!
})

对于同步执行的代码,以上的处理已经足够简单。然而,当异步程序在执行时抛出异常的情况,Express 就无能为力。原因在于当你的程序开始执行回调函数时,它原来的栈信息已经丢失。

app.get('/', function (req, res) {
 queryDb(function (er, data) {
  if (er) throw er
 })
})
app.use(function (err, req, res, next) {
 // 这里拿不到错误信息
})

对于这种情况,可以使用 next 函数来将错误传递给下一个错误处理中间件

app.get('/', function (req, res, next) {
 queryDb(function (err, data) {
  if (err) return next(err)
  // 处理数据

  makeCsv(data, function (err, csv) {
   if (err) return next(err)
   // 处理 csv

  })
 })
})
app.use(function (err, req, res, next) {
 // 处理错误
})

使用这种方法虽然一时爽,却带来了两个问题:

你需要显式地在错误处理中间件中分别处理不同的异常。

一些隐式异常并没有被处理(如尝试获取一个对象并不存在的属性)

利用 Promise 传递异步错误

在异步执行的程序中使用 Promise 处理任何显式或隐式的异常情况,只需要在 Promise 链尾加上 .catch(next) 即可。

app.get('/', function (req, res, next) {
 // do some sync stuff
 queryDb()
  .then(function (data) {
   // 处理数据
   return makeCsv(data)
  })
  .then(function (csv) {
   // 处理 csv
  })
  .catch(next)
})
app.use(function (err, req, res, next) {
 // 处理错误
})

现在,所有异步和同步程序都将被传递到错误处理中间件。棒棒的。

虽然 Promise 让异步错误的传递变得容易,但这样的代码仍然有一些冗长和刻板。这时候 promise generator 就派上了用场。

用 Generators 简化代码

如果你使用的环境原生支持 Generators,你可以手动实现以下的功能。不过这里我们将借用 Bluebird.coroutine 来说明如何使用 Promise generator 来简化刚才的代码。

尽管接下来的例子使用的是 bluebird ,其它 Promise 库(如 co)也都支持 Promise generator.

首先,我们需要使得 Express 路由函数与 Promise generator 兼容:

var Promise = require('bluebird')
function wrap (genFn) { // 1
  var cr = Promise.coroutine(genFn) // 2
  return function (req, res, next) { // 3
    cr(req, res, next).catch(next) // 4
  }
}

这个函数是一个高阶函数,它做了以下几件事情:(分别与代码片段中的注释对应)

以 Genrator 为唯一的输入

让这个函数懂得如何 yield promise

返回一个普通的 Express 路由函数

当这个函数被执行时,它会使用 coroutine 来 yield promise,捕获期间发生的异常,然后将其传递给 next 函数

借助这个函数,我们就可以这样构造路由函数:

app.get('/', wrap(function *(req, res) {
 var data = yield queryDb()
 // 处理数据
 var csv = yield makeCsv(data)
 // 处理 csv
}))
app.use(function (err, req, res, next) {
 // 处理错误
})

现在,Express 的异步错误处理流程的可读性已经近乎令人满意,而且你可以像写同步执行的代码一样去书写异步执行的代码,唯一不要忘了的就是 yield promises。

然而这还不是终点,ES7 的 async/await 提议可以让代码变得更简洁。

使用 ES7 async/await

ES7 async/await 的行为就像 Promise Generator 一样,只不过它可以被用到更多的地方(如类方法或者胖箭头函数)。

为了在 Express 中使用 async/await,同时优雅地处理异步错误,我们仍然需要一个与上文提到的 wrap 类似的函数:

let wrap = fn => (...args) => fn(...args).catch(args[2])
这样,我们就可以按底下这种方式书写路由函数:

app.get('/', wrap(async function (req, res) {
 let data = await queryDb()
 // 处理数据
 let csv = await makeCsv(data)
 // 处理 csv
}))

现在可以愉快地写代码了

有了对同步和异步错误的处理,你可以用新的方式来开发 Express App。但有两点需要注意:

要习惯使用 throw ,它使得你的代码目的明确,throw 会明确地将程序引到错误处理中间件,这对同步或异步的程序都是适用的。
遇到特殊情况,当你觉得有必要时,也可以自行 try/catch。

app.get('/', wrap(async (req, res) => {
   if (!req.params.id) {
    throw new BadRequestError('Missing Id')
   }
   let companyLogo
   try {
    companyLogo = await getBase64Logo(req.params.id)
   } catch (err) {
    console.error(err)
    companyLogo = genericBase64Logo
   }
  }))

要习惯使用 custom error classes ,如 BadRequestError,因为这可以让你在错误处理中间件中更方便地分类处理。

app.use(function (err, req, res, next) {
   if (err instanceof BadRequestError) {
    res.status(400)
    return res.send(err.message)
   }
   ...
  })

需要注意

  1. 以上介绍的方法要求所有异步操作必须返回 promise。如果你的异步操作是使用回调函数的方式,你需要将其转化成 promise。(可以直接使用 Bluebird.promisifyAll 这类函数)
  2. 事件发射器(如 steams)仍然会导致未捕获异常,你需要注意合理地处理这类情况:
NodeJs 相关文章推荐
nodejs实现获取某宝商品分类
May 28 NodeJs
Nodejs express框架一个工程中同时使用ejs模版和jade模版
Dec 28 NodeJs
Nodejs进阶:基于express+multer的文件上传实例
Nov 21 NodeJs
NodeJS配置HTTPS服务实例分享
Feb 19 NodeJs
NodeJS基础API搭建服务器详细过程记录
Apr 01 NodeJs
nodejs爬虫遇到的乱码问题汇总
Apr 07 NodeJs
nodejs集成sqlite使用示例
Jun 05 NodeJs
nodejs密码加密中生成随机数的实例代码
Jul 17 NodeJs
nodejs 如何手动实现服务器
Aug 20 NodeJs
Nodejs把接收图片base64格式保存为文件存储到服务器上
Sep 26 NodeJs
nodejs初始化init的示例代码
Oct 10 NodeJs
nodejs处理tcp连接的核心流程
Feb 26 NodeJs
简单好用的nodejs 爬虫框架分享
Mar 26 #NodeJs
nodejs开发——express路由与中间件
Mar 24 #NodeJs
详解NodeJS框架express的路径映射(路由)功能及控制
Mar 24 #NodeJs
NodeJS学习笔记之Module的简介
Mar 24 #NodeJs
详解nodejs中的process进程
Mar 19 #NodeJs
nodejs中使用HTTP分块响应和定时器示例代码
Mar 19 #NodeJs
nodejs中向HTTP响应传送进程的输出
Mar 19 #NodeJs
You might like
PHP和Mysql中转UTF8编码问题汇总
2015/10/10 PHP
Laravel 5.3 学习笔记之 配置
2016/08/28 PHP
js 图片随机不定向浮动的实现代码
2013/07/02 Javascript
Function.prototype.call.apply结合用法分析示例
2013/07/03 Javascript
JQuery事件e参数的方法preventDefault()取消默认行为
2013/09/26 Javascript
JavaScript格式化日期时间的方法和自定义格式化函数示例
2014/04/04 Javascript
angularjs封装$http为factory的方法
2017/05/18 Javascript
原生JS实现图片懒加载(lazyload)实例
2017/06/13 Javascript
JS执行控制之节流模式实例分析
2018/12/21 Javascript
PWA介绍及快速上手搭建一个PWA应用的方法
2019/01/27 Javascript
微信小程序学习笔记之表单提交与PHP后台数据交互处理图文详解
2019/03/28 Javascript
Vue开发之watch监听数组、对象、变量操作分析
2019/04/25 Javascript
Vue.js中provide/inject实现响应式数据更新的方法示例
2019/10/16 Javascript
webpack4 配置 ssr 环境遇到“document is not defined”
2019/10/24 Javascript
vue实现整屏滚动切换
2020/06/29 Javascript
[02:40]2018年度DOTA2最佳新人-完美盛典
2018/12/16 DOTA
[48:00]完美世界DOTA2联赛循环赛 Forest vs Inki BO2第二场 11.04
2020/11/04 DOTA
Python中文竖排显示的方法
2015/07/28 Python
python从入门到精通(DAY 3)
2015/12/20 Python
Python3实现发送QQ邮件功能(文本)
2017/12/15 Python
Python用 KNN 进行验证码识别的实现方法
2018/02/06 Python
Python的CGIHTTPServer交互实现详解
2018/02/08 Python
纯CSS3单页切换导航菜单界面设计的简单实现
2016/08/16 HTML / CSS
Static Nested Class 和 Inner Class的不同
2013/11/28 面试题
初中英语课后反思
2014/04/25 职场文书
四风查摆剖析材料
2014/10/10 职场文书
2014年护理部工作总结
2014/11/14 职场文书
优秀党务工作者先进事迹材料
2014/12/25 职场文书
幼儿园大班教师个人工作总结
2015/02/05 职场文书
总账会计岗位职责
2015/04/02 职场文书
工厂采购员岗位职责
2015/04/07 职场文书
毕业设计答辩开场白
2015/05/29 职场文书
大学生入党自传2015
2015/06/26 职场文书
不会写演讲稿,快来看看这篇文章!
2019/08/06 职场文书
十大必看国产动漫排名,魁拔上线,第二曾在日本播出
2022/03/18 国漫
WIN10使用IIS部署ftp服务器详细教程
2022/08/05 Servers