Express中间件

发表于 分类于 本文字数： 4.6k 阅读时长 ≈ 4 分钟

中间件的概念

什么是中间件

中间件(Middleware),特指业务流程的中间处理环节

Express中间件的调用流程

当一个请求到达Express的服务器之后，可以连续调用多个中间件，从而对这次请求进行预处理
图片1

Express中间件的格式

Express的中间件，本质上就是一个function处理函数，Express中间件的格式如下:
图片2
注意：中间件函数的形参列表中，必须包含next函数。而路由处理函数中只包含req和res

next函数的作用

next 函数是实现多个中间件连续调用的关键，它表示把流转关系转交给下一个中间件或路由

中间件函数

定义中间件函数

1
2
3
4
5
6
const mv = function(req,res,next) {
    console.log('这是一个最简单的中间件函数');
    // 注意：在当前中间件的业务处理完毕后，必须调用 next()函数
    // 表示把流转关系转交给下一个中间件或路由
    next();
}

全局生效的中间件

客户端发起的任何请求，到达服务器之后，都会触发的中间件，叫做全局生效的中间件。
通过调用 app.use(中间件函数)，即可定义一个全局生效的中间件，示例代码如下：

1
2
3
4
5
6
7
8
9
10
11
const mv = function(req,res,next) {
    console.log('这是一个最简单的中间件函数');
    next();
}
// 全局生效的中间件
app.use(mv);
// 简写形式
app.use((req,res,next) => {
    console.log('这是一个最简单的中间件函数');
    next();
})

中间件的作用

多个中间件之间，共享同一份 req 和 res。基于这样的特性，我们可以在上游的中间件中，统一为 req 或 res 对象添加自定义的属性或方法，供下游的中间件或路由进行使用。

图片3

定义多个全局中间件

可以使用 app.use() 连续定义多个全局中间件。客户端请求到达服务器之后，会按照中间件定义的先后顺序依次进行调用，示例代码如下：

1
2
3
4
5
6
7
8
9
10
11
app.use((req,res,next) => {     // 第1个全局中间件
    console.log('调用了第1个全局中间件');
    next();
})
app.use((req,res,next) => {     // 第2个全局中间件
    console.log('调用了第2个全局中间件');
    next();
})
app.get('/user',(req,res) => {  // 请求这个路由，会依次触发上述两个全局中间件
    res.send('Home page')
})

局部生效的中间件

不使用 app.use() 定义的中间件，叫做局部生效的中间件，示例代码如下：

1
2
3
4
5
6
7
8
9
10
11
12
13
// 定义中间件函数 mv1
const mv1 = (req,res,next) => {
    console.log('这是一个局部中间件');
    next();
};
// mv1 这个中间件只在"当前路由中生效"，这种用法属于"局部生效的中间件"
app.get('/',mv1,(req,res) => {
    res.send('Home page');
})
// mv1 这个中间件不会影响下面这个路由
app.get('/user',(req,res) => {
    res.send('User page')
})

定义多个局部中间件

可以在路由中，通过如下两种等价的方式，使用多个局部中间件：

1
2
3
4
5
6
7
// 以下两种写法是"完全等价"的，可根据自己的喜好，选择任意一种方式进行使用
app.get('/',mv1,mv2,(req,res) => {
    res.send('Home page')
});
app.get('/',[mv1,mv2],(req,res) => {
    res.send('Home page')
})

了解中间件的5个使用注意事项

1.一定要在路由之前注册中间件
2.客户端发送过来的请求，可以连续调用多个中间件进行处理
3.执行完中间件的业务代码之后，不要忘记调用 next()函数
4.为了防止代码逻辑混乱，调用next()函数后不要再写额外的代码
5.连续调用多个中间件时，多个中间件之间，共享req和res对象

中间件的分类

为了方便大家理解和记忆中间件的使用，Express 官方把常见的中间件用法，分成了 5 大类，分别是：
1.应用级别的中间件
2.路由级别的中间件
3.错误级别的中间件
4.Express 内置的中间件
5.第三方的中间件

1.应用级别的中间件

通过 app.use() 或 app.get() 或 app.post() ，绑定到 app 实例上的中间件，叫做应用级别的中间件，代码示例如下:

