中间件(Middleware),特指业务流程的中间处理环节
当一个请求到达 Express 的服务器后,可以连续调用多个中间件,从而对这次请求进行预处理
Express 的中间件,本质上是一个 function 处理函数,Express 中间件格式如下
中间件函数的形参列表中,必须包含 next 参数,而路由处理函数中只包含 req 和 res
next 函数是实现多个中间件连续调用的关键,它表示把流转关系转交给下一个中间件或者路由
- // 常量 mv 所指向的就是一个中间件函数
- const mv = function ( req, res, next) {
- console.log('中间件demo')
- // 注意: 在当前中间件的业务处理完毕后,必须调用 next() 函数
- // 表示把流转关系转交给下一个中间件或路由
- next()
- }
客户端发起的任何请求,到达服务器后,都会触发的中间件,叫全局生效的中间件
通过调用 app.use(中间件函数),即可定义一个全局生效的中间件
- // 常量 mv 所指向的就是一个中间件函数
- const mv = function ( req, res, next) {
- console.log('中间件demo')
- next()
- }
-
- // 全局生效的中间件
- app.use(mv)
- // 全局生效的中间件
- app.use(function (req, res, next){
- console.log('demo')
- next()
- })
多个中间件之间,共享同一份 req 和 res,基于这样的特性,我们可以在上游的中间件中,统一为 req 或 res 对象添加自定义的属性或方法,供下游的中间件或路由进行使用
可以使用 app.use() 连续定义多个全局中间件,客户端请求到达服务器后,会按照中间件定义的先后顺序依次进行调用
不使用 app.use() 定义的中间件,即局部生效的中间件
只在当前路由生效
- const mv1 = function(req, res, next) {
- console.log('中间件函数')
- next()
- }
-
- // mv1 中间件只在当前路由生效
- app.get('/', mv1, function(req, res) {
- res,send('get')
- })
-
- // 此路由不生效
- app.get('/user', function(req, res) {
- res,send('get1')
- })
两种等价方式定义
- app.get('/', mv1, mv2, function(req, res) { res,send('get') })
- app.get('/', [mv1, mv2], function(req, res) { res,send('get') })
① 一定要在路由之前注册中间件
② 客户端发送的请求,可以连续调用多个中间件进行处理
③ 执行完中间件的业务代码,需要调用 next() 函数
④ 防止代码逻辑混乱,调用完 next() 函数后不要再写额外代码
⑤ 连续多个中间件时,多个中间件之间,共享 req 和 res 对象
Express 官方把常见的中间件用法,分为了五大类
① 应用级别的中间件
② 路由级别的中间件
③ 错误级别的中间件
④ Express 内置的中间件
⑤ 第三方的中间件
通过 app.use() 或 app.get() 或 app.post(),绑定到app实例上的中间件,叫做应用级别的中间件 全局中间件和局部中间件
- // 应用级别的中间件 (全局中间件)
- app.use((req, res, next) => {
- next()
- })
-
- // 应用级别的中间件 (局部中间件)
- app.get('/', mv1, (req, res, next) => {
- res.send('局部')
- })
绑定到 express.Router() 实例上的中间件,叫做路由级别的中间件,它的用法和应用级别中间件没有区别,区别在于,应用级别中间件是绑定在 app 实例上的,路由级别中间件绑定到 router 实例上的
- const app = express()
- const router = express.Router()
-
- // 路由级别的中间件
- router.use(function (req, res, next) {
- console.log('路由级别中间件')
- next()
- })
-
- app.use('/', router)
作用:专门用来捕获整个项目中发生的异常错误,从而防止项目异常崩溃的问题
格式:必须要有 4 个形参,从前到后分别是 (err, req, res, next)
- app.get('/', function(req, res) { // 路由
- throw new Error('错误!') // 抛出自定义错误
- res.send('get')
- })
- app.use(function (err, req, res, next) { // 错误级别的中间件
- console.log('发生了错误' + err.message) // 服务器打印错误消息
- res,send('Error' + err.message) // 向客户端响应错误信息相关内容
- })
注意:错误级别的中间件,必须注册在所有路由之后
Express 4.16.0版本后,Express 内置了3个常用的中间件
① express.static 快速托管静态资源的内置中间件,例如:HTML文件,图片,css样式(无兼容性)
② express.json 解析JSON格式的请求体数据(有兼容性,在4.16.0+版本可用)
③ express.urlencoded 解析 URL-encoded 格式的请求体数据(有兼容性,在4.16.0+版本可用)
- // 配置解析 application/json 格式数据的内置中间件
- app.use(express.json())
- // 配置解析 application/x-www-form-urlencode 格式数据的内置中间件
- app.use(express.urlencoded({ extend: false }))
非 Express 官方内置的,是第三方开发出来的中间件,叫第三方中间件,项目中可以按需下载并配置第三方中间件
在 express@4.16.0 之前的版本中,经常使用 body-parser 第三方中间件来解析请求体数据:
① 运行 npm i body-parser 安装
② 使用 require 导入中间件
③ 调用 app.use() 注册并使用中间件
注意:Express 内置的 express.urlencoded 中间件,就是基于 body-parser 进一步封装的
需求:手动模拟类似于 express.urlencoded 的中间件,解析POST提交到服务器的表单数据
实现步骤:
① 定义中间件
② 监听 req 的 data 事件
③ 监听 req 的 end 事件
④ 使用 queryString 模块解析请求体数据
⑤ 将解析出来的数据对象挂载为 req.body
⑥ 将自定义中间件封装为模块
使用 app.use() 定义全局生效的中间件
- app.use(function(req, res, next){
- // 中间件的业务逻辑
- })
获取客户端发送到服务器的数据
如果数据量比较大,无法一次性发送完毕,则客户端会把数据切割后,分批发送到服务器。所以data事件可能会触发多次,每次触发。获取到数据只是完整数据的一部分,需要手动对接收到的数据进行拼接
- // 定义变量 储存客户端发来的请求体数据
- let str = ''
- // 监听 req 对象的 data 事件
- req.on('data', (chunk) => {
- // 拼接请求体数据,隐式转换为字符串
- str += chunk
- })
请求体数据接收完毕之后会自动触发 req 的 end 事件
可以在 req 的 end 事件中,拿到并处理完整的请求体数据
- // 监听 req 对象的 end 事件
- req.on('end', () => {
- console.log(str) // 打印完整请求体数据
- // TOOD: 把字符串的请求体数据,解析成对象格式
- })
Node.js 内置了一个 querystring 模块,专门用来处理查询字符串。通过这个模块提供的 parse(), 可以把查询字符串解析成对象的格式
- // 导入处理 querystring 的 Node.js 内置模块
- const qs = require('querystring')
-
- // 调用 qs.parse() 方法 把查询字符串解析为对象
- const body = qs.parse(str)
注意:qs被弃用
上游中间件和下游中间件及路由之间,共享同一份 req 和 res。可以将解析出来的数据,挂载为 req 的自定义属性,命名为 req.body,供下游使用
- req.on('end', () => {
- const body = qs.parse(srt) // 调用 qs.parse() 方法把查询字符串解析成对象
- req.body = body // 解析出来的请求体对象瓜子
- next() // 调用 next(),执行后续逻辑
- })
优化结构,封装为独立模块
- // custom-body-parser.js 模块代码
- const qs = require('querystring')
- function bodyParser(req, res, next){ /* 省略 */ }
- module.export = bodyParser // 向外导出解析请求体孙书记的中间件函数
-
- ---------------------------------------------
-
- // 1. 导入自定义的中间件模块
- const myBodyParser = require('custom-body-parse')
- // 2. 注册自定义的中间件模块
- app.use(myBodyParser )
-