body-parser 是 Express 中用于格式化請(qǐng)求體數(shù)據(jù)的一個(gè)三方庫(kù)。

以下是一個(gè) body-parser 的常用使用案例。

const express = require('express')
const bodyParser = require('body-parser')

const app = express()

// parse application/x-www-form-urlencoded
app.use(bodyParser.urlencoded({ extended: false }))

// parse application/json
app.use(bodyParser.json())

app.use(function (req, res) {
  res.setHeader('Content-Type', 'text/plain')
  res.write('you posted:\n')
  res.end(JSON.stringify(req.body, null, 2))
})

以上代碼設(shè)置的含義是：項(xiàng)目中所有 Content-Type 是 "application/x-www-form-urlencoded" 或 "application/json" 請(qǐng)求數(shù)據(jù)都會(huì)經(jīng)過(guò) body-parser 中間件的處理，并設(shè)置到 req.body 屬性上。

下面就來(lái)詳細(xì)介紹 body-parser 的安裝和使用。

安裝

$ npm install body-parser

使用也比較簡(jiǎn)單。

const bodyParser = require('body-parser')

我們是通過(guò)調(diào)用 bodyParser 對(duì)象的方法來(lái)獲取不同 Content-Type 的數(shù)據(jù)處理能力的。下面就來(lái)介紹。

API

bodyParser 上一共提供了 4 個(gè)方法來(lái)使用，分別對(duì)應(yīng) 4 種不同類型的請(qǐng)求體數(shù)據(jù)。

1. bodyParser.json([options])
2. bodyParser.urlencoded([options])
3. bodyParser.text([options])
4. bodyParser.raw([options])

其中前 2 種是我們最常使用的。接下來(lái)分別介紹。

bodyParser.json([options])

返回能解析 json 數(shù)據(jù)的中間件，默認(rèn)匹配 Content-Type 值為 "application/json"（可以通過(guò) options.type 進(jìn)行控制）。接受任何 Unicode  編碼的請(qǐng)求體數(shù)據(jù)，而且還支持 gzip 和 deflate 壓縮算法的自動(dòng)解壓。

解析好的請(qǐng)求體數(shù)據(jù)會(huì)放在 req.body 屬性上，無(wú)請(qǐng)求體數(shù)據(jù)則返回一個(gè)空對(duì)象（{}）。

Options 選項(xiàng)

這是一個(gè)可選參數(shù)，不傳入則使用默認(rèn)選項(xiàng)。其他 3 個(gè)方法與此類似，在此講 1 遍后，如果沒(méi)有特殊情況，后面就不再贅述了。

• type：默認(rèn)值是 "application/json"，表示這個(gè)中間件默認(rèn)匹配的 Content-Type 是 "application/json"，這個(gè)字段除了接收字符串，還支持接收對(duì)象和數(shù)組。你也可以自定義，比如設(shè)置成 "*/json"（內(nèi)部是使用 type-is[1] 做匹配的）
• inflate：是否開(kāi)啟自動(dòng)解壓請(qǐng)求體數(shù)據(jù)的能力，默認(rèn)為 true（目前支持 支持 gzip 和 deflate 2 中壓縮算法）
• limit：控制最大請(qǐng)求正文大小，否則報(bào)錯(cuò)。默認(rèn)值是 '100kb'（內(nèi)部傳遞給 bytes[2] 庫(kù)將其解析成字節(jié)數(shù)進(jìn)行判斷處理）
• reviver：body-parser 內(nèi)部默認(rèn)使用 JSON.parse() 方法將字符串格式化成對(duì)象設(shè)置到 req.body 上。這個(gè)參數(shù)就是傳遞給 JSON.parse() 方法的第 2 個(gè)參數(shù)，用來(lái)自定義解析行為。搞不清楚的同學(xué)可以看一下 MDN 上 JSON.parse() 的使用文檔[3]
• strict：默認(rèn)為 true，用來(lái)控制內(nèi)部 JSON.parse() 所接收的字符串是否只能是對(duì)象和數(shù)組。設(shè)置成 false 時(shí)表示可以接受任意類型的字符串?dāng)?shù)據(jù)

bodyParser.urlencoded([options])

默認(rèn)處理 Content-Type 值為 "application/x-www-form-urlencoded" 的請(qǐng)求體數(shù)據(jù)。

