Nodejs中Express 常用中間件 body-parser 實(shí)現(xiàn)解析
寫(xiě)在前面
body-parser是非常常用的一個(gè)express中間件，作用是對(duì)post請(qǐng)求的請(qǐng)求體進(jìn)行解析。使用非常簡(jiǎn)單，以下兩行代碼已經(jīng)覆蓋了大部分的使用場(chǎng)景。
app.use(bodyParser.json());
app.use(bodyParser.urlencoded({ extended: false }));
本文從簡(jiǎn)單的例子出發(fā)，探究body-parser的內(nèi)部實(shí)現(xiàn)。至于body-parser如何使用，感興趣的同學(xué)可以參考官方文檔。
入門(mén)基礎(chǔ)
在正式講解前，我們先來(lái)看一個(gè)POST請(qǐng)求的報(bào)文，如下所示。
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以及報(bào)文主體：
- Content-Type：請(qǐng)求報(bào)文主體的類(lèi)型、編碼。常見(jiàn)的類(lèi)型有text/plain、application/json、application/x-www-form-urlencoded。常見(jiàn)的編碼有utf8、gbk等。
- Content-Encoding：聲明報(bào)文主體的壓縮格式，常見(jiàn)的取值有g(shù)zip、deflate、identity。
- 報(bào)文主體：這里是個(gè)普通的文本字符串chyingp。
body-parser主要做了什么
body-parser實(shí)現(xiàn)的要點(diǎn)如下：
1.處理不同類(lèi)型的請(qǐng)求體：比如text、json、urlencoded等，對(duì)應(yīng)的報(bào)文主體的格式不同。
2.處理不同的編碼：比如utf8、gbk等。
3.處理不同的壓縮類(lèi)型：比如gzip、deflare等。
4.其他邊界、異常的處理。
一、處理不同類(lèi)型請(qǐng)求體
為了方便讀者測(cè)試，以下例子均包含服務(wù)端、客戶(hù)端代碼，完整代碼可在筆者github上找到。
解析text/plain
客戶(hù)端請(qǐng)求的代碼如下，采用默認(rèn)編碼，不對(duì)請(qǐng)求體進(jìn)行壓縮。請(qǐng)求體類(lèi)型為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');
服務(wù)端代碼如下。text/plain類(lèi)型處理比較簡(jiǎn)單，就是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
客戶(hù)端代碼如下，把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) );
服務(wù)端代碼如下，相比text/plain，只是多了個(gè)JSON.parse()的過(guò)程。
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() ); // 關(guān)鍵代碼
res.end(`Your nick is ${json.nick}`)
});
});
server.listen(3000);
解析application/x-www-form-urlencoded
客戶(hù)端代碼如下，這里通過(guò)querystring對(duì)請(qǐng)求體進(jìn)行格式化，得到類(lèi)似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) );
服務(wù)端代碼如下，同樣跟text/plain的解析差不多，就多了個(gè)querystring.parse()的調(diào)用。
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() ); // 關(guān)鍵代碼
res.end(`Your nick is ${body.nick}`)
});
});
server.listen(3000);
二、處理不同編碼
很多時(shí)候，來(lái)自客戶(hù)端的請(qǐng)求，采用的不一定是默認(rèn)的utf8編碼，這個(gè)時(shí)候，就需要對(duì)請(qǐng)求體進(jìn)行解碼處理。
客戶(hù)端請(qǐng)求如下，有兩個(gè)要點(diǎn)。
1.編碼聲明：在Content-Type最后加上;charset=gbk
2.請(qǐng)求體編碼：這里借助了iconv-lite，對(duì)請(qǐng)求體進(jìn)行編碼iconv.encode('程序猿小卡', encoding)
var http = require('http');
var iconv = require('iconv-lite');
var encoding = 'gbk'; // 請(qǐng)求編碼
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編碼，所以請(qǐng)求發(fā)送前，需要先進(jìn)行編碼
var buff = iconv.encode('程序猿小卡', encoding);
var client = http.request(options, (res) => {
res.pipe(process.stdout);
});
client.end(buff, encoding);
服務(wù)端代碼如下，這里多了兩個(gè)步驟：編碼判斷、解碼操作。首先通過(guò)Content-Type獲取編碼類(lèi)型gbk，然后通過(guò)iconv-lite進(jìn)行反向解碼操作。
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);
三、處理不同壓縮類(lèi)型
這里舉個(gè)gzip壓縮的例子?？蛻?hù)端代碼如下，要點(diǎn)如下：
1.壓縮類(lèi)型聲明：Content-Encoding賦值為gzip。
2.請(qǐng)求體壓縮：通過(guò)zlib模塊對(duì)請(qǐng)求體進(jìn)行g(shù)zip壓縮。
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 設(shè)置為 gzip 的同時(shí)，發(fā)送給服務(wù)端的數(shù)據(jù)也應(yīng)該先進(jìn)行g(shù)zip
var buff = zlib.gzipSync('chyingp');
client.end(buff);
服務(wù)端代碼如下，這里通過(guò)zlib模塊，對(duì)請(qǐng)求體進(jìn)行了解壓縮操作（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;
// 關(guān)鍵代碼如下
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);
寫(xiě)在后面
body-parser的核心實(shí)現(xiàn)并不復(fù)雜，翻看源碼后你會(huì)發(fā)現(xiàn)，更多的代碼是在處理異常跟邊界。
另外，對(duì)于POST請(qǐng)求，還有一個(gè)非常常見(jiàn)的Content-Type是multipart/form-data，這個(gè)的處理相對(duì)復(fù)雜些，body-parser不打算對(duì)其進(jìn)行支持。篇幅有限，后續(xù)章節(jié)再繼續(xù)展開(kāi)。
以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。
相關(guān)文章
詳解基于Node.js的微信JS-SDK后端接口實(shí)現(xiàn)代碼
本篇文章主要介紹了詳解基于Node.js的微信JS-SDK后端接口實(shí)現(xiàn)代碼，具有一定的參考價(jià)值，有興趣的可以了解一下2017-07-07
node.js微信小程序配置消息推送的實(shí)現(xiàn)
這篇文章主要介紹了node.js微信小程序配置消息推送的實(shí)現(xiàn)，小編覺(jué)得挺不錯(cuò)的，現(xiàn)在分享給大家，也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧2019-02-02
nodejs的HTML分析利器node-jquery用法淺析
這篇文章主要介紹了nodejs的HTML分析利器node-jquery用法,簡(jiǎn)單分析了node-jquery的功能并結(jié)合實(shí)例說(shuō)明了node-jquery控制臺(tái)輸出信息的操作技巧,需要的朋友可以參考下2016-11-11
這篇文章主要介紹了修改NPM全局模式的默認(rèn)安裝路徑的方法，文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2020-12-12
由于有些比較老的系統(tǒng)，使用的node版本較低，本機(jī)裝的node版本又比較高，不想降node版本，那么就需要考慮能不能在系統(tǒng)里管理多個(gè)node版本，本文主要介紹了切換node版本，感興趣的可以了解一下2024-04-04
node+express+axios實(shí)現(xiàn)單文件上傳功能
這篇文章主要為大家詳細(xì)介紹了node+express+axios實(shí)現(xiàn)單文件上傳功能，文中示例代碼介紹的非常詳細(xì)，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2022-08-08
node.js解決獲取圖片真實(shí)文件類(lèi)型的問(wèn)題
這篇文章主要介紹了node.js解決獲取圖片真實(shí)文件類(lèi)型的問(wèn)題,本文根據(jù)二進(jìn)制流及文件頭獲取文件類(lèi)型mime-type,然后讀取文件二進(jìn)制的頭信息,獲取其真實(shí)的文件類(lèi)型,需要的朋友可以參考下2014-12-12
Node中node_modules文件夾及package.json文件的作用說(shuō)明
這篇文章主要介紹了Node中node_modules文件夾及package.json文件的作用說(shuō)明，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2022-09-09
Node.js 使用 gRPC從定義到實(shí)現(xiàn)過(guò)程詳解
gRPC是一個(gè)高性能、開(kāi)源的遠(yuǎn)程過(guò)程調(diào)用（RPC）框架,由 Google 開(kāi)發(fā),它支持多種編程語(yǔ)言,旨在簡(jiǎn)化和優(yōu)化分布式系統(tǒng)中的服務(wù)通信,本文給大家介紹Node.js 使用 gRPC從定義到實(shí)現(xiàn)過(guò)程,感興趣的朋友跟隨小編一起看看吧2024-07-07
使用Nodejs編寫(xiě)一個(gè)腳本實(shí)現(xiàn)markdown轉(zhuǎn)pdf功能
Markdown?是一種輕量級(jí)的標(biāo)記語(yǔ)言,非常適合用來(lái)寫(xiě)作和記錄,將?Markdown?轉(zhuǎn)換為?PDF?可以讓文檔在格式和樣式上更加統(tǒng)一,也方便在不同設(shè)備和平臺(tái)上查看和打印,在接下來(lái)的內(nèi)容中我們將講解如何使用?NodeJs?編寫(xiě)一個(gè)?Markdown?轉(zhuǎn)?PDF?的腳本來(lái)實(shí)現(xiàn)我們這個(gè)想要的功能2024-05-05