Node.js API中如何使用zlib模块

2024-12-09 技术教程

小编这次要给大家分享的是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_FLUSHzlib.constants.Z_PARTIAL_FLUSHzlib.constants.Z_SYNC_FLUSHzlib.constants.Z_FULL_FLUSHzlib.constants.Z_FINISHzlib.constants.Z_BLOCKzlib.constants.Z_TREES// 返回压缩/解压函数的返回值. 发送错误时为负值, 正值用于特殊但正常的事件.zlib.constants.Z_OKzlib.constants.Z_STREAM_ENDzlib.constants.Z_NEED_DICTzlib.constants.Z_ERRNOzlib.constants.Z_STREAM_ERRORzlib.constants.Z_DATA_ERRORzlib.constants.Z_MEM_ERRORzlib.constants.Z_BUF_ERRORzlib.constants.Z_VERSION_ERROR// 压缩等级.zlib.constants.Z_NO_COMPRESSIONzlib.constants.Z_BEST_SPEEDzlib.constants.Z_BEST_COMPRESSIONzlib.constants.Z_DEFAULT_COMPRESSION// 压缩策略zlib.constants.Z_FILTEREDzlib.constants.Z_HUFFMAN_ONLYzlib.constants.Z_RLEzlib.constants.Z_FIXEDzlib.constants.Z_DEFAULT_STRATEGYOptions

说明：

每一个类都有一个 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：

说明：

创建并返回一个带有给定 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]）