Nodejs 進階：Express 常用中介軟體 body-parser 實現解析

程式猿小卡_casper發表於2019-03-02
NodeJSExpress

本文摘錄自《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不打算對其進行支援。篇幅有限，後續章節再繼續展開。

歡迎交流，如有錯漏請指出。

相關連結

github.com/expressjs/b…

github.com/ashtuchkin/…

相關文章