# 错误处理

错误处理是指 Express 如何捕获和处理同步和异步发生的错误。Express 带有一个默认的错误处理程序，因此您无需编写自己的程序即可开始使用。

# 捕捉错误

确保 Express 捕获运行路由处理程序和中间件时发生的所有错误非常重要。

路由处理程序和中间件内的同步代码中发生的错误不需要额外的工作。如果同步代码抛出错误，Express 将捕获并处理它。例如：

app.get('/', (req, res) => {
  throw new Error('BROKEN') // Express will catch this on its own.
})

对于路由处理程序和中间件调用的异步函数返回的错误，您必须将它们传递给 next() 函数，Express 将在其中捕获并处理它们。例如：

app.get('/', (req, res, next) => {
  fs.readFile('/file-does-not-exist', (err, data) => {
    if (err) {
      next(err) // Pass errors to Express.
    } else {
      res.send(data)
    }
  })
})

从 Express 5 开始，返回 Promise 的路由处理程序和中间件将在拒绝或抛出错误时自动调用 next(value)。例如：

app.get('/user/:id', async (req, res, next) => {
  const user = await getUserById(req.params.id)
  res.send(user)
})

如果 getUserById 抛出错误或拒绝，next 将使用抛出的错误或拒绝的值调用。如果没有提供拒绝值，则将使用 Express 路由提供的默认错误对象调用 next。

如果您将任何内容传递给 next() 函数（字符串 'route' 除外），Express 会将当前请求视为错误，并将跳过任何剩余的非错误处理路由和中间件函数。

如果序列中的回调不提供数据，只提供错误，您可以简化此代码，如下所示：

app.get('/', [
  function (req, res, next) {
    fs.writeFile('/inaccessible-path', 'data', next)
  },
  function (req, res) {
    res.send('OK')
  }
])

在上面的例子中，next 是作为 fs.writeFile 的回调提供的，无论是否有错误都会调用它。如果没有错误，则执行第二个处理程序，否则 Express 会捕获并处理错误。

您必须捕获路由处理程序或中间件调用的异步代码中发生的错误，并将它们传递给 Express 进行处理。例如：

app.get('/', (req, res, next) => {
  setTimeout(() => {
    try {
      throw new Error('BROKEN')
    } catch (err) {
      next(err)
    }
  }, 100)
})

上面的示例使用 try...catch 块来捕获异步代码中的错误并将它们传递给 Express。如果 try...catch 块被省略，Express 将不会捕获错误，因为它不是同步处理程序代码的一部分。

使用 Promise 可以避免 try...catch 块的开销，或者在使用返回 Promise 的函数时。例如：

app.get('/', (req, res, next) => {
  Promise.resolve().then(() => {
    throw new Error('BROKEN')
  }).catch(next) // Errors will be passed to Express.
})

由于 Promise 自动捕获同步错误和被拒绝的 Promise，您可以简单地提供 next 作为最终的 catch 处理程序，Express 将捕获错误，因为 catch 处理程序将错误作为第一个参数。

您还可以使用一系列处理程序来依赖同步错误捕获，方法是将异步代码减少到微不足道的程度。例如：

app.get('/', [
  function (req, res, next) {
    fs.readFile('/maybe-valid-file', 'utf-8', (err, data) => {
      res.locals.data = data
      next(err)
    })
  },
  function (req, res) {
    res.locals.data = res.locals.data.split(',')[1]
    res.send(res.locals.data)
  }
])

上面的例子有几个来自 readFile 调用的琐碎语句。如果 readFile 导致错误，则将错误传递给 Express，否则您将在链中的下一个处理程序中快速返回同步错误处理的世界。然后，上面的示例尝试处理数据。如果失败，则同步错误处理程序将捕获它。如果你在 readFile 回调中完成了这个处理，那么应用程序可能会退出并且 Express 错误处理程序不会运行。

无论您使用哪种方法，如果您希望 Express 错误处理程序被调用并且应用程序能够继续存在，您必须确保 Express 接收到错误。

# 默认错误处理程序

Express 带有一个内置的错误处理程序，可以处理应用程序中可能遇到的任何错误。这个默认的错误处理中间件函数被添加到中间件函数栈的末尾。

