自定义中间件

需求描述与实现步骤

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

实现步骤:

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

定义中间件

使用app.use()来定义全局生效的中间件:

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

监听req的data事件

在中间件中,需要监听req对象的data事件,来获取客户端发送到服务器的数据

如果数据量比较大,无法一次性发送完毕,客户端则会把数据切割后,分批发送到服务器,所以data事件可能会出发多次,每一次触发data事件时,获取到数据只是完整数据的一部分,需要手动拼接收到的数据

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

监听req的end事件

当请求体数据接收完毕之后,会自动触发req的end事件

因此可以在req的end事件中,拿到并处理完整的请求体数据:

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

使用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,供下游使用,示例代码:

res.on('end', () => {
    const body = qs.parse(str)//调用qs.parse()方法 把查询字符串解析为对象
    req.body = body;
    next();
})

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

为了优化代码的结构,可以把自定义的中间件函数,封装为独立的模块,代码如下:

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

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

//导入自定义的中间件模块
const myBodyParser = require('custom-body-parser');

//注册自定义的中间件模块
app.use(myBodyParser);

 

完整代码示例:

自定义模块:

//导入node.js内置的querystring模块
const qs = require('querystring');

//解析表单数据的中间件
const bodyParser = (req, res, next) => {
    //定义中间件的业务逻辑
    //定义一个str字符串 用来存储客户端发送过来的请求体数据
    let str = '';
    //监听req的data事件
    req.on('data', (chunk) => {
        str += chunk;
    })
    req.on('end', () => {
        //在str中存放的是完整的请求体数据
        // console.log(str);
        //TODO: 把字符串格式的请求体数据解析成对象格式
        const body = qs.parse(str);
        req.body = body;
        next();
    })
}

module.exports = bodyParser;

导入自定义模块并使用:

const express = require('../module/node_modules/express/lib/express.js');

const app = express();

//导入自己封装的中间件模块
const customBodyParser = require('./custom-body-parser');
//将自定义的中间件函数 注册为全局可用的中间件
app.use(customBodyParser);

app.post('/user', (req, res) => {
    res.send(req.body);
})

app.listen(80, () => {
    console.log('Express server running at http://127.0.0.1');
})