ZLIB （压缩）

优质

小牛编辑

140浏览

2023-12-01

Stability: 2 - Stable
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);

数据的压缩或解压缩也可以只用一个步骤完成：

const input = '.................................';
zlib.deflate(input, (err, buffer) => {
  if (!err) {
    console.log(buffer.toString('base64'));
  } else {
    // handle error
  }
});

const buffer = Buffer.from('eJzT0yMAAGTvBe8=', 'base64');
zlib.unzip(buffer, (err, buffer) => {
  if (!err) {
    console.log(buffer.toString());
  } else {
    // handle error
  }
});

Compressing HTTP requests and responses

zlib 模块可用于实现对 HTTP 定义的的内容编码机制 gzip 和 deflate 的支持.

HTTP 的 Accept-Encoding 头字段用来标记客户端接受的压缩编码. Content-Encoding 头字段用来标识实际应用于信息的压缩编码.

注意: 下面给出的示例大幅简化, 用以展示了基本的概念. 使用 zlib 编码成本会很高, 结果应该被缓存. 关于 zlib 使用中有关速度/内存/压缩互相权衡的信息, 查阅 Memory Usage Tuning.

// client request example
// 客户端请求示例
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);

默认情况下, 当解压不完整的数据时 zlib 方法会抛出一个错误. 然而, 如果它已经知道数据是不完整的, 或者仅仅是为了检查已压缩文件的开头, 可以通过改变用来解压最后一个的输入数据块的刷新方法来避免默认的错误处理.

// 这是一个上面例子中缓存区的不完整版本
const buffer = Buffer.from('eJzT0yMA', 'base64');

zlib.unzip(
  buffer,
  { finishFlush: zlib.constants.Z_SYNC_FLUSH },
  (err, buffer) => {
    if (!err) {
      console.log(buffer.toString());
    } else {
      // handle error
    }
  });

这不会改变其他抛出错误情况下的行为, 例如, 当输入内容的格式无效时. 使用这个方法, 无法确定输入是否过早结束, 或者缺乏完整性检查, 因此有必要人工检查解压结果是否有效.

Memory Usage Tuning

来自 zlib/zconf.h, 修改为 node.js 的用法:

解压所需的内存是(字节为单位):

(1 << (windowBits + 2)) + (1 << (memLevel + 9))

就是: 当设置为 windowBits=15 和 memLevel = 8 时(默认值), 小的对象需要 128k 加上几千字节.

例如, 为了将默认内存需求 256k 减少到 128k, 应该这样设置:

const options = { windowBits: 14, memLevel: 7 };

这能实现, 然而, 通常会降低压缩水平.

压缩所需的内存是 1 << windowBits (字节为单位). 既是, 设置为 windowBits=15(默认值) 时, 小的对象需要 32k 加上几千字节.

这是一个大小为 chunkSize 单个内部输出 slab 缓冲, 默认为 16k.

level 的设置是影响 zlib 压缩速度最大因素. 更高的等级设置会得到更高的压缩水平, 然而需要更长的时间完成. 较低的等级设置会导致较少的压缩, 但会大大加快速度.

通常来说, 更大的内存使用选项意味着 Node.js 必须减少调用 zlib, 因为它的每个 write 操作能够处理更多的数据. 所以, 这是另外一个影响速度的因素, 代价是内存的占用.

Flushing

在压缩流上调用 .flush() 方法将使 zlib 返回尽可能多的输出. 这可能是以压缩质量下降为代价的，但是当需要尽快提供数据时，这可能是有用的

在以下的实例中, flush() 方法用于将部分压缩过的 HTTP 响应返回给客户端:

const zlib = require('zlib');
const http = require('http');

http.createServer((request, response) => {
  // For the sake of simplicity, the Accept-Encoding checks are omitted.
  response.writeHead(200, { 'content-encoding': 'gzip' });
  const output = zlib.createGzip();
  output.pipe(response);

  setInterval(() => {
    output.write(`The current time is ${Date()}\n`, () => {
      // The data has been passed to zlib, but the compression algorithm may
      // have decided to buffer the data for more efficient compression.
      // Calling .flush() will make the data available as soon as the client
      // is ready to receive it.
      output.flush();
    });
  }, 1000);
}).listen(1337);

Constants

新增于: v0.5.8
这些被定义在 zlib.h 的全部常量同时也被定义在 require('zlib').constants 常量上. 不需要在正常的操作中使用这些常量. 记录他们为了使他们的存在并不奇怪. 这个章节几乎直接取自zlib documentation. 参阅 http://zlib.net/mamual.html#Constants 获取更多信息.

注意: 以前, 可以直接从 require('zlib') 中获取到这些常量, 例如 zlib.Z_NO_FLUSH. 目前仍然可以从模块中直接访问这些常量, 但是不推荐使用.

可接受的 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

Class Options

版本历史

版本	变更
v8.0.0	The `dictionary` option can be an Uint8Array now.
v5.11.0	The `finishFlush` option is supported now.
v0.11.1	新增于: v0.11.1

每一个类都有一个 options 对象. 所有的选项都是可选的.

注意一些选项只与压缩相关, 会被解压类忽视.

flush <integer> (default: zlib.constants.Z_NO_FLUSH)
finishFlush <integer> (default: zlib.constants.Z_FINISH)
chunkSize <integer> (default: 16*1024)
windowBits <integer>
level <integer> (compression only)
memLevel <integer> (compression only)
strategy <integer> (compression only)
dictionary <Buffer> | <TypedArray> | <DataView> (deflate/inflate only, empty dictionary by default)
info <boolean> (If true, returns an object with buffer and engine)

