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

本文涉及的产品
Serverless 应用引擎免费试用套餐包,4320000 CU,有效期3个月
性能测试 PTS,5000VUM额度
云原生网关 MSE Higress,422元/月
简介:

写在前面

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

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

sshpp
相关文章
|
3月前
|
缓存 前端开发 中间件
[go 面试] 前端请求到后端API的中间件流程解析
[go 面试] 前端请求到后端API的中间件流程解析
|
26天前
|
消息中间件 中间件 数据库
NServiceBus:打造企业级服务总线的利器——深度解析这一面向消息中间件如何革新分布式应用开发与提升系统可靠性
【10月更文挑战第9天】NServiceBus 是一个面向消息的中间件,专为构建分布式应用程序设计,特别适用于企业级服务总线(ESB)。它通过消息队列实现服务间的解耦,提高系统的可扩展性和容错性。在 .NET 生态中,NServiceBus 提供了强大的功能,支持多种传输方式如 RabbitMQ 和 Azure Service Bus。通过异步消息传递模式,各组件可以独立运作,即使某部分出现故障也不会影响整体系统。 示例代码展示了如何使用 NServiceBus 发送和接收消息,简化了系统的设计和维护。
41 3
|
6月前
|
存储 缓存 JSON
玩转Express(二)登录态&中间件
玩转Express(二)登录态&中间件
|
3月前
|
中间件 PHP 开发者
深入解析 Laravel 中的 HTTP 中间件
【8月更文挑战第31天】
28 0
|
4月前
|
设计模式 中间件 测试技术
PHP中的中间件模式解析与实践
【7月更文挑战第11天】在现代Web开发中,中间件模式已成为设计高效、可维护应用程序的关键。本文深入探讨了PHP环境下中间件模式的实现方法,并提供了一个实际示例来演示如何利用中间件优化请求处理流程。
39 1
|
4月前
|
中间件 数据库 开发者
解析Python Web框架的四大支柱:模板、ORM、中间件与路由
【7月更文挑战第20天】Python Web框架如Django、Flask、FastAPI的核心包括模板(如Django的DTL和Flask的Jinja2)、ORM(Django的内置ORM与Flask的SQLAlchemy)、中间件(Django的全局中间件与Flask的装饰器实现)和路由(Django的urls.py配置与Flask的@app.route()装饰器)。这些组件提升了代码组织和数据库操作的便捷性,确保了Web应用的稳定性和可扩展性。
63 0
|
6月前
|
开发框架 JavaScript 中间件
深入探索Node.js的Express框架:使用与中间件详解
【4月更文挑战第30天】本文深入探讨了Node.js的Express框架,介绍了其作为Web开发的强大工具,主要聚焦于基本使用和中间件。Express是基于Node.js的Web应用框架,用于构建高效的应用和API。文章详细讲解了如何安装Express,创建简单应用,以及中间件的工作原理和应用,包括中间件的顺序、错误处理和挂载位置。此外,还提到了使用第三方中间件扩展功能。理解Express基础和中间件对于开发高质量Web应用至关重要。
|
6月前
|
开发框架 安全 中间件
38、中间件漏洞解析-IIS6.0
38、中间件漏洞解析-IIS6.0
74 0
|
28天前
|
JavaScript 前端开发 中间件
探索后端技术:Node.js与Express框架的完美融合
【10月更文挑战第7天】 在当今数字化时代,Web应用已成为日常生活不可或缺的一部分。本文将深入探讨后端技术的两大重要角色——Node.js和Express框架,分析它们如何通过其独特的特性和优势,为现代Web开发提供强大支持。我们将从Node.js的非阻塞I/O和事件驱动机制,到Express框架的简洁路由和中间件特性,全面解析它们的工作原理及应用场景。此外,本文还将分享一些实际开发中的小技巧,帮助你更有效地利用这些技术构建高效、可扩展的Web应用。无论你是刚入门的新手,还是经验丰富的开发者,相信这篇文章都能为你带来新的启发和思考。
|
1月前
|
开发框架 JavaScript 前端开发
使用 Node.js 和 Express 构建 Web 应用
【10月更文挑战第2天】使用 Node.js 和 Express 构建 Web 应用

推荐镜像

更多