本文例項講述了Node.js API詳解之 zlib模組用法。分享給大家供大家參考，具體如下：

Node.js API詳解之 zlib

zlib模組提供通過 Gzip 和 Deflate/Inflate 實現的壓縮功能，可以通過這樣使用它：

const zlib = require('zlib');

壓縮或者解壓資料流(例如一個檔案)通過zlib流將源資料流傳輸到目標流中來完成:

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 可以用來實現對 HTTP 中定義的 gzip 和 deflate 內容編碼機制的支援。
HTTP 的 Accept-Encoding 頭欄位用來標記客戶端接受的壓縮編碼。
注意: 下面給出的示例大幅簡化，用以展示了基本的概念。使用 zlib 編碼成本會很高,結果應該被快取。

// 客戶端請求示例
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;
 }
});

// 服務端示例
// 對每一個請求執行 gzip 操作的成本是十分高昂的.
// 快取壓縮緩衝區是更加高效的方式.
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 = '';
 }
 // 注意：這不是一個合適的 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（常量）

說明：

這些被定義在 zlib.h 的全部常量同時也被定義在 require('zlib').constants 常量上.
注意: 以前,可以直接從 require('zlib') 中獲取到這些常量,例如 zlib.Z_NO_FLUSH.
目前仍然可以從模組中直接訪問這些常量,但是不推薦使用.

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
// 返回壓縮/解壓函式的返回值. 傳送錯誤時為負值,正值用於特殊但正常的事件.
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
// 壓縮等級.
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

說明：

每一個類都有一個 options 物件. 所有的選項都是可選的.
注意：一些選項只與壓縮相關,會被解壓類忽視.

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的範圍內，這個引數的值越大，記憶體使用率越高，壓縮效果越好。如果使用deflateInit，則預設值為15
 level: 6,//(壓縮級別，值在0-9之間，1速度最快，9壓縮比最大，各自折中取值6較為合適。僅壓縮有效)
 memLevel: 8,// (指定多少記憶體應該內部壓縮狀態進行分配，1是最小記憶體速度慢壓縮比低。9是最大記憶體，速度最快。預設值為8。僅壓縮有效)
 strategy: 7,// (用於調整壓縮演算法,僅壓縮有效)
 dictionary: ' | | ',// (僅解壓有效，預設值為空字典)
 info: true  //(如果true,返回一個buffer物件和engine)
}

zlib.constants

說明：

提供一個列舉出 Zlib 相關常數的物件。

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)

說明：

建立並返回一個帶有給定 options 的新的 Deflate 物件。
可以使用 deflate 壓縮資料。

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)

說明：

建立並返回一個帶有給定 options 的新的 Inflate 物件。
Inflate 用於解壓一個 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)

說明：

建立並返回一個帶有給定 options 的新的 DeflateRaw 物件.
使用 deflate 壓縮資料，並且不附加一個 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)

說明：

建立並返回一個帶有給定 options 的新的 InflateRaw 物件。
InflateRaw 用於解壓一個 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)

說明：

建立並返回一個帶有給定 options 的新的 Gunzip 物件。
使用 gzip 壓縮資料。

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)

說明：

建立並返回一個帶有給定 options 的新的 Gunzip 物件
使用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)

說明：

建立並返回一個帶有給定 options 的新的 Unzip 物件。
Unzip 物件通過自動檢測頭資訊解壓 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(簡便用法)

說明：

上面我們介紹了各個壓縮類的使用。下面介紹一些對應的簡便用法。
所有這些方法都將 Buffer,[TypeArray],DataView,或者字串作為第一個 引數,
一個回撥函式作為可選的第二個引數提供給 zlib 類,會在 callback(error,result) 中呼叫.
每一個方法相對應的都有一個接受相同引數,但是沒有回撥的 *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 {
  // 錯誤處理
 }
});
const buffer = Buffer.from('eJzT0yMAAGTvBe8=','base64');
zlib.unzip(buffer,buffer) => {
 if (!err) {
  console.log(buffer.toString());
 } else {
  // 錯誤處理
 }
});

希望本文所述對大家node.js程式設計有所幫助。