Express 常用中间件 body-parser 实现解析

本文涉及的产品
云原生网关 MSE Higress,422元/月
Serverless 应用引擎免费试用套餐包,4320000 CU,有效期3个月
注册配置 MSE Nacos/ZooKeeper,118元/月
简介:

写在前面

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

app.use(bodyParser.json());app.use(bodyParser.urlencoded({ extended: false }));

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

入门基础

在正式讲解前我们先来看一个POST请求的报文如下所示。

POST /test HTTP/1.1Host: 127.0.0.1:3000Content-Type: text/plain; charset=utf8Content-Encoding: gzipchyingp

其中需要我们注意的有Content-TypeContent-Encoding以及报文主体

  • Content-Type请求报文主体的类型、编码。常见的类型有text/plainapplication/jsonapplication/x-www-form-urlencoded。常见的编码有utf8gbk等。

  • Content-Encoding声明报文主体的压缩格式常见的取值有gzipdeflateidentity

  • 报文主体这里是个普通的文本字符串chyingp

body-parser主要做了什么

body-parser实现的要点如下

  1. 处理不同类型的请求体比如textjsonurlencoded等对应的报文主体的格式不同。

  2. 处理不同的编码比如utf8gbk等。

  3. 处理不同的压缩类型比如gzipdeflare等。

  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 的同时发送给服务端的数据也应该先进行gzipvar 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-Typemultipart/form-data这个的处理相对复杂些body-parser不打算对其进行支持。篇幅有限后续章节再继续展开。



本文转自 sshpp 51CTO博客,原文链接:http://blog.51cto.com/12902932/1928072,如需转载请自行联系原作者

相关文章
|
5月前
uView queryParams 对象转URL参数
uView queryParams 对象转URL参数
58 0
|
5月前
|
JavaScript 前端开发 中间件
Node.js—Express使用、Express 路由 、Express 中间件、托管静态资源、使用 Express 写接口、node.js链接sqlite数据库
Node.js—Express使用、Express 路由 、Express 中间件、托管静态资源、使用 Express 写接口、node.js链接sqlite数据库
214 0
|
5月前
|
前端开发 JavaScript 中间件
React Proxy 详细流程与配置方式(webpack、setupProxy.js、package.json)
React Proxy 详细流程与配置方式(webpack、setupProxy.js、package.json)
310 0
|
5月前
|
前端开发 JavaScript 中间件
React Proxy 详细流程与配置方式(webpack、setupProxy.js、package.json)
React Proxy 详细流程与配置方式(webpack、setupProxy.js、package.json)
571 0
|
前端开发 中间件
82 # koa-bodyparser 中间件的使用以及实现
82 # koa-bodyparser 中间件的使用以及实现
60 0
|
设计模式 存储 JavaScript
Provider Pattern 的介绍与 JavaScript 实现
在软件开发中,设计模式是一种经过实践验证的解决问题的经验总结。其中,Provider Pattern(提供者模式)是一种常用的设计模式之一。它的主要目标是将数据或服务的提供与使用解耦,从而提高代码的可维护性和可扩展性。本文将从浅入深介绍 Provider Pattern,并提供使用 JavaScript 实现该模式的示例代码。
180 0
|
设计模式 缓存 前端开发
Prototype Pattern 技术在 Web 前端中的应用与实现
Prototype Pattern 是一种常用的设计模式,在 Web 前端开发中也有广泛的应用。本文将由浅入深地介绍 Prototype Pattern 技术,包括其定义、如何使用 JavaScript 实现它、在开发中的应用场景以及优缺点。
111 0
|
设计模式 存储 前端开发
使用 JS 快速理解 Container/Presentational Pattern
在现代Web前端开发中,构建可维护、可扩展的应用程序变得越来越重要。为了实现这一目标,开发者需要遵循一些设计模式和最佳实践。其中之一是Container/Presentational(容器/展示)模式,它是一种用于组织和管理前端代码的技术。 本文将深入探讨Container/Presentational模式的概念,介绍如何使用JavaScript实现它,并探讨它在开发中的应用场景、优点和缺点。我们还将介绍一些知名项目中使用到这种模式的实际案例。
250 0
express学习7-express参数中post参数的获取
express学习7-express参数中post参数的获取
221 0
express学习7-express参数中post参数的获取
|
前端开发
fetch 配合 express 使用req body为空
最近用 node 写后端接口 前端使用fetch,遇到个问题记录如下 使用fetch进行post请求的时候,后端node 使用express框架进行body接收的时候始终是个空对象 {}
560 0
fetch 配合 express 使用req body为空