Node.js Express 异步错误处理最佳实践

Node.js Express 异步错误处理最佳实践

摘要

相较于传统的回调函数模式，采用 Promise 来处理异步错误能够显著提升代码的优雅程度与可维护性。

将 Express 框架内置的错误处理机制与 Promise 结合使用，能够大幅降低产生未捕获异常（uncaught exception）的风险。

Promise 已是 ES6 标准中的默认特性。若开发环境需兼容旧版本并通过 Babel 进行转译，Promise 亦可与 Generators 或 Async/Await 语法无缝结合。

本文重点阐述如何在 Express 框架中利用错误处理中间件（error-handling middleware）高效地处理异步错误。相关代码实例已托管于 Github，供读者参考 。

首先，我们将解析 Express 提供的开箱即用的错误处理工具；随后，深入探讨如何借助 Promise、Generators 以及 ES7 的 async/await 特性来简化错误处理流程。

Express 内置的异步错误处理

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 简化代码

若运行环境原生支持 Generators，开发者可手动实现相关功能。但在本例中，我们将借用 Bluebird.coroutine 来演示如何利用 Promise Generator 简化前述代码。

尽管下文示例使用的是 Bluebird 库，其他支持 Promise Generator 的库（如 co）同样适用此方法。

首先，我们需要使 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
  }
}

该函数作为一个高阶函数，主要执行以下操作（与代码片段中的注释一一对应）：

接收 Generator 函数作为唯一输入参数。

使该函数具备处理 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

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 应用。但需注意以下两点：

应习惯使用 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
   }
  }))

应习惯使用自定义错误类（如 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. 事件发射器（如 streams）仍可能导致未捕获异常，需注意合理处理此类情况。