编写用于 Express 应用程序的中间件

概述

中间件函数是可访问请求对象（req）、响应对象（res）以及应用程序请求响应周期中的next函数的函数。next函数是 Express 路由器中的一个函数，当调用时，执行当前中间件之后的中间件。

中间件函数可以执行以下任务

• 执行任何代码。
• 对请求和响应对象进行更改。
• 结束请求响应周期。
• 调用堆栈中的下一个中间件。

如果当前中间件函数未结束请求响应周期，则它必须调用next()以将控制权传递给下一个中间件函数。否则，请求将处于挂起状态。

下图显示了中间件函数调用的元素

中间件函数适用的 HTTP 方法。 中间件函数适用的路径（路由）。 中间件函数。 中间件函数的回调参数，按惯例称为“next”。 中间件函数的 HTTP 响应参数，按惯例称为“res”。 中间件函数的 HTTP 请求参数，按惯例称为“req”。

从 Express 5 开始，返回 Promise 的中间件函数将在它们拒绝或抛出错误时调用next(value)。next将使用被拒绝的值或抛出的错误进行调用。

示例

以下是一个简单的“Hello World”Express 应用程序示例。本文的其余部分将定义并向应用程序添加三个中间件函数：一个名为 myLogger 的函数，用于打印简单的日志消息，一个名为 requestTime 的函数，用于显示 HTTP 请求的时间戳，以及一个名为 validateCookies 的函数，用于验证传入的 cookie。

const express = require('express')
const app = express()

app.get('/', (req, res) => {
  res.send('Hello World!')
})

app.listen(3000)

中间件函数 myLogger

以下是名为“myLogger”的中间件函数的一个简单示例。当请求通过应用程序时，此函数只会打印“LOGGED”。中间件函数被分配给名为 myLogger 的变量。

const myLogger = function (req, res, next) {
  console.log('LOGGED')
  next()
}

要加载中间件函数，请调用 app.use()，指定中间件函数。例如，以下代码在到根路径（/）的路由之前加载 myLogger 中间件函数。

const express = require('express')
const app = express()

const myLogger = function (req, res, next) {
  console.log('LOGGED')
  next()
}

app.use(myLogger)

app.get('/', (req, res) => {
  res.send('Hello World!')
})

app.listen(3000)

每当应用程序收到请求时，它都会在终端上打印消息“LOGGED”。

中间件加载的顺序很重要：首先加载的中间件函数也会首先执行。

如果 myLogger 在到根路径的路由之后加载，则请求永远不会到达它，并且应用程序不会打印“LOGGED”，因为根路径的路由处理程序会终止请求-响应周期。

中间件函数 myLogger 只需打印一条消息，然后通过调用 next() 函数将请求传递给堆栈中的下一个中间件函数。

中间件函数 requestTime

接下来，我们将创建一个名为“requestTime”的中间件函数，并向请求对象添加一个名为 requestTime 的属性。

const requestTime = function (req, res, next) {
  req.requestTime = Date.now()
  next()
}

该应用程序现在使用 requestTime 中间件函数。此外，根路径路由的回调函数使用中间件函数添加到 req（请求对象）的属性。

const express = require('express')
const app = express()

const requestTime = function (req, res, next) {
  req.requestTime = Date.now()
  next()
}

app.use(requestTime)

app.get('/', (req, res) => {
  let responseText = 'Hello World!<br>'
  responseText += `<small>Requested at: ${req.requestTime}</small>`
  res.send(responseText)
})

app.listen(3000)

当您向应用程序的根目录发出请求时，该应用程序现在会在浏览器中显示您请求的时间戳。

中间件函数 validateCookies

最后，我们将创建一个中间件函数，用于验证传入的 cookie，如果 cookie 无效，则发送 400 响应。

以下是一个使用外部异步服务验证 cookie 的示例函数。

async function cookieValidator (cookies) {
  try {
    await externallyValidateCookie(cookies.testCookie)
  } catch {
    throw new Error('Invalid cookies')
  }
}

这里我们使用 cookie-parser 中间件从 req 对象中解析传入的 cookie，并将它们传递给我们的 cookieValidator 函数。validateCookies 中间件返回一个 Promise，如果被拒绝，将自动触发我们的错误处理程序。

const express = require('express')
const cookieParser = require('cookie-parser')
const cookieValidator = require('./cookieValidator')

const app = express()

async function validateCookies (req, res, next) {
  await cookieValidator(req.cookies)
  next()
}

app.use(cookieParser())

app.use(validateCookies)

// error handler
app.use((err, req, res, next) => {
  res.status(400).send(err.message)
})

app.listen(3000)

由于你可以访问请求对象、响应对象、堆栈中的下一个中间件函数以及整个 Node.js API，因此中间件函数的可能性是无穷无尽的。

有关 Express 中间件的更多信息，请参阅：使用 Express 中间件。

可配置中间件

如果你需要中间件可配置，请导出一个接受选项对象或其他参数的函数，然后根据输入参数返回中间件实现。

文件：my-middleware.js

module.exports = function (options) {
  return function (req, res, next) {
    // Implement the middleware function based on the options object
    next()
  }
}

现在可以按如下所示使用中间件。

const mw = require('./my-middleware.js')

app.use(mw({ option1: '1', option2: '2' }))

请参阅 cookie-session 和 compression 以获取可配置中间件的示例。