1
2
3
4
5
6
7
8
// 应用级别的中间件(全局中间件)
app.use((req,res,next) => {
    next()
})
// 应用级别的中间件(局部中间件)
app.get('/',mv1,(req,res) => {
    res.send('Home page.')
})

2.路由级别的中间件

绑定到 express.Router() 实例上的中间件，叫做路由级别的中间件。它的用法和应用级别中间件没有任何区别。只不过，应用级别中间件是绑定到 app 实例上，路由级别中间件绑定到 router 实例上，代码示例如下：

1
2
3
4
5
6
7
8
9
10
11
// 创建路由模块
const express = require('express');
// 创建路由对象
const router = express.Router();
// 路由级别的中间件
router.use((req,res,next) => {
    console.log('这是一个路由级别的中间件');
    next();
})
// 向外导出路由对象
module.exports = router

错误级别的中间件

错误级别中间件的作用：专门用来捕获整个项目中发生的异常错误，从而防止项目异常崩溃的问题。
格式：错误级别中间件的 function 处理函数中，必须有 4 个形参，形参顺序从前到后，分别是 (err, req, res, next)

1
2
3
4
5
6
7
8
app.get('/',(req,res) => {                      // 1.路由
    throw new Error('服务器内部发生了错误!')      // 1.1 抛出一个自定义的错误
    res.send('Home page');
})
app.use((err,erq,res,next) => {                 // 2. 错误级别的中间件
    console.log('发生了错误' + err.message);     // 2.1 在服务器打印错误消息
    res.send('Error!'+ err.message);            // 2.2 向客户端响应错误相关的内容
})

注意：错误级别的中间件，必须注册在所有路由之后

Express内置的中间件

自 Express 4.16.0 版本开始，Express 内置了 3 个常用的中间件，极大的提高了 Express 项目的开发效率和体验：

  1. express.static >快速托管静态资源的内置中间件，例如： HTML 文件、图片、CSS 样式等（无兼容性）
  2. express.json 解析 JSON 格式的请求体数据（有兼容性，仅在 4.16.0+ 版本中可用）
  3. express.urlencoded 解析 URL-encoded 格式的请求体数据（有兼容性，仅在 4.16.0+ 版本中可用）
    1
    2
    3
    4
    // 配置解析 application/json 格式数据的内置中间件
    app.use(express.json());
    // 配置解析 application/x-www-form-urlencoded 格式数据的内置中间件
    app.use(express.urlencoded({extended: false}))

第三方的中间件

非 Express 官方内置的，而是由第三方开发出来的中间件，叫做第三方中间件。在项目中，大家可以按需下载并配置第三方中间件，从而提高项目的开发效率。
例如：在 express@4.16.0 之前的版本中，经常使用 body-parser 这个第三方中间件，来解析请求体数据。使用步骤如下：
1.运行 npm install body-parser 安装中间件
2.使用 require 导入中间件
3.调用 app.use() 注册并使用中间件
注意：Express 内置的 express.urlencoded 中间件，就是基于 body-parser 这个第三方中间件进一步封装出来的。

自定义中间件

需求描述与实现步骤
自己手动模拟一个类似于 express.urlencoded 这样的中间件，来解析 POST 提交到服务器的表单数据。
实现步骤：
1.定义中间件
2.监听 req 的 data 事件
3.监听 req 的 end 事件
4.使用 querystring 模块解析请求体数据
5.将解析出来的数据对象挂载为 req.body
6.将自定义中间件封装为模块

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
// custom-body-parser.js 模块中的代码
const qs = require('querystring');
function bodyParser(req,res,next) {
    // 中间件的业务逻辑
    // 定义变量，用来存储客户端发送过来的请求体数据
    let str = '';
    // 监听 req对象的data事件(客户端发送过来的新的请求体数据)
    req.on('data',(chunk) => {
        str += chunk;
    });
    // 监听req的end事件
    req.on('end',() => {
        const body = qs.parse(str);
        console.log(body);
        req.body = body;
        next();
    })
};
module.exports = bodyParser;
1
2
3
4
// 导入自定义的中间件模块
const myBodyParser = require('./custom-body-parser.js');
// 注册自定义的中间件模块
app.use(myBodyParser);