Nodejs 进阶：Express 经常使用中间件 body-parser 实现解析

时间 2019-11-15

标签 nodejs 进阶 express 经常使用中间件 body parser 实现解析繁體版

原文原文链接

本文摘录自《Nodejs学习笔记》，更多章节及更新，请访问 github主页地址。欢迎加群交流，群号 197339705。javascript

写在前面

body-parser是很是经常使用的一个express中间件，做用是对post请求的请求体进行解析。使用很是简单，如下两行代码已经覆盖了大部分的使用场景。java

app.use(bodyParser.json());
app.use(bodyParser.urlencoded({ extended: false }));复制代码

本文从简单的例子出发，探究body-parser的内部实现。至于body-parser如何使用，感兴趣的同窗能够参考官方文档。node

入门基础

在正式讲解前，咱们先来看一个POST请求的报文，以下所示。git

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以及报文主体：github

Content-Type：请求报文主体的类型、编码。常见的类型有text/plain、application/json、application/x-www-form-urlencoded。常见的编码有utf8、gbk等。
Content-Encoding：声明报文主体的压缩格式，常见的取值有gzip、deflate、identity。
报文主体：这里是个普通的文本字符串chyingp。

body-parser主要作了什么

body-parser实现的要点以下：express

处理不一样类型的请求体：好比text、json、urlencoded等，对应的报文主体的格式不一样。
处理不一样的编码：好比utf8、gbk等。
处理不一样的压缩类型：好比gzip、deflare等。
其余边界、异常的处理。

1、处理不一样类型请求体

为了方便读者测试，如下例子均包含服务端、客户端代码，完整代码可在笔者github上找到。json

解析text/plain

客户端请求的代码以下，采用默认编码，不对请求体进行压缩。请求体类型为text/plain。app

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的拼接。ide

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。post

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);复制代码

2、处理不一样编码

不少时候，来自客户端的请求，采用的不必定是默认的utf8编码，这个时候，就须要对请求体进行解码处理。

客户端请求以下，有两个要点。

编码声明：在Content-Type最后加上;charset=gbk
请求体编码：这里借助了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);复制代码

3、处理不一样压缩类型

这里举个gzip压缩的例子。客户端代码以下，要点以下：

压缩类型声明：Content-Encoding赋值为gzip。
请求体压缩：经过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不打算对其进行支持。篇幅有限，后续章节再继续展开。

欢迎交流，若有错漏请指出。