Objective-Zip 技术文档

1. 安装指南

Objective-Zip 可以通过 CocoaPods 进行安装。在您的 Podfile 文件中添加以下依赖项：

pod 'objective-zip', '~> 1.0'

然后执行 pod install 命令以安装库。

2. 项目的使用说明

Objective-Zip 是一个轻量级的 Objective-C 库，它以面向对象的方式封装了 ZLib 和 MiniZip 的功能，以便于读写 zip 文件。

添加 Objective-Zip 到项目中

通过 CocoaPods 安装后，可以使用以下导入语句来访问 Objective-Zip 类：

• 如果您打算使用异常处理，请使用以下导入语句：

  #import "Objective-Zip.h"
  

• 如果您打算使用 Apple 的 NSError 模式，请使用以下导入语句：

  #import "Objective-Zip+NSError.h"
  

主要概念

Objective-Zip 以一个名为 OZZipFile 的类为中心，该类可以用来创建、追加或解压 zip 文件。

• 创建模式：允许创建新的 zip 文件。
• 追加模式：允许向现有的 zip 文件中添加文件。
• 解压模式：允许从 zip 文件中读取文件。

3. 项目 API 使用文档

以下是 Objective-Zip 的一些主要 API 方法：

创建和操作 zip 文件

OZZipFile *zipFile = [[OZZipFile alloc] initWithFileName:@"test.zip" mode:OZZipFileModeCreate];

向 zip 文件添加文件

OZZipWriteStream *stream = [zipFile writeFileInZipWithName:@"abc.txt" compressionLevel:OZZipCompressionLevelBest];
[stream writeData:abcData];
[stream finishedWriting];

使用密码向 zip 文件添加加密文件

NSData *fileData = // 文件数据
uint32_t crc = [fileData crc32];

OZZipWriteStream *stream = [zipFile writeFileInZipWithName:@"abc.txt" compressionLevel:OZZipCompressionLevelBest password:@"password" crc32:crc];
[stream writeData:fileData];
[stream finishedWriting];

从 zip 文件读取文件

OZZipFile *unzipFile = [[OZZipFile alloc] initWithFileName:@"test.zip" mode:OZZipFileModeUnzip];
[unzipFile goToFirstFileInZip];

OZZipReadStream *read = [unzipFile readCurrentFileInZip];
NSMutableData *data = [[NSMutableData alloc] initWithLength:BUFFER_SIZE];

do {
    [data setLength:BUFFER_SIZE];
    int bytesRead = [read readDataWithBuffer:data];
    if (bytesRead <= 0) {
        break;
    }
    [data setLength:bytesRead];
    // 处理数据
} while (YES);

[read finishedReading];

列出 zip 文件中的文件

OZZipFile *unzipFile = [[OZZipFile alloc] initWithFileName:@"test.zip" mode:OZZipFileModeUnzip];

NSArray *infos = [unzipFile listFileInZipInfos];
for (OZFileInZipInfo *info in infos) {
    // 输出文件信息
    // 定位并解压文件
}

关闭 zip 文件

[zipFile close];

4. 项目安装方式

如前所述，Objective-Zip 可以通过 CocoaPods 进行安装。在 Podfile 中添加依赖项，然后执行 pod install。这将自动下载并安装 Objective-Zip 以及其依赖项。

确保在 Xcode 项目中导入正确的头文件，并根据需要选择异常处理或 NSError 模式。