如果您将错误传递给 next() 并且您没有在自定义错误处理程序中处理它，它将由内置错误处理程序处理；错误将通过堆栈跟踪写入客户端。堆栈跟踪不包含在生产环境中。

将环境变量 NODE_ENV 设置为 production，以在生产模式下运行应用程序。

写入错误时，会在响应中添加以下信息：

res.statusCode 由 err.status（或 err.statusCode）设置。如果此值超出 4xx 或 5xx 范围，则将设置为 500。
res.statusMessage 根据状态码设置。
在生产环境中，body 为状态码消息的 HTML，否则为 err.stack。
err.headers 对象中指定的任何标头。

如果您在开始编写响应后调用 next() 并出现错误（例如，如果您在将响应流式传输到客户端时遇到错误），Express 默认错误处理程序将关闭连接并使请求失败。

因此，当您添加自定义错误处理程序时，您必须委托默认的 Express 错误处理程序，此时标头已发送到客户端：

function errorHandler (err, req, res, next) {
  if (res.headersSent) {
    return next(err)
  }
  res.status(500)
  res.render('error', { error: err })
}

请注意，如果您多次调用 next() 并在代码中出现错误，则可能会触发默认错误处理程序，即使自定义错误处理中间件已到位。

# 编写错误处理程序

以与其他中间件函数相同的方式定义错误处理中间件函数，除了错误处理函数有四个参数而不是三个：(err, req, res, next)。例如：

app.use((err, req, res, next) => {
  console.error(err.stack)
  res.status(500).send('Something broke!')
})

在其他 app.use() 和路由调用之后，您最后定义错误处理中间件；例如：

const bodyParser = require('body-parser')
const methodOverride = require('method-override')

app.use(bodyParser.urlencoded({
  extended: true
}))
app.use(bodyParser.json())
app.use(methodOverride())
app.use((err, req, res, next) => {
  // logic
})

来自中间件函数的响应可以是任何格式，例如 HTML 错误页面、简单消息或 JSON 字符串。

出于组织（和更高级别的框架）的目的，您可以定义几个错误处理中间件函数，就像您使用常规中间件函数一样。例如，为使用 XHR 和不使用 XHR 发出的请求定义错误处理程序：

const bodyParser = require('body-parser')
const methodOverride = require('method-override')

app.use(bodyParser.urlencoded({
  extended: true
}))
app.use(bodyParser.json())
app.use(methodOverride())
app.use(logErrors)
app.use(clientErrorHandler)
app.use(errorHandler)

在此示例中，通用 logErrors 可能会将请求和错误信息写入 stderr，例如：

function logErrors (err, req, res, next) {
  console.error(err.stack)
  next(err)
}

同样在本例中，clientErrorHandler定义如下；在这种情况下，错误会显式传递给下一个错误。

请注意，当不在错误处理函数中调用 "next" 时，您负责编写（和结束）响应。否则，这些请求将 "hang" 并且没有资格进行垃圾收集。

function clientErrorHandler (err, req, res, next) {
  if (req.xhr) {
    res.status(500).send({ error: 'Something failed!' })
  } else {
    next(err)
  }
}

实现 "catch-all" errorHandler 函数如下（例如）：

function errorHandler (err, req, res, next) {
  res.status(500)
  res.render('error', { error: err })
}

如果您有一个带有多个回调函数的路由处理程序，您可以使用 route 参数跳到下一个路由处理程序。例如：

app.get('/a_route_behind_paywall',
  (req, res, next) => {
    if (!req.user.hasPaid) {
      // continue handling this request
      next('route')
    } else {
      next()
    }
  }, (req, res, next) => {
    PaidContent.find((err, doc) => {
      if (err) return next(err)
      res.json(doc)
    })
  })

在此示例中，将跳过 getPaidContent 处理程序，但 app 中用于 /a_route_behind_paywall 的任何剩余处理程序将继续执行。

调用 next() 和 next(err) 表示当前处理程序已完成以及处于什么状态。next(err) 将跳过链中所有剩余的处理程序，除了那些设置为如上所述处理错误的处理程序。

← 使用模板引擎调试 →