更多信息查阅在 http://zlib.net/manual.html#Advanced 关于 deflateInit2 以及 inflateInit2 的描述，

Class: zlib.Deflate

新增于: v0.5.8
Compress data using deflate.

Class: zlib.DeflateRaw

新增于: v0.5.8
Compress data using deflate, and do not append a zlib header.

Class: zlib.Gunzip

版本历史

版本	变更
v6.0.0	Trailing garbage at the end of the input stream will now result in an `error` event.
v5.9.0	Multiple concatenated gzip file members are supported now.
v5.0.0	A truncated input stream will now result in an `error` event.
v0.5.8	新增于: v0.5.8

Decompress a gzip stream.

Class: zlib.Gzip

新增于: v0.5.8
Compress data using gzip.

Class: zlib.Inflate

版本历史

版本	变更
v5.0.0	A truncated input stream will now result in an `error` event.
v0.5.8	新增于: v0.5.8

Decompress a deflate stream.

Class: zlib.InflateRaw

版本历史

版本	变更
v6.8.0	Custom dictionaries are now supported by `InflateRaw`.
v5.0.0	A truncated input stream will now result in an `error` event.
v0.5.8	新增于: v0.5.8

Decompress a raw deflate stream.

Class: zlib.Unzip

新增于: v0.5.8
通过自动检测头信息解压 Gzip 或者 Deflate 压缩的流.

Class: zlib.Zlib

新增于: v0.5.8
没有被 zlib 模块导出. 它被记录于此因为它是 compressor/decompressor 类的基础类.

zlib.bytesRead

新增于: v8.1.0

<number>

The zlib.bytesRead property specifies the number of bytes read by the engine before the bytes are processed (compressed or decompressed, as appropriate for the derived class). zlib.bytesRead 属性指的是压缩引擎处理之前读取的字节数 (压缩或者解压, 适用于派生类).

zlib.flush([kind], callback)

新增于: v0.5.8
kind 默认为 zlib.constants.Z_FULL_FLUSH.

刷新挂起的数据. 不要轻易的调用这个方法, 过早的刷新会对压缩算法造成负面影响.

执行这个操作只会从 zlib 内部状态刷新数据, 不会在流级别上执行任何类型的刷新. 相反, 它的表现类似正常的 .write() 调用. 即它将在队列中其他数据写入操作之后执行，并且只会在从流中读取数据之后才产生输出。

zlib.params(level, strategy, callback)

新增于: v0.11.4
动态更新压缩等级和压缩策略. 只对解压算法有效.

zlib.reset()

新增于: v0.7.0
Reset the compressor/decompressor to factory defaults. Only applicable to the inflate and deflate algorithms.

zlib.constants

新增于: v7.0.0
Provides an object enumerating Zlib-related constants.

zlib.createDeflate(options)

新增于: v0.5.8
Creates and returns a new Deflate object with the given options.

zlib.createDeflateRaw(options)

新增于: v0.5.8
创建并返回一个带有给定 options 的新的 DeflateRaw 对象.

注意: zlib 库拒绝 256-字节的 windows 的请求 (即 {windowBits: 8} in options). 当创建具有这个特定 windowBits 值的 DeflateRaw 对象时, 会抛出一个 Error

zlib.createGunzip(options)

新增于: v0.5.8
Creates and returns a new Gunzip object with the given options.

zlib.createGzip(options)

新增于: v0.5.8
Creates and returns a new Gzip object with the given options.

zlib.createInflate(options)

新增于: v0.5.8
Creates and returns a new Inflate object with the given options.

zlib.createInflateRaw(options)

新增于: v0.5.8
Creates and returns a new InflateRaw object with the given options.

zlib.createUnzip(options)

新增于: v0.5.8
Creates and returns a new Unzip object with the given options.

Convenience Methods

所有这些方法都将 [Buffer][], [TypeArray][], [DataView][], 或者字符串作为第一个参数, 一个回调函数作为可选的第二个参数提供给 zlib 类, 会在 callback(error, result) 中调用.

每一个方法相对应的都有一个接受相同参数, 但是没有回调的 *Sync 版本.

zlib.deflate(buffer[, options], callback)

新增于: v0.6.0

zlib.deflateSync(buffer[, options])

新增于: v0.11.12
Compress a Buffer or string with Deflate.

zlib.deflateRaw(buffer[, options], callback)

新增于: v0.6.0

zlib.deflateRawSync(buffer[, options])

新增于: v0.11.12
Compress a Buffer or string with DeflateRaw.

zlib.gunzip(buffer[, options], callback)

新增于: v0.6.0

zlib.gunzipSync(buffer[, options])

新增于: v0.11.12
Decompress a Buffer or string with Gunzip.

zlib.gzip(buffer[, options], callback)

新增于: v0.6.0

zlib.gzipSync(buffer[, options])

新增于: v0.11.12
Compress a Buffer or string with Gzip.

zlib.inflate(buffer[, options], callback)

新增于: v0.6.0

zlib.inflateSync(buffer[, options])

新增于: v0.11.12
Decompress a Buffer or string with Inflate.

zlib.inflateRaw(buffer[, options], callback)

新增于: v0.6.0

zlib.inflateRawSync(buffer[, options])

新增于: v0.11.12
Decompress a Buffer or string with InflateRaw.

zlib.unzip(buffer[, options], callback)

新增于: v0.6.0

zlib.unzipSync(buffer[, options])

新增于: v0.11.12
Decompress a Buffer or string with Unzip.