minizip-ng 技术文档

本文档将详细介绍如何安装、使用以及API调用minizip-ng，这是一个用C语言编写的zip文件操作库，支持Windows、macOS和Linux平台。

1. 安装指南

安装依赖

首先，确保安装了CMake（推荐版本3.11或更高）。可以从CMake官方网站下载并安装。

构建项目

在minizip目录中运行以下命令来生成项目文件：

cmake -S . -B build -D MZ_BUILD_TESTS=ON
cmake --build build

2. 项目的使用说明

minizip-ng提供了创建和提取zip归档文件、添加和删除归档条目等功能。以下是基本的命令行工具使用方法：

• 创建zip归档文件：

./minizip -o output.zip input_directory/

• 提取zip归档文件：

./minizip -e output.zip -d extract_directory

更多详细的使用说明请参考项目的README文件。

3. 项目API使用文档

minizip-ng的API提供了丰富的功能，包括但不限于：

• 创建和提取zip归档文件
• 添加和删除归档条目
• 读取和写入原始zip条目数据
• 支持多种压缩方法，如Zlib、BZIP2、LZMA、XZ和ZSTD

以下是API调用的基本示例：

创建zip归档

MZ ZipWriter *zip = mz_zip_writer_open("output.zip", 0);
if (!zip) {
    // 错误处理
}

// 添加文件到zip归档
mz_zip_writer_add_file(zip, "example.txt", "example.txt", MZ_COMPRESSION_DEFAULT);
mz_zip_writer_close(zip);

提取zip归档

MZ ZipReader *zip = mz_zip_reader_open("output.zip");
if (!zip) {
    // 错误处理
}

// 遍历并提取文件
while (mz_zip_reader_get_current_file(zip)) {
    mz_zip_reader_extract_current_file(zip, "extract_directory");
    mz_zip_reader_move_to_next_file(zip);
}

mz_zip_reader_close(zip);

更多API细节和示例请参考项目的官方文档。

4. 项目安装方式

项目可以使用CMake进行构建，支持多种编译选项，以满足不同的编译需求。以下是一些常用的构建选项：

• MZ_COMPAT：启用兼容性层
• MZ_ZLIB：启用ZLIB压缩
• MZ_BZIP2：启用BZIP2压缩
• MZ_LZMA：启用LZMA和XZ压缩
• MZ_ZSTD：启用ZSTD压缩

构建项目时，可以通过以下命令设置这些选项：

cmake -S . -B build -D MZ_ZLIB=ON -D MZ_BZIP2=ON

然后构建项目：

cmake --build build

以上是minizip-ng项目的技术文档，希望对您的使用有所帮助。