AI 助理
文档备案控制台
开发者社区 云原生 中间件 文章 正文

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

2017-05-22 7366
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： body-parser是非常常用的一个express中间件，作用是对post请求的请求体进行解析。使用非常简单，本文从简单的例子出发，探究body-parser的内部实现。至于body-parser如何使用，感兴趣的同学可以参考官方文档。

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

写在前面

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不打算对其进行支持。篇幅有限，后续章节再继续展开。

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

相关链接

https://github.com/expressjs/body-parser/

https://github.com/ashtuchkin/iconv-lite

文章标签：
云解析DNS
JavaScript
前端开发
中间件
数据格式
JSON
关键词：
中间件解析
node.js express
中间件express
node.js中间件
云解析DNS中间件
程序猿小卡
目录
相关文章
空白诗
|
JavaScript 网络协议 前端开发
【Nodejs】WebSocket 全面解析+实战演练——（Nodejs实现简易聊天室）
【Nodejs】WebSocket 全面解析+实战演练——（Nodejs实现简易聊天室）
空白诗
1013 0
可乐鸡翅kele
|
存储 缓存 JSON
玩转Express（二）登录态&中间件
玩转Express（二）登录态&中间件
可乐鸡翅kele
332 0
一缕微风绕指柔
|
Web App开发 JSON JavaScript
Node.js 中的中间件机制与 Express 应用
Node.js 中的中间件机制与 Express 应用
一缕微风绕指柔
292 5
warmhearted
|
JavaScript 中间件 API
中间件应用Express.js（Node.js）
【5月更文挑战第3天】我们定义了一个名为 `logger` 的中间件函数。它接受请求对象、响应对象以及下一个中间件函数作为参数。当接收到请求时，它会打印出请求的 HTTP 方法和 URL，然后调用 `next()` 函数来将控制权传递给下一个中间件或路由处理器。我们使用 `app.use()` 方法将 `logger` 中间件添加到了应用级别的中间件堆栈中，这意味着它将对所有请求生效。
warmhearted
169 3
中间件应用Express.js（Node.js）
warmhearted
|
JSON 中间件 API
中间件API示例（以Express.js为例）
【6月更文挑战第14天】
warmhearted
204 8
啊猪是的读来过倒
|
Python
Python面向对象进阶：深入解析面向对象三要素——封装、继承与多态
Python面向对象进阶：深入解析面向对象三要素——封装、继承与多态
啊猪是的读来过倒
319 5
肥晨
|
SQL JavaScript 前端开发
简单用Nodejs + express 编写接口
【6月更文挑战第3天】该文介绍了如何在Node.js和Express中创建GET和POST接口。首先，简要提到了准备工作，建议查阅上一篇文章。接着展示了GET接口的示例，说明可以直接在浏览器中请求。然后，详细解释了POST接口的步骤，包括引入Express模块、设置路由处理程序、解析请求体及处理请求。最后，强调了编写接口时应注意错误处理、安全性、中间件使用、路由组织、日志记录、性能优化和测试等关键点。作者以肥晨的身份结尾，鼓励关注其分享的前端学习资料和技术动态。
肥晨
435 1
肥晨
|
JavaScript NoSQL 数据库连接
使用Nodejs + express连接数据库mongoose
【6月更文挑战第3天】这篇文章介绍了如何在Express应用中使用Mongoose连接MongoDB数据库。首先，需要创建一个`db.js`文件，然后通过`npm install mongoose`安装Mongoose驱动。接着，在应用中引入MongoDB模块，建立到数据库的连接。创建一个Mongoose schema定义数据模型，如用户信息表。最后，执行数据库操作，包括查询、插入、更新和删除文档，并在完成后关闭数据库连接。文中还提供了相关代码示例。
肥晨
483 1
GR鲸鱼
|
C语言
C语言进阶⑫(指针下)(指针和数组笔试题解析)(杨氏矩阵)（上）
C语言进阶⑫(指针下)(指针和数组笔试题解析)(杨氏矩阵)
GR鲸鱼
151 0
好奇的菜鸟
|
前端开发 开发者
CSS文本样式全面解析：从基础到进阶
CSS文本样式全面解析：从基础到进阶
好奇的菜鸟
195 0
云原生

中间件

热门文章

最新文章

  • 1
    3分钟，了解阿里云热门开发者工具 Cloud Toolkit
  • 2
    阿里中间件首席架构师钟华：《企业IT架构转型之道：阿里巴巴中台战略思想与架构实战》新书出版（含试读PDF）！
  • 3
    【沉淀】从网络中间件到搜索，从移动开发到分布式计算平台，阿里高级专家李睿博谈自己的折腾路
  • 4
    HiSDP —— 高效的C++软件开发平台
  • 5
    开发者说：Sentinel 流控功能在 SpringMVC/SpringBoot 上的实践
  • 6
    业界主流MQ对比
  • 7
    性能压测工具选型对比
  • 8
    Kafka、RabbitMQ、RocketMQ发送小消息性能对比
  • 9
    《麻省理工科技评论》是如何评价阿里云中间件技术的？
  • 10
    Java 类是如何被加载的
  • 1
    从“工具过载”到“精准调用”：破解 Agent 工具管理难题
    20
  • 2
    数据跨境、隐私泄露、审计溯源——出海企业三大安全必答题
    30
  • 3
    RUM 链路打通实战：打破移动端可观测性黑洞
    34
  • 4
    从 ReAct 到 Ralph Loop：AI Agent 的持续迭代范式
    88
  • 5
    阿里开源 Assistant Agent，助力企业快速构建答疑、诊断智能助手
    246
  • 6
    面向多租户云的 IO 智能诊断：从异常发现到分钟级定位
    113
  • 7
    阿里云微服务引擎 MSE 及 API 网关 2025 年 12 月产品动态
    56
  • 8
    阿里云可观测 2025 年 12 月产品动态
    68
  • 9
    阿里云可观测联合 Datadog 发布 OpenTelemetry Go 自动插桩工具
    104
  • 10
    阿里云全新发布的 UModel 是什么
    135

    • 相关课程

    更多
  • 第八届大学生创新创业大赛阿里命题IoT赛题解析
  • 云计算工程师解析与实战-网络专家篇（体验版）
  • 深入解析Docker容器化技术
  • Java面试疑难点解析 - 面试技巧及语言基础
  • Java面试疑难点解析 - Java Web开发
  • Java面试疑难点解析 - 系统架构及项目设计

    • 相关电子书

    更多
  • 金融分布式中间件分享
  • 无需部署的前端中间件技术——企业移动化新思路
  • 《云原生中间件精品案例集》

    • 推荐镜像

    更多
  • DNS
    • 下一篇
    附部署代码｜云数据库RDS 全托管 Supabase服务：小白轻松搞定开发AI应用