Node.js API詳解之 zlib模塊用法分析
本文實(shí)例講述了Node.js API詳解之 zlib模塊用法。分享給大家供大家參考,具體如下:
Node.js API詳解之 zlib
zlib模塊提供通過(guò) Gzip 和 Deflate/Inflate 實(shí)現(xiàn)的壓縮功能,可以通過(guò)這樣使用它:
const zlib = require('zlib');
壓縮或者解壓數(shù)據(jù)流(例如一個(gè)文件)通過(guò)zlib流將源數(shù)據(jù)流傳輸?shù)侥繕?biāo)流中來(lái)完成:
const gzip = zlib.createGzip(); const fs = require('fs'); const inp = fs.createReadStream('input.txt'); const out = fs.createWriteStream('input.txt.gz'); inp.pipe(gzip).pipe(out);
zlib 可以用來(lái)實(shí)現(xiàn)對(duì) HTTP 中定義的 gzip 和 deflate 內(nèi)容編碼機(jī)制的支持。
HTTP 的 Accept-Encoding 頭字段用來(lái)標(biāo)記客戶端接受的壓縮編碼。
注意: 下面給出的示例大幅簡(jiǎn)化,用以展示了基本的概念。使用 zlib 編碼成本會(huì)很高, 結(jié)果應(yīng)該被緩存。
// 客戶端請(qǐng)求示例 const zlib = require('zlib'); const http = require('http'); const fs = require('fs'); const request = http.get({ host: 'example.com', path: '/', port: 80, headers: { 'Accept-Encoding': 'gzip,deflate' } }); request.on('response', (response) => { const output = fs.createWriteStream('example.com_index.html'); switch (response.headers['content-encoding']) { // 或者, 只是使用 zlib.createUnzip() 方法去處理這兩種情況 case 'gzip': response.pipe(zlib.createGunzip()).pipe(output); break; case 'deflate': response.pipe(zlib.createInflate()).pipe(output); break; default: response.pipe(output); break; } });
// 服務(wù)端示例 // 對(duì)每一個(gè)請(qǐng)求運(yùn)行 gzip 操作的成本是十分高昂的. // 緩存壓縮緩沖區(qū)是更加高效的方式. const zlib = require('zlib'); const http = require('http'); const fs = require('fs'); http.createServer((request, response) => { const raw = fs.createReadStream('index.html'); let acceptEncoding = request.headers['accept-encoding']; if (!acceptEncoding) { acceptEncoding = ''; } // 注意:這不是一個(gè)合適的 accept-encoding 解析器. // 查閱 http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.3 if (/\bdeflate\b/.test(acceptEncoding)) { response.writeHead(200, { 'Content-Encoding': 'deflate' }); raw.pipe(zlib.createDeflate()).pipe(response); } else if (/\bgzip\b/.test(acceptEncoding)) { response.writeHead(200, { 'Content-Encoding': 'gzip' }); raw.pipe(zlib.createGzip()).pipe(response); } else { response.writeHead(200, {}); raw.pipe(response); } }).listen(1337);
Constants(常量)
說(shuō)明:
這些被定義在 zlib.h 的全部常量同時(shí)也被定義在 require('zlib').constants 常量上.
注意: 以前, 可以直接從 require('zlib') 中獲取到這些常量, 例如 zlib.Z_NO_FLUSH.
目前仍然可以從模塊中直接訪問(wèn)這些常量, 但是不推薦使用.
demo:
const zlib = require('zlib'); // 可接受的 flush 值. zlib.constants.Z_NO_FLUSH zlib.constants.Z_PARTIAL_FLUSH zlib.constants.Z_SYNC_FLUSH zlib.constants.Z_FULL_FLUSH zlib.constants.Z_FINISH zlib.constants.Z_BLOCK zlib.constants.Z_TREES // 返回壓縮/解壓函數(shù)的返回值. 發(fā)送錯(cuò)誤時(shí)為負(fù)值, 正值用于特殊但正常的事件. zlib.constants.Z_OK zlib.constants.Z_STREAM_END zlib.constants.Z_NEED_DICT zlib.constants.Z_ERRNO zlib.constants.Z_STREAM_ERROR zlib.constants.Z_DATA_ERROR zlib.constants.Z_MEM_ERROR zlib.constants.Z_BUF_ERROR zlib.constants.Z_VERSION_ERROR // 壓縮等級(jí). zlib.constants.Z_NO_COMPRESSION zlib.constants.Z_BEST_SPEED zlib.constants.Z_BEST_COMPRESSION zlib.constants.Z_DEFAULT_COMPRESSION // 壓縮策略 zlib.constants.Z_FILTERED zlib.constants.Z_HUFFMAN_ONLY zlib.constants.Z_RLE zlib.constants.Z_FIXED zlib.constants.Z_DEFAULT_STRATEGY
Options
說(shuō)明:
每一個(gè)類都有一個(gè) options 對(duì)象. 所有的選項(xiàng)都是可選的.
注意:一些選項(xiàng)只與壓縮相關(guān), 會(huì)被解壓類忽視.
demo:
const zlib = require('zlib'); const Options = { flush: zlib.constants.Z_NO_FLUSH, finishFlush: zlib.constants.Z_FINISH, chunkSize: 16*1024, windowBits 2, //值在8..15的范圍內(nèi),這個(gè)參數(shù)的值越大,內(nèi)存使用率越高,壓縮效果越好。如果使用deflateInit,則默認(rèn)值為15 level: 6, //(壓縮級(jí)別,值在0-9之間,1速度最快,9壓縮比最大,各自折中取值6較為合適。僅壓縮有效) memLevel: 8, // (指定多少內(nèi)存應(yīng)該內(nèi)部壓縮狀態(tài)進(jìn)行分配,1是最小內(nèi)存速度慢壓縮比低。9是最大內(nèi)存,速度最快。默認(rèn)值為8。僅壓縮有效) strategy: 7, // (用于調(diào)整壓縮算法,僅壓縮有效) dictionary: ' | | ', // (僅解壓有效,默認(rèn)值為空字典) info: true //(如果true,返回一個(gè)buffer對(duì)象和engine) }
zlib.constants
說(shuō)明:
提供一個(gè)列舉出 Zlib 相關(guān)常數(shù)的對(duì)象。
demo:
const zlib = require('zlib'); console.log(zlib.constants); // { Z_NO_FLUSH: 0, // Z_PARTIAL_FLUSH: 1, // Z_SYNC_FLUSH: 2, // Z_FULL_FLUSH: 3, // Z_FINISH: 4, // Z_BLOCK: 5, // Z_OK: 0, // Z_STREAM_END: 1, // Z_NEED_DICT: 2, // Z_ERRNO: -1, // Z_STREAM_ERROR: -2, // Z_DATA_ERROR: -3, // Z_MEM_ERROR: -4, // Z_BUF_ERROR: -5, // Z_VERSION_ERROR: -6, // Z_NO_COMPRESSION: 0, // Z_BEST_SPEED: 1, // Z_BEST_COMPRESSION: 9, // Z_DEFAULT_COMPRESSION: -1, // Z_FILTERED: 1, // Z_HUFFMAN_ONLY: 2, // Z_RLE: 3, // Z_FIXED: 4, // Z_DEFAULT_STRATEGY: 0, // ZLIB_VERNUM: 4784, // DEFLATE: 1, // INFLATE: 2, // GZIP: 3, // GUNZIP: 4, // DEFLATERAW: 5, // INFLATERAW: 6, // UNZIP: 7, // Z_MIN_WINDOWBITS: 8, // Z_MAX_WINDOWBITS: 15, // Z_DEFAULT_WINDOWBITS: 15, // Z_MIN_CHUNK: 64, // Z_MAX_CHUNK: Infinity, // Z_DEFAULT_CHUNK: 16384, // Z_MIN_MEMLEVEL: 1, // Z_MAX_MEMLEVEL: 9, // Z_DEFAULT_MEMLEVEL: 8, // Z_MIN_LEVEL: -1, // Z_MAX_LEVEL: 9, // Z_DEFAULT_LEVEL: -1 }
zlib.createDeflate(options)
說(shuō)明:
創(chuàng)建并返回一個(gè)帶有給定 options 的新的 Deflate 對(duì)象。
可以使用 deflate 壓縮數(shù)據(jù)。
demo:
const zlib = require('zlib'); const deflate = zlib.createDeflate(); const fs = require('fs'); const inp = fs.createReadStream('a.js'); console.log( inp.pipe(deflate) ); // Deflate { // _readableState: // ReadableState { ... }, // bytesRead: 0, // _handle: Zlib { jsref: [Circular], onerror: [Function: zlibOnError] }, // _hadError: false, // _writeState: Uint32Array [ 0, 0 ], // _outBuffer: , // _outOffset: 0, // _level: -1, // _strategy: 0, // _chunkSize: 16384, // _flushFlag: 0, // _scheduledFlushFlag: 0, // _origFlushFlag: 0, // _finishFlushFlag: 4, // _info: undefined }
zlib.createInflate(options)
說(shuō)明:
創(chuàng)建并返回一個(gè)帶有給定 options 的新的 Inflate 對(duì)象。
Inflate 用于解壓一個(gè) deflate 流。
demo:
const zlib = require('zlib'); const deflate = zlib.createDeflate(); const inflate = zlib.createInflate(); const fs = require('fs'); const inp = fs.createReadStream('a.js'); console.log( inp.pipe(deflate).pipe(inflate) );
zlib.createDeflateRaw(options)
說(shuō)明:
創(chuàng)建并返回一個(gè)帶有給定 options 的新的 DeflateRaw 對(duì)象.
使用 deflate 壓縮數(shù)據(jù),并且不附加一個(gè) zlib 頭。
demo:
const zlib = require('zlib'); const deflateRaw = zlib.createDeflateRaw(); const fs = require('fs'); const inp = fs.createReadStream('a.js'); console.log( inp.pipe(deflateRaw) );
zlib.createInflateRaw(options)
說(shuō)明:
創(chuàng)建并返回一個(gè)帶有給定 options 的新的 InflateRaw 對(duì)象。
InflateRaw 用于解壓一個(gè) raw deflate 流。
demo:
const zlib = require('zlib'); const deflateRaw = zlib.createDeflateRaw(); const inflateRaw = zlib.createInflateRaw(); const fs = require('fs'); const inp = fs.createReadStream('a.js'); console.log( inp.pipe(deflateRaw).pipe(inflateRaw) );
zlib.createGzip(options)
說(shuō)明:
創(chuàng)建并返回一個(gè)帶有給定 options 的新的 Gunzip 對(duì)象。
使用 gzip 壓縮數(shù)據(jù)。
demo:
const zlib = require('zlib'); const gzip = zlib.createGzip(); const fs = require('fs'); const inp = fs.createReadStream('a.js'); console.log( inp.pipe(gzip) );
zlib.createGunzip(options)
說(shuō)明:
創(chuàng)建并返回一個(gè)帶有給定 options 的新的 Gunzip 對(duì)象
使用Gunzip解壓縮 gzip 流。
demo:
const zlib = require('zlib'); const gzip = zlib.createGzip(); const gunzip = zlib.createGunzip(); const fs = require('fs'); const inp = fs.createReadStream('a.js'); console.log( inp.pipe(gzip).pipe(gunzip) );
zlib.createUnzip(options)
說(shuō)明:
創(chuàng)建并返回一個(gè)帶有給定 options 的新的 Unzip 對(duì)象。
Unzip 對(duì)象通過(guò)自動(dòng)檢測(cè)頭信息解壓 Gzip 或者 Deflate 壓縮的流.
demo:
const zlib = require('zlib'); const gzip = zlib.createGzip(); const unzip = zlib.createUnzip(); const fs = require('fs'); const inp = fs.createReadStream('a.js'); console.log( inp.pipe(gzip).pipe(unzip) );
Convenience Methods(簡(jiǎn)便用法)
說(shuō)明:
上面我們介紹了各個(gè)壓縮類的使用。下面介紹一些對(duì)應(yīng)的簡(jiǎn)便用法。
所有這些方法都將 Buffer, [TypeArray], DataView, 或者字符串作為第一個(gè) 參數(shù),
一個(gè)回調(diào)函數(shù)作為可選的第二個(gè)參數(shù)提供給 zlib 類, 會(huì)在 callback(error, result) 中調(diào)用.
每一個(gè)方法相對(duì)應(yīng)的都有一個(gè)接受相同參數(shù), 但是沒(méi)有回調(diào)的 *Sync 版本.
zlib.deflate(buffer [,options],callback)
zlib.deflateSync(buffer [,options])
zlib.inflate(buffer [,options],callback)
zlib.inflateSync(buffer [,options])
zlib.deflateRaw(buffer [,options],callback)
zlib.deflateRawSync(buffer [,options])
zlib.inflateRaw(buffer [,options],callback)
zlib.inflateRawSync(buffer [,options])
zlib.gzip(buffer [,options],callback)
zlib.gzipSync(buffer [,options])
zlib.gunzip(buffer [,options],callback)
zlib.gunzipSync(buffer [,options])
zlib.unzip(buffer [,options],callback)
zlib.unzipSync(buffer [,options])
使用方式如下:
demo:
const input = '.................................'; zlib.deflate(input, (err, buffer) => { if (!err) { console.log(buffer.toString('base64')); } else { // 錯(cuò)誤處理 } }); const buffer = Buffer.from('eJzT0yMAAGTvBe8=', 'base64'); zlib.unzip(buffer, (err, buffer) => { if (!err) { console.log(buffer.toString()); } else { // 錯(cuò)誤處理 } });
希望本文所述對(duì)大家node.js程序設(shè)計(jì)有所幫助。
相關(guān)文章
H5微信公眾號(hào)授權(quán)的簡(jiǎn)單實(shí)現(xiàn)步驟
如果用戶在微信客戶端中訪問(wèn)第三方網(wǎng)頁(yè),公眾號(hào)可以通過(guò)微信網(wǎng)頁(yè)授權(quán)機(jī)制,來(lái)獲取用戶基本信息,進(jìn)而實(shí)現(xiàn)業(yè)務(wù)邏輯,這篇文章主要給大家介紹了關(guān)于微信公眾號(hào)授權(quán)的相關(guān)資料,需要的朋友可以參考下2021-07-07js圖片閃動(dòng)特效可以控制間隔時(shí)間如幾分鐘閃動(dòng)一下
這篇文章主要介紹一個(gè)圖片閃動(dòng)特效,可以控制間隔時(shí)間如幾分鐘閃動(dòng)一下,需要的朋友不要錯(cuò)過(guò)2014-08-08JavaScript中的AOP編程的基本實(shí)現(xiàn)
面向切面編程給我們提供了一個(gè)方法,讓我們可以在不修改目標(biāo)邏輯的情況下,將代碼注入到現(xiàn)有的函數(shù)或?qū)ο笾小=裉焱ㄟ^(guò)本文給大家分享JavaScript中的AOP編程的基本實(shí)現(xiàn)方法,需要的朋友參考下吧2021-07-07js 獲取當(dāng)前web應(yīng)用的上下文路徑實(shí)現(xiàn)方法
下面小編就為大家?guī)?lái)一篇js 獲取當(dāng)前web應(yīng)用的上下文路徑實(shí)現(xiàn)方法。小編覺(jué)得挺不錯(cuò)的,現(xiàn)在就分享給大家,也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧2016-08-08javascript淡入淡出效果的實(shí)現(xiàn)思路
這個(gè)思路是最近寫XScroll.js類的時(shí)候想明白的。平常我們說(shuō)的淡入淡出效果,一般分成兩部分,一半是淡入,另一半就是淡出了。不過(guò)經(jīng)過(guò)分析,我覺(jué)得其實(shí)只需要一半就行了2012-03-03JavaScript實(shí)現(xiàn)經(jīng)典排序算法之選擇排序
這篇文章主要為大家詳細(xì)介紹了JavaScript實(shí)現(xiàn)經(jīng)典排序算法之選擇排序,具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2016-12-12