Nodejs中Express 常用中间件 body-parser 实现解析
写在前面
body-parser
是非常常用的一个express
中间件,作用是对post请求的请求体进行解析。使用非常简单,以下两行代码已经覆盖了大部分的使用场景。
app.use(bodyparser.json()); app.use(bodyparser.urlencoded({ extended: false }));
本文从简单的例子出发,探究body-parser
的内部实现。至于body-parser
如何使用,感兴趣的同学可以参考。
入门基础
在正式讲解前,我们先来看一个post请求的报文,如下所示。
post /test http/1.1 host: 127.0.0.1:3000 content-type: text/plain; charset=utf8 content-encoding: gzip chyingp
其中需要我们注意的有content-type
、content-encoding
以及报文主体:
- content-type:请求报文主体的类型、编码。常见的类型有text/plain、application/json、application/x-www-form-urlencoded。常见的编码有utf8、gbk等。
- content-encoding:声明报文主体的压缩格式,常见的取值有gzip、deflate、identity。
- 报文主体:这里是个普通的文本字符串chyingp。
body-parser主要做了什么
body-parser
实现的要点如下:
1.处理不同类型的请求体:比如text、json、urlencoded等,对应的报文主体的格式不同。
2.处理不同的编码:比如utf8、gbk等。
3.处理不同的压缩类型:比如gzip、deflare等。
4.其他边界、异常的处理。
一、处理不同类型请求体
为了方便读者测试,以下例子均包含服务端、客户端代码,完整代码可在笔者github上找到。
解析text/plain
客户端请求的代码如下,采用默认编码,不对请求体进行压缩。请求体类型为text/plain
。
var http = require('http'); var options = { hostname: '127.0.0.1', port: '3000', path: '/test', method: 'post', headers: { 'content-type': 'text/plain', 'content-encoding': 'identity' } }; var client = http.request(options, (res) => { res.pipe(process.stdout); }); client.end('chyingp');
服务端代码如下。text/plain
类型处理比较简单,就是buffer的拼接。
var http = require('http'); var parsepostbody = function (req, done) { var arr = []; var chunks; req.on('data', buff => { arr.push(buff); }); req.on('end', () => { chunks = buffer.concat(arr); done(chunks); }); }; var server = http.createserver(function (req, res) { parsepostbody(req, (chunks) => { var body = chunks.tostring(); res.end(`your nick is ${body}`) }); }); server.listen(3000);
解析application/json
客户端代码如下,把content-type
换成application/json
。
var http = require('http'); var querystring = require('querystring'); var options = { hostname: '127.0.0.1', port: '3000', path: '/test', method: 'post', headers: { 'content-type': 'application/json', 'content-encoding': 'identity' } }; var jsonbody = { nick: 'chyingp' }; var client = http.request(options, (res) => { res.pipe(process.stdout); }); client.end( json.stringify(jsonbody) );
服务端代码如下,相比text/plain
,只是多了个json.parse()
的过程。
var http = require('http'); var parsepostbody = function (req, done) { var length = req.headers['content-length'] - 0; var arr = []; var chunks; req.on('data', buff => { arr.push(buff); }); req.on('end', () => { chunks = buffer.concat(arr); done(chunks); }); }; var server = http.createserver(function (req, res) { parsepostbody(req, (chunks) => { var json = json.parse( chunks.tostring() ); // 关键代码 res.end(`your nick is ${json.nick}`) }); }); server.listen(3000);
解析application/x-www-form-urlencoded
客户端代码如下,这里通过querystring
对请求体进行格式化,得到类似nick=chyingp
的字符串。
var http = require('http'); var querystring = require('querystring'); var options = { hostname: '127.0.0.1', port: '3000', path: '/test', method: 'post', headers: { 'content-type': 'form/x-www-form-urlencoded', 'content-encoding': 'identity' } }; var postbody = { nick: 'chyingp' }; var client = http.request(options, (res) => { res.pipe(process.stdout); }); client.end( querystring.stringify(postbody) );
服务端代码如下,同样跟text/plain
的解析差不多,就多了个querystring.parse()
的调用。
var http = require('http'); var querystring = require('querystring'); var parsepostbody = function (req, done) { var length = req.headers['content-length'] - 0; var arr = []; var chunks; req.on('data', buff => { arr.push(buff); }); req.on('end', () => { chunks = buffer.concat(arr); done(chunks); }); }; var server = http.createserver(function (req, res) { parsepostbody(req, (chunks) => { var body = querystring.parse( chunks.tostring() ); // 关键代码 res.end(`your nick is ${body.nick}`) }); }); server.listen(3000);
二、处理不同编码
很多时候,来自客户端的请求,采用的不一定是默认的utf8
编码,这个时候,就需要对请求体进行解码处理。
客户端请求如下,有两个要点。
1.编码声明:在content-type最后加上;charset=gbk
2.请求体编码:这里借助了iconv-lite,对请求体进行编码iconv.encode('程序猿小卡', encoding)
var http = require('http'); var iconv = require('iconv-lite'); var encoding = 'gbk'; // 请求编码 var options = { hostname: '127.0.0.1', port: '3000', path: '/test', method: 'post', headers: { 'content-type': 'text/plain; charset=' + encoding, 'content-encoding': 'identity', } }; // 备注:nodejs本身不支持gbk编码,所以请求发送前,需要先进行编码 var buff = iconv.encode('程序猿小卡', encoding); var client = http.request(options, (res) => { res.pipe(process.stdout); }); client.end(buff, encoding);
服务端代码如下,这里多了两个步骤:编码判断、解码操作。首先通过content-type
获取编码类型gbk
,然后通过iconv-lite
进行反向解码操作。
var http = require('http'); var contenttype = require('content-type'); var iconv = require('iconv-lite'); var parsepostbody = function (req, done) { var obj = contenttype.parse(req.headers['content-type']); var charset = obj.parameters.charset; // 编码判断:这里获取到的值是 'gbk' var arr = []; var chunks; req.on('data', buff => { arr.push(buff); }); req.on('end', () => { chunks = buffer.concat(arr); var body = iconv.decode(chunks, charset); // 解码操作 done(body); }); }; var server = http.createserver(function (req, res) { parsepostbody(req, (body) => { res.end(`your nick is ${body}`) }); }); server.listen(3000);
三、处理不同压缩类型
这里举个gzip
压缩的例子。客户端代码如下,要点如下:
1.压缩类型声明:content-encoding赋值为gzip。
2.请求体压缩:通过zlib模块对请求体进行gzip压缩。
var http = require('http'); var zlib = require('zlib'); var options = { hostname: '127.0.0.1', port: '3000', path: '/test', method: 'post', headers: { 'content-type': 'text/plain', 'content-encoding': 'gzip' } }; var client = http.request(options, (res) => { res.pipe(process.stdout); }); // 注意:将 content-encoding 设置为 gzip 的同时,发送给服务端的数据也应该先进行gzip var buff = zlib.gzipsync('chyingp'); client.end(buff);
服务端代码如下,这里通过zlib
模块,对请求体进行了解压缩操作(guzip)。
var http = require('http'); var zlib = require('zlib'); var parsepostbody = function (req, done) { var length = req.headers['content-length'] - 0; var contentencoding = req.headers['content-encoding']; var stream = req; // 关键代码如下 if(contentencoding === 'gzip') { stream = zlib.creategunzip(); req.pipe(stream); } var arr = []; var chunks; stream.on('data', buff => { arr.push(buff); }); stream.on('end', () => { chunks = buffer.concat(arr); done(chunks); }); stream.on('error', error => console.error(error.message)); }; var server = http.createserver(function (req, res) { parsepostbody(req, (chunks) => { var body = chunks.tostring(); res.end(`your nick is ${body}`) }); }); server.listen(3000);
写在后面
body-parser
的核心实现并不复杂,翻看源码后你会发现,更多的代码是在处理异常跟边界。
另外,对于post请求,还有一个非常常见的content-type
是multipart/form-data
,这个的处理相对复杂些,body-parser
不打算对其进行支持。篇幅有限,后续章节再继续展开。
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。