压缩

1. 简介

本节为非规范性内容。

本规范中定义的 API 用于对数据流进行压缩和解压。它们支持 "deflate"、"deflate-raw" 和 "gzip" 作为压缩算法，这些算法被网页开发者广泛使用。

2. 基础设施

本规范依赖于 Infra。[INFRA]

一个 chunk 是一段数据。对于 CompressionStream 和 DecompressionStream，输出 chunk 类型为 Uint8Array。它们接受任何 BufferSource 类型作为输入。

一个 stream 表示有序的 chunk 序列。ReadableStream 和 WritableStream 的术语定义在 Streams。[STREAMS]

压缩上下文 是压缩或解压算法维护的内部状态。压缩上下文 的内容取决于所用的格式、算法和实现。从本规范的角度来说，它是一个不透明对象。压缩上下文 初始处于起始状态，等待输入的第一个字节。

3. 支持的格式

deflate

“ZLIB 压缩数据格式”[RFC1950]

注：为了与 HTTP 内容编码保持一致，该格式称为 “deflate”。参见 [RFC7230] 第4.2.2节。

• 实现必须遵循 [RFC1950] 第2.3节所述的“兼容性”。

• CompressionStream 不得创建 [RFC1950] 中描述为无效的字段值，DecompressionStream 处理此类值时应报错。

• CMF 字段中的 CM（压缩方法）部分的唯一有效值为 8。

• 这些 API 不支持 FDICT 标志，若设置则流会报错。

• DecompressionStream 会忽略 FLEVEL 标志。

• 若 ADLER32 校验和不正确，DecompressionStream 会报错。

• 若 ADLER32 校验和之后还有额外输入数据，也会报错。

deflate-raw

“DEFLATE 算法”[RFC1951]

• 实现必须遵循 [RFC1951] 第1.4节所述的“兼容性”。

• CompressionStream 不得创建非 [RFC1951] 兼容的块，DecompressionStream 处理此类块时应报错。

• 若在 BFINAL 标志指示的最终块之后还有额外输入数据，则会报错。

gzip

“GZIP 文件格式”[RFC1952]

• 实现必须遵循 [RFC1952] 第2.3.1.2节所述的“兼容性”。

• CompressionStream 不得创建 [RFC1952] 中描述为无效的字段值，DecompressionStream 处理此类值时应报错。

• CM（压缩方法）字段的唯一有效值为 8。

• DecompressionStream 必须忽略 FTEXT 标志。

• 若 FHCRC 字段存在且不正确，则会报错。

• DecompressionStream 必须忽略 FEXTRA、FNAME 和 FCOMMENT 字段的内容，仅需验证其正确结束。

• DecompressionStream 必须忽略 MTIME、XFL 和 OS 字段的内容。

• 若 CRC32 或 ISIZE 与解压后的数据不匹配，则会报错。

• gzip 流只能包含一个“成员”。

• 若“成员”结束后还有额外输入数据，则会报错。

4. 接口 CompressionStream

enum CompressionFormat {
  "deflate",
  "deflate-raw",
  "gzip",
};

[Exposed=*]
interface CompressionStream {
  constructor(CompressionFormat format);
};
CompressionStream includes GenericTransformStream;

CompressionStream 拥有一个 格式 和一个 压缩上下文 上下文。

5. 接口 DecompressionStream

[Exposed=*]
interface DecompressionStream {
  constructor(CompressionFormat format);
};
DecompressionStream includes GenericTransformStream;

DecompressionStream 拥有一个 格式 和一个 压缩上下文 上下文。

6. 隐私与安全注意事项

该 API 不会为 Web 平台带来任何新的权限。

但是，网页开发者需要注意攻击者可能获得数据长度的情况。如果发生这种情况，攻击者可能能够猜测数据内容。

7. 示例

7.1. Gzip 压缩流

const compressedReadableStream
    = inputReadableStream.pipeThrough(new CompressionStream('gzip'));

7.2. Deflate 压缩 ArrayBuffer 到 Uint8Array

async function compressArrayBuffer(input) {
  const cs = new CompressionStream('deflate');

  const writer = cs.writable.getWriter();
  writer.write(input);
  writer.close();

  const output = [];
  let totalSize = 0;
  for (const chunk of cs.readable) {
    output.push(value);
    totalSize += value.byteLength;
  }

  const concatenated = new Uint8Array(totalSize);
  let offset = 0;
  for (const array of output) {
    concatenated.set(array, offset);
    offset += array.byteLength;
  }

  return concatenated;
}

7.3. Gzip 解压 Blob 到 Blob

function decompressBlob(blob) {
  const ds = new DecompressionStream('gzip');
  const decompressionStream = blob.stream().pipeThrough(ds);
  return new Response(decompressionStream).blob();
}

致谢

本标准由 Adam Rice (Google, ricea@chromium.org) 编写。

知识产权

版权所有 © WHATWG（Apple、Google、Mozilla、Microsoft）。本作品采用 知识共享署名 4.0 国际许可证 许可。在其部分内容被纳入源代码时，该部分在源代码中则采用 BSD 3-Clause 许可证 许可。

这是现行标准。希望查阅专利审查版本的请查看 现行标准审查草案。