Using middleware

Express是一个路由和中间件Web框架,其自身的功能很少:Express应用程序本质上是一系列中间件函数调用.

中间件功能是可以访问请求对象req ), 响应对象res )和应用程序的请求-响应周期中的下一个中间件功能的功能. 下一个中间件功能通常由名为next的变量表示.

中间件功能可以执行以下任务:

如果当前中间件函数没有结束请求-响应周期,则它必须调用next()将控制权传递给下一个中间件函数. 否则,该请求将被挂起.

Express应用程序可以使用以下类型的中间件:

您可以使用可选的安装路径加载应用程序级和路由器级中间件. 您还可以将一系列中间件功能一起加载,这将在安装点创建中间件系统的子堆栈.

Application-level middleware

通过使用app.use()app.METHOD()函数将应用程序级中间件绑定到app对象的实例,其中METHOD是中间件函数处理的请求的HTTP方法(例如GET,PUT或POST)(小写).

此示例显示了没有安装路径的中间件功能. 每次应用收到请求时,都会执行该功能.

var express = require('express')
var app = express()

app.use(function (req, res, next) {
  console.log('Time:', Date.now())
  next()
})

此示例显示了安装在/user/:id路径上的中间件功能. 该函数在/user/:id路径上针对任何类型的HTTP请求执行.

app.use('/user/:id', function (req, res, next) {
  console.log('Request Type:', req.method)
  next()
})

此示例显示了路由及其处理程序功能(中间件系统). 该函数处理对/user/:id路径的GET请求.

app.get('/user/:id', function (req, res, next) {
  res.send('USER')
})

这是在具有安装路径的安装点加载一系列中间件功能的示例. 它说明了一个中间件子栈,该子栈将任何类型的HTTP请求的请求信息打印到/user/:id路径.

app.use('/user/:id', function (req, res, next) {
  console.log('Request URL:', req.originalUrl)
  next()
}, function (req, res, next) {
  console.log('Request Type:', req.method)
  next()
})

路由处理程序使您可以为一个路径定义多个路由. 下面的示例为到/user/:id路径的GET请求定义了两条路由. 第二条路由不会引起任何问题,但是它永远不会被调用,因为第一条路由会结束请求-响应周期.

此示例显示了一个中间件子堆栈,该子堆栈处理到/user/:id路径的GET请求.

app.get('/user/:id', function (req, res, next) {
  console.log('ID:', req.params.id)
  next()
}, function (req, res, next) {
  res.send('User Info')
})

// handler for the /user/:id path, which prints the user ID
app.get('/user/:id', function (req, res, next) {
  res.end(req.params.id)
})

要从路由器中间件堆栈中跳过其余中间件功能,请调用next('route')将控制权传递给下一条路由. 注意next('route')仅在使用app.METHOD()router.METHOD()函数加载的中间件函数中起作用.

此示例显示了一个中间件子堆栈,该子堆栈处理到/user/:id路径的GET请求.

app.get('/user/:id', function (req, res, next) {
  // if the user ID is 0, skip to the next route
  if (req.params.id === '0') next('route')
  // otherwise pass the control to the next middleware function in this stack
  else next()
}, function (req, res, next) {
  // send a regular response
  res.send('regular')
})

// handler for the /user/:id path, which sends a special response
app.get('/user/:id', function (req, res, next) {
  res.send('special')
})

中间件也可以在数组中声明为可重用.

此示例显示了一个带有中间件子堆栈的数组,该子堆栈处理对/user/:id路径的GET请求

function logOriginalUrl (req, res, next) {
  console.log('Request URL:', req.originalUrl)
  next()
}

function logMethod (req, res, next) {
  console.log('Request Type:', req.method)
  next()
}

var logStuff = [logOriginalUrl, logMethod]
app.get('/user/:id', logStuff, function (req, res, next) {
  res.send('User Info')
})

Router-level middleware

路由器级中间件的工作方式与应用程序级中间件相同,只不过它绑定到express.Router()的实例.

var router = express.Router()

通过使用router.use()router.METHOD()函数加载路由器级中间件.

以下示例代码通过使用路由器级中间件来复制上面显示的用于应用程序级中间件的中间件系统:

var express = require('express')
var app = express()
var router = express.Router()

// a middleware function with no mount path. This code is executed for every request to the router
router.use(function (req, res, next) {
  console.log('Time:', Date.now())
  next()
})

// a middleware sub-stack shows request info for any type of HTTP request to the /user/:id path
router.use('/user/:id', function (req, res, next) {
  console.log('Request URL:', req.originalUrl)
  next()
}, function (req, res, next) {
  console.log('Request Type:', req.method)
  next()
})

// a middleware sub-stack that handles GET requests to the /user/:id path
router.get('/user/:id', function (req, res, next) {
  // if the user ID is 0, skip to the next router
  if (req.params.id === '0') next('route')
  // otherwise pass control to the next middleware function in this stack
  else next()
}, function (req, res, next) {
  // render a regular page
  res.render('regular')
})

// handler for the /user/:id path, which renders a special page
router.get('/user/:id', function (req, res, next) {
  console.log(req.params.id)
  res.render('special')
})

// mount the router on the app
app.use('/', router)

要跳过路由器的其余中间件功能,请调用next('router')将控制权转回路由器实例.

此示例显示了一个中间件子堆栈,该子堆栈处理到/user/:id路径的GET请求.

var express = require('express')
var app = express()
var router = express.Router()

// predicate the router with a check and bail out when needed
router.use(function (req, res, next) {
  if (!req.headers['x-auth']) return next('router')
  next()
})

router.get('/user/:id', function (req, res) {
  res.send('hello, user!')
})

// use the router and 401 anything falling through
app.use('/admin', router, function (req, res) {
  res.sendStatus(401)
})

Error-handling middleware

错误处理中间件始终采用四个参数. 您必须提供四个参数以将其标识为错误处理中间件函数. 即使您不需要使用next对象,也必须指定它来维护签名. 否则, next对象将被解释为常规中间件,并且将无法处理错误.

定义错误处理中间件函数的方式与其他中间件函数相同,除了使用四个参数而不是三个参数外,特别是使用签名(err, req, res, next) ):

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

有关错误处理中间件的详细信息,请参见: 错误处理 .

Built-in middleware

从版本4.x开始,Express不再依赖Connect . Express以前包含的中间件功能现在位于单独的模块中; 请参阅中间件功能列表 .

Express具有以下内置的中间件功能:

Third-party middleware

使用第三方中间件向Express应用程序添加功能.

安装Node.js模块以获得所需的功能,然后在应用程序级别或路由器级别将其加载到您的应用程序中.

The following example illustrates installing and loading the cookie-parsing middleware function cookie-parser.

$ npm install cookie-parser
var express = require('express')
var app = express()
var cookieParser = require('cookie-parser')

// load the cookie-parsing middleware
app.use(cookieParser())

有关Express常用的第三方中间件功能的部分列表,请参阅: 第三方中间件 .

by  ICOPY.SITE