.urlencoded() 中間件還提供了一個(gè)布爾參數(shù) urlencoded，用來(lái)決定使用哪一個(gè)查詢解析庫(kù)來(lái)處理請(qǐng)求參數(shù)。

• urlencoded為 false 時(shí)，內(nèi)部使用 querystring 庫(kù)解析
• urlencoded為 true 時(shí)，內(nèi)部使用 qs 庫(kù)解析

qs 與 querystring 的區(qū)別在于：querystring 只能解析簡(jiǎn)單 key-value 對(duì)，qs 則支持嵌套對(duì)象的 key-value 對(duì)的解析，后者功能會(huì)更加強(qiáng)大。

Options 選項(xiàng)

• urlencoded：以上已介紹過(guò)。默認(rèn)為 true（即使用 qs 解析參數(shù)），不過(guò)已被棄。官方推薦顯式傳入一個(gè)值，這就需要你了解 qs 和 querystring 之間的區(qū)別
• parameterLimit：控制 URL 編碼數(shù)據(jù)中允許的最大參數(shù)數(shù)量，默認(rèn)是 1000。多于這個(gè)值，會(huì)向客戶端返回 413 響應(yīng)碼

bodyParser.text([options])

默認(rèn)處理 Content-Type 值為 "text/plain" 的請(qǐng)求體數(shù)據(jù)。

Options 選項(xiàng)

• defaultCharset：如果請(qǐng)求頭中的 Content-Type 頭中沒(méi)有指定字符集，則使用這個(gè)字段所指定的文本內(nèi)容的默認(rèn)字符集。默認(rèn)為 "utf-8"。

bodyParser.raw([options])

默認(rèn)處理 Content-Type 值為 "application/octet-stream" 的請(qǐng)求體數(shù)據(jù)。

不支持 multipart/form-data

body-parser 并不支持處理 Content-Type 是 "multipart/form-data" 的請(qǐng)求體數(shù)據(jù)。如果你有這方面的需求，可以參照下面的庫(kù)進(jìn)行選擇。

• busboy[4] 和 connect-busboy[5]
• multiparty[6] 和 connect-multiparty[7]
• formidable[8]
• multer[9]

express 已內(nèi)置 body-parser

express 從 v4.17.0 開(kāi)始[10]，已全面內(nèi)置了 body-parser 功能，你直接可以通過(guò) express().json() / express().raw()/express().text()/ express().urlencoded() 4 個(gè) API。

在內(nèi)部，這 4 方法其實(shí)是 body-parser 借著 express 暴露出來(lái)[11]的。也就是說(shuō)項(xiàng)目中你無(wú)需安裝 body-parser 依賴了。

const bodyParser = require('body-parser')

/**
 * Expose middleware
 */

exports.json = bodyParser.json
exports.query = require('./middleware/query');
exports.raw = bodyParser.raw
exports.text = bodyParser.text
exports.urlencoded = bodyParser.urlencoded

總結(jié)

本文介紹了 Express 中用于解析請(qǐng)求體數(shù)據(jù)的中間件 body-parser。 其實(shí) Express 在 v4.17.0 中已完整內(nèi)置了 body-parser 的能力，你可以通過(guò) express() 上的 .json()/.urlencoded()/.text()/.raw() 方法訪問(wèn)到。

就介紹到這里了，希望本文對(duì)你有所幫助，感謝閱讀，再見(jiàn)。

參考資料

[1]type-is: https://www.npmjs.org/package/type-is#readme

[2]bytes: https://www.npmjs.com/package/bytes

[3]MDN 上 JSON.parse() 的使用文檔: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse#Example.3A_Using_the_reviver_parameter

[4]busboy: https://www.npmjs.org/package/busboy#readme

[5]connect-busboy: https://www.npmjs.org/package/connect-busboy#readme

[6]multiparty: https://www.npmjs.org/package/multiparty#readme

[7]connect-multiparty: https://www.npmjs.org/package/connect-multiparty#readme

[8]formidable: https://www.npmjs.org/package/formidable#readme

[9]multer: https://www.npmjs.org/package/multer#readme

[10]從 v4.17.0 開(kāi)始: https://expressjs.com/en/4x/api.html#express.json

[11]body-parser 借著 express 暴露出來(lái): https://github.com/expressjs/express/blob/4.18.2/lib/express.js#L78