Nodejs中Express 常用中間件 body-parser 實現(xiàn)解析

更新時間：2017年05月22日 08:24:09 作者：程序猿小卡

這篇文章主要介紹了Nodejs中Express 常用中間件 body-parser 實現(xiàn)解析，具有一定的參考價值，感興趣的小伙伴們可以參考一下

寫在前面

body-parser是非常常用的一個express中間件，作用是對post請求的請求體進行解析。使用非常簡單，以下兩行代碼已經(jīng)覆蓋了大部分的使用場景。

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

本文從簡單的例子出發(fā)，探究body-parser的內(nèi)部實現(xiàn)。至于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：聲明報文主體的壓縮格式，常見的取值有g(shù)zip、deflate、identity。
報文主體：這里是個普通的文本字符串chyingp。

body-parser主要做了什么

body-parser實現(xiàn)的要點如下：

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() );  // 關(guān)鍵代碼  
    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()的調(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);

二、處理不同編碼

很多時候，來自客戶端的請求，采用的不一定是默認的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編碼，所以請求發(fā)送前，需要先進行編碼
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壓縮的例子?？蛻舳舜a如下，要點如下：

1.壓縮類型聲明：Content-Encoding賦值為gzip。

2.請求體壓縮：通過zlib模塊對請求體進行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 設置為 gzip 的同時，發(fā)送給服務端的數(shù)據(jù)也應該先進行g(shù)zip
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;

  // 關(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);

寫在后面

body-parser的核心實現(xiàn)并不復雜，翻看源碼后你會發(fā)現(xiàn)，更多的代碼是在處理異常跟邊界。

另外，對于POST請求，還有一個非常常見的Content-Type是multipart/form-data，這個的處理相對復雜些，body-parser不打算對其進行支持。篇幅有限，后續(xù)章節(jié)再繼續(xù)展開。

以上就是本文的全部內(nèi)容，希望對大家的學習有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章: