6.node----中间件

Express 中间件

中间件的概念

1.什么是中间件

中间件（Middleware），特指业务流程的中间处理环节。

2.Express中间件的调用流程

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

3.Express中间件的格式

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

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


app.get('/',function(req, res, next) {
    next() // callback argument to the middleware function, called "next" by convention
})

4.next 函数的作用

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

Express中间件的初体验

1.定义中间件函数

可以通过如下的方式，定义一个最简单的中间件函数：

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

2.全局生效的中间件

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

// 常量mw所指向的，就是一个中间件函数
const mw = function(req, res, next) {
    console.log('这是一个简单的中间件函数')
    next()
}

// 全局生效的中间件
app.use(mw)

3.定义全局中间件的简化形式

// 全局生效的中间件
app.use(function(req, res, next) {
    console.log('这是一个最简单的中间件函数')
    next()
})

4.中间的作用

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

sequenceDiagram
客户端->>中间件1:请求
中间件1->>中间件2:req.a = 10; next()
中间件1->>中间件N:req.c = 30; next()
中间件N->>处理完毕，响应这次请求:可以访问req.a和req.c属性的值
处理完毕，响应这次请求->>客户端:响应

5.定义多个全局中间件

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

app.use(function(req, res, next) {// 第一个全局中间件
    console.log('调用了第一个全局中间件')
    next()
})
app.use(function(req, res, next) {// 第二个全局中间件
    console.log('调用了第二个全局中间件')
    next()
})
app.get('/user', (req, res) => {// 请求这个路由，会依次触发上述两个全局中间件
    res.send('Home page.')
})

6.局部生效的中间件

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

const mw1 = function(req, res, next) {
    console.log('这是中间件函数')
    next()
}
// mw1 这个中间件只在“当前路由生效”，这种用法属于“局部生效的中间件”
app.get('/', mw1, function(req, res) {
    res.send('Home page.')
})
// mw1 这个中间件不会影响下面这个路由
app.get('/user', function(req, res) {
    res.send('User page.')
})

7.定义多个局部中间件

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

// 以下两种写法是“完全等件”的,可根据自己的喜好，选择任意一种方式进行使用
app.get('/', mw1, mw2, (req, res) => { res.send('Home page.') })
app.get('/', [mw1, mw2], (req, res) => { res.send('Home page.') })

8.了解中间件的5个注意事项

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

中间件多分类

为了方便理解和记忆中间的使用，Express官方把常见的中间件用法，分成了5大类，分别是：

• 应用级别的中间件
• 路由级别的中间件
• 错误级别的中间件
• Express内置的中间件
• 第三方的中间件

1.应用级别的中间件

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

// 应用级别的中间件（全局中间件）
app.use(function(req, res, next) {
    next()
})

// 应用级别的中间件（局部中间件）
app.get('/', mw1, function(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)。

app.get('/', function(req, res) { // 1.路由
    throw new Error('服务器内部发生了错误！') // 1.1抛出一个自定义的错误
})

app.use(function(err, req, res, next) { // 2.错误级别的中间件
    console.log('发生了错误:' + err.message) // 2.1在服务器打印错误消息
    res.send('Error!' + err.message) // 2.2 向客户端响应错误相关的内容
})

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

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+版本中可用）

// 配置解析application/json格式数据内置中间件
app.use(express.json())
// 配置解析application/x-www-form-urlencoded格式数据的内置中间件
app.use(express.urlencoded({ extended: false }))

5.第三方的中间件

非Express官方内置的，而是由第三方开发出来的中间件，叫做第三方中间件。在项目中，大家可以按需下载并配置第三方中间件，从而提高项目的开发效率。
例如：在express@4.16.0之前的版本中，经常使用body-parser这个第三方中间件，来解析请求体数据。使用步骤如下：

• 运行npm install body-parser安装中间件
• 使用require导入中间件
• 调用app.use()注册并使用中间件

注意：Express 内置的express.urlencoded中间件，就是基于body-parser这个第三方中间件进一步封装出来的。

自定义中间件

1.需求描述与实现步骤

自己手动模拟一个类似于express.urlencoded这样的中间件，来解析POST提交到服务器的表单数据。

• 定义中间件
• 监听req的data事件
• 监听req的end事件
• 使用querystring模块解析请求体数据
• 将解析出来的数据对象挂载为req.body
• 将自定义中间件封装为模块

2.定义中间件

app.use((req, res, next) => {
    // 定义中间件具体的业务逻辑
})

3.监听req的data事件

在中间件中，需要监听req对象的data事件，来获取客户端发送到服务器的数据。
如果数据量比较大，无法一次性发送完毕，则客户端会把数据切割后，分批发送到服务器。所以data事件可能会触发多次，每一次触发data事件时，获取到数据只是完整数据的一部分，需要手动对接收到的数据进行拼接。

// 定义变量，用来存储客户端发送过来的请求体数据
let str = ''
// 监听req对象的data事件（客户端发送过来的新的请求体数据）
req.on('data', (chunk) => {
    // 拼接请求体数据，隐式转换为字符串
    str += chunk
})

4.监听req的end事件

当请求体数据接收完毕之后，会自动触发req的end事件。
因此，我们可以在req的end事件中，拿到并处理完整的请求体数据。示例代码如下：

// 监听req对象的end事件（请求体发送完毕后自动触发）
req.on('end', () => {
    // 打印完整的请求体数据
    console.log(str)
    // TODO：把字符串格式的请求体数据，解析成对象格式
})

5.使用querystring模块解析请求体数据

Node.js内置了一个querystring模块，专门用来处理查询字符串。通过这个模块提供的parse()函数，可以轻松把查询字符串，解析成对象的格式。示例代码如下：

// 导入处理querystring的Node.js内置模块
const qs = require('querystring')
// 调用qs.parse()方法，把查询字符串解析为对象
const body = qs.parse(str)

6.将解析出来的数据对象挂载为req.body

上游的中间件和下游的中间件及路由之间，共享同一份req和res。因此，我们可以将解析出来的数据，挂载为req的自定义属性，命名为req.body，供下游使用。示例代码如下：

req.on('end', () => {
    const body = qs.parse(str) // 调用qs.parse()方法，把查询字符串解析为对象
    req.body = body            // 将解析出来的请求体对象，挂载为req.body属性
    next()                     // 最后，一定要调用next()函数，执行后续的业务逻辑
})

7.将自定义中间件封装为模块

为了代码的结构，我们可以把自定义的中间件函数，封装为独立的模块，示例代码如下：

// custom-body-parse.js 模块中的代码
const qs = require('querystring')
function bodyParser(req, res, next) { /* 省略其它代码 */ }
module.exports = bodyParser // 向外导出解析请求体数据的中间件函数



// ---------------------分割线-----------------------

// 1.导入自定义的中间件模块
const myBodyParser = require('custom-body-parser')
// 2.注册自定义的中间件模块
app.use(myBodyParser)