中间件(Middleware ),特指业务流程的中间处理环节,本质上就是一个function处理函数。
注意:中间件函数的形参列表中,必须包含next参数。而路由处理函数中只包含req和res。
当一个请求到达 Express 的服务器之后,可以连续调用多个中间件,从而对这次请求进行预处理。
定义中间件函数
// 常量mw所指向的,就是一个中间件函数
const mw = function (req, res, next) {
console.log('这是一个最简单的中间件函数')
// 注意:在当前中间件的业务处理完毕后,必须调用next()函数
// 表示把流转关系转交给下一个中间件或路由
next()
}
全局生效的中间件
// 定义一个最简单的中间件函数
const mw = function (req, res, next) {
console.log('这是最简单的中间件函数')
// 把流转关系,转交给下一个中间件或路由
next()
}
// 将mw注册为全局生效的中间件
app.use(mw)
定义全局中间件的简化形式
//这是定义全局中间件的简化形式
app.use((req, res, next) => {
console.log('这是最简单的中间件函数')
next()
})
中间件的作用
多个中间件之间,共享同一份req和res。基于这样的特性,我们可以在上游的中间件中,统一为req或res对象添加自定义的属性或方法,供下游的中间件或路由进行使用。
const express = require('express')
const app = express()
//这是定义全局中间件的简化形式
app.use((req, res, next) => {
const time = Date.now()
req.startTime = time
next()
})
app.get('/', (req, res) => {
console.log('调用了/这个路由')
res.send('Home page.' + req.startTime)
})
app.get('/user', (req, res) => {
console.log('调用了/user这个路由')
res.send('User page.' + req.startTime)
})
app.listen(80, () => {
console.log('http://127.0.0.1')
})
定义多个全局中间件
可以使用app.use()连续定义多个全局中间件。客户端请求到达服务器之后,会按照中间件定义的先后顺序依次进行调用。
const express = require('express')
const app = express()
//定义第一个全局中间件
app.use((req, res, next) => {
console.log('调用了第一个全局中间件')
next()
})
//定义第二个全局中间件
app.use((req, res, next) => {
console.log('调用了第二个全局中间件')
next()
})
//定义一个路由
app.get('/user', (req, res) => {
res.send('User page.')
})
app.listen(80, () => {
console.log('http://127.0.0.1')
})
局部生效的中间件
不使用 app.use() 定义的中间件,叫做局部生效的中间件。
// 导入express模块
const express = require('express')
// 创建express的服务器实例
const app = express()
// 1.调用中间件函数
const mw1 = (req, res, next) => {
console.log('调用了局部生效的中间件')
next()
}
//2.创建路由
app.get('/', mw1, (req, res) => {
res.send('Home page.')
})
app.get('/user', (req, res) => {
res.send('Home page.')
})
// 调用app.listen方法,指定端口号并启动web服务器
app.listen(80, () => {
console.log('http://127.0.0.1')
})
定义多个局部中间件
可以在路由中,通过如下两种等价的方式,使用多个局部中间件。
// 导入express模块
const express = require('express')
// 创建express的服务器实例
const app = express()
// 1.调用中间件函数
const mw1 = (req, res, next) => {
console.log('调用了第一个局部生效的中间件')
next()
}
const mw2 = (req, res, next) => {
console.log('调用了第二个局部生效的中间件')
next()
}
//2.创建路由
app.get('/', mw1, mw2, (req, res) => {
res.send('Home page.')
})
app.get('/user', (req, res) => {
res.send('User page.')
})
// 调用app.listen方法,指定端口号并启动web服务器
app.listen(80, () => {
console.log('http://127.0.0.1')
})
// 以下两种写法是“完全等价”的,可根据自己的喜好,选择任意一种方式进行使用
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 对象
中间件的分类
为了方便大家理解和记忆中间件的使用,Express 官方把常见的中间件用法,分成了 5 大类,分别是:
- 应用级别的中间件
- 路由级别的中间件
- 错误级别的中间件
- Express 内置的中间件
- 第三方的中间件
1. 应用级别的中间件
通过 app.use() 或 app.get() 或 app.post() ,绑定到 app 实例上的中间件,叫做应用级别的中间件,代码示例如下:
// 应用级别的中间件(全局中间件)
app.use((req,res,next)=>{
next();
});
// 应用级别的中间件(局部中间件)
app.get('/',xx1,(req,res)=>{
res.send('Home Page.');
});
2. 路由级别的中间件
绑定到 express.Router() 实例上的中间件,叫做路由级别的中间件。它的用法和应用级别中间件没有任何区别。只不过,应用级别中间件是绑定到 app 实例上,路由级别中间件绑定到 router 实例上,代码示例如下:
var app = express();
var router = express.Router();
// 路由级别的中间件
router.use(function(req,res,next){
console.log('Time:',Date.now());
next();
});
app.use('/',router);
3. 错误级别的中间件
错误级别中间件的作用:专门用来捕获整个项目中发生的异常错误,从而防止项目异常崩溃的问题。
格式:错误级别中间件的 function 处理函数中,必须有 4 个形参,形参顺序从前到后,分别是 (err, req, res, next)。
// 导入express模块
const express = require('express')
// 创建express的服务器实例
const app = express()
//1.调用路由
app.get('/', (req, res) => {
// 1.1人为的制造错误
throw new Error('服务器内部发生了错误!')
res.send('Home page.')
})
// 2.定义错误级别的中间件,捕获整个项目的异常错误,从而防止程序的崩溃
app.use((err, req, res, next) => {
console.log('发生了错误!' + err.message)
res.send('Error:' + err.message)
})
// 调用app.listen方法,指定端口号并启动web服务器
app.listen(80, () => {
console.log('http://127.0.0.1')
})
注意:错误级别的中间件,必须注册在所有路由之后!
4. Express内置的中间件
自 Express 4.16.0 版本开始,Express 内置了 3 个常用的中间件,极大的提高了 Express 项目的开发效率和体验:
- express.static 快速托管静态资源的内置中间件,例如: HTML 文件、图片、CSS 样式等(无兼容性)
- express.json 解析 JSON 格式的请求体数据(有兼容性,仅在 4.16.0+ 版本中可用)
- express.urlencoded 解析 URL-encoded 格式的请求体数据(有兼容性,仅在 4.16.0+ 版本中可用)
// 导入express模块
const express = require('express')
// 创建express的服务器实例
const app = express()
//注意: 除了错误级别的中间件,其他的中间件,必须在路由之前进行配置
//通过express.json()这个中间件,解析表单中的JSON格式的数据
app.use(express.json())
//通过express.urlencoded()这个中间件,来解析表单中的url-encoded格式的数据
app.use(express.urlencoded({extended: false}))
app.post('/user', (req, res) => {
// 在服务器,可以使用req.boby这个属性,来接收客户端发送过来的请求体数据
// 默认情况下,如果不配置解析表单数据的中间件,则req.body默认等于undefined
console.log(req.body)
res.send('OK')
})
app.post('/book', (req, res) => {
console.log(req.body)
res.send('OK')
})
// 调用app.listen方法,指定端口号并启动web服务器
app.listen(80, () => {
console.log('http://127.0.0.1')
})
5. 第三方的中间件
非 Express 官方内置的,而是由第三方开发出来的中间件,叫做第三方中间件。在项目中,大家可以按需下载并配置第三方中间件,从而提高项目的开发效率。
例如:在 express@4.16.0 之前的版本中,经常使用 body-parser 这个第三方中间件,来解析请求体数据。使用步骤如下:
- 运行 npm install body-parser 安装中间件
- 使用 require 导入中间件
- 调用 app.use() 注册并使用中间件
// 导入express模块
const express = require('express')
// 创建express的服务器实例
const app = express()
//1.导入解析表单数据的中间件 bady-parser
const parser = require('body-parser')
//2.使用app.use()注册中间件
app.use(parser.urlencoded({extended: false}))
// app.use(express.urlencoded({extended: false}))
app.post('/user', (req, res) => {
// 在服务器,可以使用req.boby这个属性,来接收客户端发送过来的请求体数据
// 默认情况下,如果不配置解析表单数据的中间件,则req.body默认等于undefined
console.log(req.body)
res.send('OK')
})
// 调用app.listen方法,指定端口号并启动web服务器
app.listen(80, () => {
console.log('http://127.0.0.1')
})
注意:Express 内置的 express.urlencoded 中间件,就是基于 body-parser 这个第三方中间件进一步封装出来的。
自定义中间件(原理)
需求描述与实现步骤
自己手动模拟一个类似于 express.urlencoded 这样的中间件,来解析 POST 提交到服务器的表单数据。
实现步骤:
- 定义中间件
- 监听 req 的 data 事件
- 监听 req 的 end 事件
- 使用 querystring 模块解析请求体数据
- 将解析出来的数据对象挂载为 req.body
- 将自定义中间件封装为模块
定义中间件
app.use((req,res,next)=>{
// 中间件业务逻辑
})
监听 req 的 data 事件
在中间件中,需要监听 req 对象的 data 事件,来获取客户端发送到服务器的数据。
如果数据量比较大,无法一次性发送完毕,则客户端会把数据切割后,分批发送到服务器。所以 data 事件可能会触发多次,每一次触发 data 事件时,获取到数据只是完整数据的一部分,需要手动对接收到的数据进行拼接。
// 1.定义一个 str 字符串,用来专门储存客户端送过来的请求体数据
let str = '';
// 2.监听 req 的 data 事件
req.on('data', (chunk) => {
str += chunk;
});
监听 req 的 end 事件
当请求体数据接收完毕之后,会自动触发 req 的 end 事件。
因此,我们可以在 req 的 end 事件中,拿到并处理完整的请求体数据。示例代码如下:
// 3.监听 req 的 end 事件
req.on('end', () => {
// 在 str 中存放的是完整的请求体数据
// TODO:把字符串格式的请求体数据,解析成对象格式
const body = qs.parse(str);
console.log(body);
});
使用 querystring 模块解析请求体数据
Node.js 内置了一个 querystring 模块,专门用来处理查询字符串。通过这个模块提供的 parse() 函数,可以轻松把查询字符串,解析成对象的格式。示例代码如下:
// 导入处理 querystring 的 Node.js 内置模块
const qs = require('querystring');
// 调用 qs.parse() 方法,把查询字符串解析为对象
const body = qs.parse(str);
将解析出来的数据对象挂载为 req.body
上游的中间件和下游的中间件及路由之间,共享同一份 req 和 res。因此,我们可以将解析出来的数据,挂载为 req 的自定义属性,命名为 req.body,供下游使用。示例代码如下:
// 3.监听 req 的 end 事件
req.on('end', () => {
// 在 str 中存放的是完整的请求体数据
// TODO:把字符串格式的请求体数据,解析成对象格式
const body = qs.parse(str);
req.body = body;
next();
});
模块化的自定义中间件
// 导入express模块
const express = require('express')
// 创建express的服务器实例
const app = express()
//1.导入自己封装的中间件模块
const customBodyParser = require('./14.custom-body-parser')
//2.将自定义的中间件函数,注册为全局可用的中间件
app.use(customBodyParser)
app.post('/user', (req, res) => {
res.send(req.body)
})
// 调用app.listen方法,指定端口号并启动web服务器
app.listen(80, () => {
console.log('http://127.0.0.1')
})
// 导入Node.js内置的querystring模块
const qs = require('querystring')
const bodyParser = (req, res, next) => {
// 定义中间件具体的业务逻辑
// 1.定义一个str字符串,专门用来存储客户端发送过来的请求体数据
let str = ''
// 2.监听req的data事件
req.on('data', (chunk) => {
str += chunk
})
// 3.监听req的end事件
req.on('end', () => {
// 在str中存放的是完整的请求体数据
// console.log(str)
// // TODO:把字符串格式的请求体数据,解析成对象格式
const body = qs.parse(str)
req.body = body
next()
})
}
module.exports = bodyParser