Express中间件
中间件的概念
- 什么是中间件
中间件,特指业务流程的中间处理环节。 - Express中间件的调用流程
当一个请求到达Express的服务器之后,可以连续调用多个中间件,从而对这次请求进行预处理。类似于下图所示
- Express中间件的格式
Express的中间件本质上就是一个function处理函数,Express中间件的格式如下:
var express = require('express')
var app = express()
app.get('/', function(req, res, next){
next()
})
app.listen(3000)
注意:中间件函数的形参列表中必须包含next
参数,而路由处理函数中只包含req和res。
- next函数的作用
next函数是实现多个中间件连续调用的关键,它表示把流转关系转交给下一个中间件或路由。
Express中间件的使用
- 定义中间件函数
可以通过如下的方式,定义一个最简单的中间件函数:
//常量new所指向的就是一个中间件函数
const mw = function(req, res, next) {
console.log('这是一个最简单的中间件函数')
//注意:在当前中间件的业务处理完毕后,必须调用next()函数
//表示把流转关系转交给下一个中间件或路由
next()
}
- 全局生效的中间件
客户端发起的任何请求,到达服务器之后都会触发的中间件,叫做全局生效的中间件。通过调用app.use(中间件函数),即可定义一个全局生效的中间件,示例代码如下:
const mw = function(req, res, next) {
console.log('这是一个最简单的中间件函数')
//注意:在当前中间件的业务处理完毕后,必须调用next()函数
//表示把流转关系转交给下一个中间件或路由
next()
}
//全局生效的中间件
app.use(mw)
- 示例如下
当我们启动该服务器,并打开相应网址我们可以发现在终端中打印如下字样,表示我们是先经过中间件处理,然后响应的get请求,类似于我们之间画的图 - 定义全局中间件的简化形式
就稍微修改一下上面的代码即可
app.use(function (req, res, next) {
console.log('这是一个简单的中间件函数')
next()
])
- 中间件的作用
多个中间件之间共享同一份req和res。基于这样的特性,我们可以在上游的中间件中,统一为req和res对象添加自定义的属性或方法,供下游的中间件或路由进行使用。
示例:
- 定义多个全局中间件
可以使用app.use()连续定义多个全局中间件。客户端请求到达服务器之后会按照中间件定义的先后顺序依次进行调用,如下:
- 局部生效的中间件
不使用app.use()定义的中间件就叫做局部生效的中间件,示例如下:
下面是不使用中间件的路由
- 定义多个局部中间件
可以在路由中通过以下两种完全等价的方式使用多个局部中间件:
app.get('/', mw1, mw2, (req, res) => { res.send('Home page.') })
app.get('/', [mw1, mw2], (req, res) => { res.send('Home page.') })
- 中间件的5个使用注意事项
- 一定要在路由之前注册中间件
- 客户端发送过来的请求可以连续调用多个中间件进行处理
- 执行完中间件的业务代码之后,不要忘记调用next()函数
- 为了防止代码逻辑混乱,调用next()函数之后不要再写额外的代码
- 连续调用多个中间件时,多个中间件之间共享req和res
中间件的分类
- 应用级别的中间件
通过app.use()或app.get()或app.post(),绑定到app实例上的中间件,叫做应用级别的中间件,示例如下:
//应用级别的中间件(全局中间件)
app.use((req, res, next) => {
next()
})
//应用级别的中间件(局部中间件)
app.get('/', mw, (req, res) => {
res.send('Home page.')
})
- 路由级别的中间件
绑定到express.Router()实例上的中间件,叫做路由级别的中间件。它的用法和应用级别中间件没有任何区别,只不过应用级别的中间件是绑定到app实例上,而路由级别的中间件是绑定到router实例上,示例如下:
const app = express()
const rooter = express.Router()
/路由级别的中间件
router.use(function (req, res, next) {
console.log('Time:', Date.now())
next()
})
app.use('/', router)
- 错误级别的中间件
错误级别的中间件的作用:专门用来捕获整个项目发生的异常错误,从而防止项目异常崩溃的问题
格式:错误级别中间件的function处理函数中,必须有4个形参,形参从前到后,分别是(err,req,res,next)
app.get('/', function(req, res) { //路由
throw new Error('服务器内部发生了错误') //在程序中主动触发一个错误,一边在后续的错误处理机制中捕获并处理这个错误
res.send("Home page.")
})
app.use(function (err, req, res, next) { //错误级别的中间件
console.log('发生了错误:' + err.message) //在服务器打印错误消息
res.send('Error!' + err.message) //向客户端相应错误相关的内容
})
注意:错误级别的中间件必须注册在所有路由之后!其他级别的中间件必须在路由之前进行配置
- Express内置的中间件
- express.static快速托管静态资源的中间件
- express.json解析JSON格式的请求体数据(有兼容性,仅在4.16.0+版本中可用)
- express.urlencoded解析URL-encoded格式的请求体数据(有兼容性,仅在4.16.0+版本中可用)
//配置解析application/json格式数据的内置中间件
app.use(express.json())
//配置解析application/x-www-form-urlencoded格式数据的内置中间件
app.use(express.urlencoded({ extended: false}))
注:在服务器可以使用 req.body这个属性接收客户端发送过来的请求体数据,在默认情况下,如果不配置解析表单数据的中间件,req.body默认等于undefined
- 第三方的中间件
非Express官方内置的,而是由第三方开发出来的中间件,叫做第三方中间件。在项目中,大家可以按需下载并配置第三方中间件,从而提高项目的开发效率。
就像我们之前使用过的一样,例如body-parser这个第三方中间件,使用步骤如下:
运行npm install body-parser安装中间件
使用require导入中间件
调用app.use()注册并使用中间件