iOS 使用 zlib 库实现请求数据压缩

---

1.Content-Encoding

Accept-Encoding 和 Content-Encoding 是 HTTP 中的一对头部字段，用来标识「请求发送方可接受的响应数据编码格式」、「请求/响应方发送的 HTTP Body 编码格式」。接收方拿到请求/响应后，根据 Content-Encoding 对应的数据格式进行解压数据。压缩的目的是为了优化传输内容的大小，减少服务端流量压力。

Content-Encoding 的取值有 gzip、defalte、compress、identity、br 等，具体用到哪个需要跟服务端协商好。Xcode 提供的 zlib 可以实现这里的 gzip、defalte 这两种编码格式。

gzip
一种由文件压缩程序「Gzip，GUN zip」产生的编码格式，描述于 RFC 1952。这种编码格式是一种具有 32 位 CRC 的 Lempel-Ziv 编码（LZ77）；

deflate
由定义于 RFC 1950 的「ZLIB」编码格式与 RFC 1951 中描述的「DEFLATE」压缩机制组合而成的产物；

由于 HTTP 1.1 的命名失误，deflate 当初应该命名为 zlib，因为其本身就是使用 zlib 格式编码，用 deflate 造成了与 DEFLATE 算法的混淆，事实上 Content-Encoding 为 gzip 和 deflate 时都可能使用 DEFLATE 算法。

2. zlib库的使用

下面介绍一下使用 zlib 库对 NSData 进行压缩操作的基本过程以及注意事项：

2.1 引入头文件

#import "zlib.h"

2.2 初始化

在开始使用 zlib.h 提供的方法压缩数据之前，必需做一些初始化工作。一般情况下初始化需要调用 deflateInit() 或者 deflateInit2() 函数，用 deflateInit() 初始化后压缩产生 zlib 编码格式，对应 Content-Encoding 中的 deflate，而 deflateInit2() 通过不同参数配置可以产生对应 Content-Encoding 中的 gzip 和 deflate 的不同压缩格式。

deflateInit2() 函数有很多个参数，第一个是个 C 结构体 z_stream，定义在 zlib.h 中。

z_stream 这个结构体的成员用于控制压缩算法的工作方式，同时也维护了两组输入输出指针 next_in/out，还有关于已处理的字节数和剩余未处理的字节数等信息。

2.2.1 初始化 z_stream

z_stream 的初始化过程如下，其中 zalloc、zfree、opaque 设置为 NULL 这样之后的 deflateInit2() 方法会把这些指针更新为默认的内存管理函数。

z_stream zStream;
bzero(&zStream, sizeof(zStream));

zStream.zalloc = Z_NULL;
zStream.zfree = Z_NULL;
zStream.opaque = Z_NULL;
// 剩余的需要压缩字指针
zStream.next_in = (Bytef *) data.bytes;
// 剩余的需要压缩字节数
zStream.avail_in = (uInt) data.length;
// 目前已经输出的字节数
zStream.total_out = 0;

2.2.2 调用 deflateInit2()

先看一下 deflateInit2() 的定义

z_streamp strm: z_stream 指针；

int level: 压缩等级，必需为 Z_DEFAULT_COMPRESSION 或者 0 ~ 9 的整数，1为最快，9为最大限度压缩，0为不压缩，数字越大越耗时；

int method: 压缩算法，只支持 Z_DEFLATED；

int windowBits: 历史缓冲区最大尺寸，值为 2^windowBits, windowBits 的值为 8~15 时，deflate() 方法生成 zlib 格式的数据，当 windowBits 为 31 时 deflate() 方法生成 gzip 格式。当取值为 -15 ~ -8 时，deflate() 生成纯 deflate 算法压缩数据（不包含 zlib 和 gzip 格式头和尾）

int strategy: 用于调整压缩算法，一般使用 Z_DEFAULT_STRATEGY

ZEXTERN int ZEXPORT deflateInit2 OF((z_streamp strm,
                                     int  level,
                                     int  method,
                                     int  windowBits,
                                     int  memLevel,
                                     int  strategy));

以生成 gzip 格式输出为例：

OSStatus status = deflateInit2(&zStream, Z_DEFAULT_COMPRESSION, Z_DEFLATED, 31, MAX_MEM_LEVEL, Z_DEFAULT_STRATEGY);
    
if (status != Z_OK) {
    return nil;
}

2.3 生成压缩数据

完成初始化之后，循环调用 deflate () 方法不断压缩数据并填充到 NSMutableData 中，直到 deflate () 返回结果不为 Z_BUF_ERROR 或者 Z_OK 为止。

static NSInteger kZlibCompressChunkSize = 2048;
NSMutableData *compressedData = [NSMutableData dataWithLength:kZlibCompressChunkSize];
do {
    if ((status == Z_BUF_ERROR) || (zStream.total_out == compressedData.length)) {
        [compressedData increaseLengthBy:kZlibCompressChunkSize];
    }
    zStream.next_out = (Bytef *)compressedData.bytes + zStream.total_out;
    zStream.avail_out = (uInt)(compressedData.length - zStream.total_out);
    status = deflate(&zStream, Z_FINISH);
} while ((status == Z_BUF_ERROR) || (status == Z_OK));
    
status = deflateEnd(&zStream);
    
if ((status != Z_OK) && (status != Z_STREAM_END)) {
    return nil;
}
    
compressedData.length = zStream.total_out;

3. 完成后的压缩方法

- (NSData *)zlibCompressedData:(NSData *)data
{
    if (data.length == 0) return data;
    
    z_stream zStream;
    bzero(&zStream, sizeof(zStream));
    
    zStream.zalloc = Z_NULL;
    zStream.zfree = Z_NULL;
    zStream.opaque = Z_NULL;
    zStream.next_in = (Bytef *) data.bytes;
    zStream.avail_in = (uInt) data.length;
    zStream.total_out = 0;
    
    OSStatus status = deflateInit2(&zStream,
                                   Z_DEFAULT_COMPRESSION,
                                   Z_DEFLATED, MAX_WBITS,
                                   MAX_MEM_LEVEL,
                                   Z_DEFAULT_STRATEGY);
    
    if (status != Z_OK) {
        return nil;
    }
    
    static NSInteger kZlibCompressChunkSize = 2048;
    NSMutableData *compressedData = [NSMutableData dataWithLength:kZlibCompressChunkSize];
    do {
        if ((status == Z_BUF_ERROR) || (zStream.total_out == compressedData.length)) {
            [compressedData increaseLengthBy:kZlibCompressChunkSize];
        }
        zStream.next_out = (Bytef *)compressedData.bytes + zStream.total_out;
        zStream.avail_out = (uInt)(compressedData.length - zStream.total_out);
        status = deflate(&zStream, Z_FINISH);
    } while ((status == Z_BUF_ERROR) || (status == Z_OK));
    
    status = deflateEnd(&zStream);
    
    if ((status != Z_OK) && (status != Z_STREAM_END)) {
        return nil;
    }
    
    compressedData.length = zStream.total_out;
    
    return compressedData;
}