この記事では、Nodejs で解析を実装するための一般的な Express ミドルウェア body-parser を主に紹介します。興味のある方は参考にしてください。
body-parser
は、非常に一般的に使用される express
ミドルウェア。投稿のリクエスト本文に使用されます。リクエスト が解析されます。使い方は非常に簡単です。次の 2 行のコードでほとんどの使用シナリオがカバーされています。
app.use(bodyParser.json()); app.use(bodyParser.urlencoded({ extended: false }));
この記事は簡単な例から始まり、body-parser
の内部実装について説明します。 body-parser
の使用方法については、興味のある学生は公式ドキュメントを参照してください。 body-parser
是非常常用的一个express
中间件,作用是对post请求的请求体进行解析。使用非常简单,以下两行代码已经覆盖了大部分的使用场景。
POST /test HTTP/1.1 Host: 127.0.0.1:3000 Content-Type: text/plain; charset=utf8 Content-Encoding: gzip chyingp
本文从简单的例子出发,探究body-parser
的内部实现。至于body-parser
如何使用,感兴趣的同学可以参考官方文档。
入门基础
在正式讲解前,我们先来看一个POST请求的报文,如下所示。
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');
其中需要我们注意的有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 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);
服务端代码如下。text/plain
类型处理比较简单,就是buffer的拼接。
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) );
解析application/json
客户端代码如下,把Content-Type
换成application/json
。
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);
服务端代码如下,相比text/plain
,只是多了个JSON.parse()
的过程。
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) );
解析application/x-www-form-urlencoded
客户端代码如下,这里通过querystring
对请求体进行格式化,得到类似nick=chyingp
的字符串。
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);
服务端代码如下,同样跟text/plain
的解析差不多,就多了个querystring.parse()
的调用。
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);
二、处理不同编码
很多时候,来自客户端的请求,采用的不一定是默认的utf8
编码,这个时候,就需要对请求体进行解码处理。
客户端请求如下,有两个要点。
1.编码声明:在Content-Type最后加上;charset=gbk
2.请求体编码:这里借助了iconv-lite,对请求体进行编码iconv.encode('程序猿小卡', encoding)
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);
服务端代码如下,这里多了两个步骤:编码判断、解码操作。首先通过Content-Type
获取编码类型gbk
,然后通过iconv-lite
进行反向解码操作。
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);
三、处理不同压缩类型
这里举个gzip
压缩的例子。客户端代码如下,要点如下:
1.压缩类型声明:Content-Encoding赋值为gzip。
2.请求体压缩:通过zlib模块对请求体进行gzip压缩。
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);
服务端代码如下,这里通过zlib
模块,对请求体进行了解压缩操作(guzip)。
写在后面
body-parser
的核心实现并不复杂,翻看源码后你会发现,更多的代码是在处理异常跟边界。
另外,对于POST请求,还有一个非常常见的Content-Type
是multipart/form-data
,这个的处理相对复杂些,body-parser
正式な説明の前に、まず以下に示す POST リクエスト メッセージを見てみましょう。 rrreeeContent-Type
、Content-Encoding
、メッセージ本文などに注意する必要があります:
Content-Type: リクエストメッセージ本文のタイプとエンコーディング。一般的なタイプには、 text/plain、application/json、application/x-www-form-urlencoded などがあります。一般的なエンコーディングには、utf8、gbk などが含まれます。
body-parser
実装の重要なポイントは次のとおりです: 🎜🎜🎜1. さまざまなタイプのリクエストボディを処理します。 : text 、 json 、 urlencoded など、対応するメッセージ本文の形式が異なります。 🎜🎜🎜2. utf8、gbk などのさまざまなエンコーディングを処理します。 🎜🎜🎜3. さまざまな圧縮タイプを処理します: gzip、deflare など。 🎜🎜🎜4. その他の境界と例外の処理。 🎜🎜🎜1. さまざまなタイプのリクエストボディの処理🎜🎜🎜読者のテストを容易にするために、次の例にはサーバーとクライアントのコードが含まれています。完全なコードは作者の github にあります。 🎜🎜🎜text/plain🎜🎜🎜クライアントリクエストを解析するコードは次のとおりです。デフォルトのエンコーディングを使用し、リクエスト本文を圧縮しません。リクエストボディタイプは text/plain
です。 🎜rrreee🎜サーバーコードは以下の通りです。 text/plain
タイプの処理は比較的単純で、バッファの結合です。 🎜rrreee🎜🎜 application/json を解析します🎜🎜🎜 クライアント コードは次のとおりです。Content-Type
を application/json
に置き換えます。 🎜rrreee🎜 サーバーコードは次のとおりです。 text/plain
と比較すると、JSON.parse()
の処理が追加されているだけです。 🎜rrreee🎜🎜Parse application/x-www-form-urlencoded🎜🎜🎜クライアント コードは次のとおりです。ここでは、リクエスト本文は nick=chyingp のようなものを取得するために <code>querystring
を通じてフォーマットされています。 文字列。 🎜rrreee🎜サーバー コードは次のとおりです。これは text/plain
の解析に似ていますが、querystring.parse()
の呼び出しが追加されています。 🎜rrreee🎜🎜 2. さまざまなエンコーディングの処理 🎜🎜🎜 多くの場合、クライアントからのリクエストは、必ずしもデフォルトの utf8
エンコーディングを使用するとは限りません。このとき、リクエスト本文をデコードする必要があります。 🎜🎜クライアントのご要望は以下の通りで、主に2点あります。 🎜🎜🎜1. エンコードステートメント: Content-Type の最後に charset=gbk を追加します🎜🎜🎜2. リクエストボディのエンコードには、iconv-lite が使用されます iconv.encode('Programmer Xiaoka' ,エンコード)🎜rrreee🎜 サーバーコードは次のとおりです。エンコード判定とデコード操作の 2 つのステップがあります。まず、Content-Type
を通じてエンコード タイプ gbk
を取得し、次に iconv-lite
を通じて逆デコード操作を実行します。 🎜rrreee🎜🎜3. さまざまな圧縮タイプの処理🎜🎜🎜gzip
圧縮の例を次に示します。クライアント コードは次のとおりで、重要なポイントは次のとおりです: 🎜🎜🎜1. 圧縮タイプの宣言: Content-Encoding には値 gzip が割り当てられます。 🎜🎜🎜2. リクエスト本文の圧縮: zlib モジュールを通じてリクエスト本文を gzip 圧縮します。 🎜rrreee🎜サーバーコードは次のとおりです。ここでは、リクエストボディが zlib
モジュールを通じて解凍 (guzip) されています。 🎜rrreee🎜🎜後ろに書かれています🎜🎜🎜 body-parser
のコア実装は複雑ではありません。ソース コードを見ると、より多くのコードが例外と境界を処理していることがわかります。 🎜🎜さらに、POST リクエストの場合、multipart/form-data
という非常に一般的な Content-Type
があり、この処理は比較的複雑です。 body-parser
はそれをサポートするつもりはありません。スペースが限られているので、次の章でさらに拡張していきます。 🎜🎜🎜【関連おすすめ】🎜🎜1. 🎜Javascriptの無料ビデオチュートリアル🎜🎜🎜2. 🎜マーキースクロール効果を実装するJSの詳細な例🎜🎜🎜3. 🎜QQチャットメッセージ表示とコメント投稿機能を作成するためのJSコード例🎜 🎜4. モバイルでお金の形式検証を実装するための 1 行の JS
5. JavaScript フォーム検証の実装コード_javascript スキル
以上がNodejsでよく使われるミドルウェアbody-parserの例を詳しく解説の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。