ZipZap核心API详解：ZZArchive与ZZArchiveEntry使用指南

ZipZap核心API详解：ZZArchive与ZZArchiveEntry使用指南

【免费下载链接】ZipZapzip file I/O library for iOS, macOS and tvOS项目地址: https://gitcode.com/gh_mirrors/zi/ZipZap

ZipZap是一款专为iOS、macOS和tvOS平台设计的高效zip文件I/O库，其核心API ZZArchive与ZZArchiveEntry提供了简洁而强大的zip文件操作能力。本文将深入解析这两个核心类的使用方法，帮助开发者快速掌握ZipZap的精髓。

📦 ZZArchive：zip文件的管理中心

ZZArchive类是ZipZap库的核心，负责zip文件的整体管理。它提供了两种主要的初始化方式，分别从文件URL或原始数据创建归档实例。

基本初始化方法

从文件URL创建归档：

NSURL *zipURL = [NSURL fileURLWithPath:@"path/to/archive.zip"]; NSError *error; ZZArchive *archive = [ZZArchive archiveWithURL:zipURL error:&error];

从原始数据创建归档：

NSData *zipData = [NSData dataWithContentsOfFile:@"path/to/archive.zip"]; ZZArchive *archive = [ZZArchive archiveWithData:zipData error:&error];

核心属性与方法

ZZArchive提供了三个关键属性：

• URL：归档文件的URL路径
• contents：归档的原始数据内容
• entries：包含所有归档条目的数组，元素类型为ZZArchiveEntry

更新归档内容的方法：

NSArray<ZZArchiveEntry*> *newEntries = @[newEntry1, newEntry2]; BOOL success = [archive updateEntries:newEntries error:&error];

📄 ZZArchiveEntry：zip文件的条目管理

ZZArchiveEntry类代表zip归档中的单个文件或目录条目，提供了丰富的属性和方法来操作条目内容。

主要属性

每个ZZArchiveEntry实例包含以下重要属性：

• compressed：是否压缩
• encrypted：是否加密
• lastModified：最后修改日期
• crc32：CRC32校验码
• compressedSize/uncompressedSize：压缩/未压缩大小
• fileName：条目文件名

创建条目

创建文件条目有多种方式，最常用的是通过数据流或数据块：

// 从数据流创建 ZZArchiveEntry *streamEntry = [ZZArchiveEntry archiveEntryWithFileName:@"document.txt" compress:YES streamBlock:^BOOL(NSOutputStream *stream, NSError *__autoreleasing *error) { // 写入数据到流 return YES; }]; // 从数据块创建 ZZArchiveEntry *dataEntry = [ZZArchiveEntry archiveEntryWithFileName:@"image.png" compress:YES dataBlock:^NSData * _Nullable(NSError *__autoreleasing *error) { return UIImagePNGRepresentation(image); }];

创建目录条目：

ZZArchiveEntry *dirEntry = [ZZArchiveEntry archiveEntryWithDirectoryName:@"documents/"];

读取条目内容

获取条目的数据流：

NSInputStream *stream = [entry newStreamWithError:&error];

获取条目数据：

NSData *data = [entry newDataWithError:&error];

对于加密条目，可提供密码：

NSData *encryptedData = [entry newDataWithPassword:@"secret" error:&error];

📝 实际应用示例

以下是一个完整的使用示例，展示如何创建zip归档并添加条目：

// 创建新条目 ZZArchiveEntry *textEntry = [ZZArchiveEntry archiveEntryWithFileName:@"notes.txt" compress:YES dataBlock:^NSData * _Nullable(NSError *__autoreleasing *error) { return [@"Hello ZipZap" dataUsingEncoding:NSUTF8StringEncoding]; }]; // 创建归档 NSURL *tempURL = [NSURL fileURLWithPath:NSTemporaryDirectory() stringByAppendingPathComponent:@"example.zip"]; ZZArchive *newArchive = [[ZZArchive alloc] initWithURL:tempURL options:nil error:&error]; // 添加条目并更新 BOOL success = [newArchive updateEntries:@[textEntry] error:&error]; if (success) { NSLog(@"Zip archive created successfully at %@", tempURL.path); }

📚 高级功能

条目校验

检查条目是否完整一致：

BOOL isConsistent = [entry check:&error];

自定义编码文件名

获取指定编码的文件名：

NSString *japaneseName = [entry fileNameWithEncoding:NSShiftJISStringEncoding];

📷 ZipZap应用场景

ZipZap适用于多种文件处理场景，例如图片压缩存储：

通过ZipZap，开发者可以轻松实现图片等资源的压缩存储和高效读取，优化应用的资源管理。

🔧 安装与使用

要在项目中使用ZipZap，可通过以下方式获取源码：

git clone https://gitcode.com/gh_mirrors/zi/ZipZap

核心头文件包含在项目中：

• ZZArchive.h
• ZZArchiveEntry.h

🎯 总结

ZipZap的ZZArchive和ZZArchiveEntry提供了直观而强大的API，使iOS、macOS和tvOS平台上的zip文件操作变得简单高效。无论是创建、读取还是更新zip归档，这两个核心类都能满足开发者的大部分需求，是处理zip文件的理想选择。

【免费下载链接】ZipZapzip file I/O library for iOS, macOS and tvOS项目地址: https://gitcode.com/gh_mirrors/zi/ZipZap