Rust ZIP压缩扩展库zip-extensions使用指南

概述

zip-extensions是一个Rust库，为标准的zip库提供了额外的功能和增强支持，简化了ZIP文件操作。它为常见的ZIP操作提供了更简洁的API，并添加了一些实用功能。

安装

在Cargo.toml中添加依赖：

[dependencies]
zip-extensions = "0.1"

主要功能

1. 简化ZIP文件创建和提取
2. 支持递归目录压缩
3. 提供更友好的错误处理
4. 添加进度回调支持
5. 增强的文件属性设置

基本使用方法

创建ZIP文件

use zip_extensions::zip_create_from_directory;

fn main() -> std::io::Result<()> {
    zip_create_from_directory(
        "archive.zip",  // 输出ZIP文件路径
        "src",          // 要压缩的目录
        zip::CompressionMethod::Deflated,  // 压缩方法
    )?;
    Ok(())
}

解压ZIP文件

use zip_extensions::zip_extract;

fn main() -> std::io::Result<()> {
    zip_extract(
        "archive.zip",  // ZIP文件路径
        "output_dir",   // 解压目标目录
    )?;
    Ok(())
}

高级功能

带进度回调的压缩

use zip_extensions::{zip_create_from_directory_with_progress, ProgressCallback};

fn progress_callback(path: &str, current: u64, total: u64) {
    println!("压缩中: {} - {}/{}", path, current, total);
}

fn main() -> std::io::Result<()> {
    zip_create_from_directory_with_progress(
        "archive.zip",
        "src",
        zip::CompressionMethod::Deflated,
        progress_callback,
    )?;
    Ok(())
}

选择性压缩文件

use zip_extensions::zip_create_from_directory_with_filter;

fn main() -> std::io::Result<()> {
    zip_create_from_directory_with_filter(
        "archive.zip",
        "src",
        zip::CompressionMethod::Deflated,
        |path| {
            // 只压缩.rs文件
            path.ends_with(".rs")
        },
    )?;
    Ok(())
}

设置文件权限(Unix系统)

use std::os::unix::fs::PermissionsExt;
use zip_extensions::zip_create_from_directory_with_permissions;

fn main() -> std::io::Result<()> {
    zip_create_from_directory_with_permissions(
        "archive.zip",
        "src",
        zip::CompressionMethod::Deflated,
        |path| {
            // 设置可执行权限
            if path.ends_with(".sh") {
                Some(0o755)  // rwxr-xr-x
            } else {
                Some(0o644)  // rw-r--r--
            }
        },
    )?;
    Ok(())
}

错误处理

zip-extensions提供了更友好的错误类型ZipExtensionsError:

use zip_extensions::{ZipExtensionsError, zip_extract};

fn main() -> Result<(), ZipExtensionsError> {
    match zip_extract("archive.zip", "output_dir") {
        Ok(_) => println!("解压成功"),
        Err(ZipExtensionsError::FileNotFound(path)) => {
            eprintln!("文件未找到: {}", path)
        },
        Err(e) => eprintln!("解压失败: {}", e),
    }
    Ok(())
}

完整示例

下面是一个完整的示例，展示了如何使用zip-extensions进行文件压缩和解压：

use std::path::Path;
use zip_extensions::{
    zip_create_from_directory_with_progress, 
    zip_extract,
    ProgressCallback,
    ZipExtensionsError
};

// 进度回调函数
fn progress_callback(path: &str, current: u64, total: u64) {
    println!("处理中: {} - 已处理: {} / 总计: {}", path, current, total);
}

fn main() -> Result<(), ZipExtensionsError> {
    // 1. 创建ZIP文件
    let source_dir = "test_data";
    let zip_file = "archive.zip";
    
    // 创建测试目录和文件
    if !Path::new(source_dir).exists() {
        std::fs::create_dir(source_dir)?;
        std::fs::write(format!("{}/file1.txt", source_dir), "测试文件1")?;
        std::fs::write(format!("{}/file2.rs", source_dir), "测试Rust文件")?;
    }

    println!("正在创建ZIP文件...");
    zip_create_from_directory_with_progress(
        zip_file,
        source_dir,
        zip::CompressionMethod::Deflated,
        progress_callback,
    )?;
    println!("ZIP文件创建成功: {}", zip_file);

    // 2. 解压ZIP文件
    let extract_dir = "extracted_data";
    println!("\n正在解压ZIP文件到 {}...", extract_dir);
    zip_extract(zip_file, extract_dir)?;
    println!("解压完成");

    // 验证解压的文件
    let extracted_file1 = format!("{}/file1.txt", extract_dir);
    let extracted_file2 = format!("{}/file2.rs", extract_dir);
    
    if Path::new(&extracted_file1).exists() && Path::new(&extracted_file2).exists() {
        println!("验证成功: 所有文件已正确解压");
    } else {
        eprintln!("验证失败: 部分文件未正确解压");
    }

    Ok(())
}

注意事项

1. 对于大文件操作，考虑使用带进度回调的版本
2. 在Windows和Unix系统上，文件权限的处理方式不同
3. 默认情况下，符号链接不会被跟随
4. 压缩大量小文件时，内存使用可能会增加

zip-extensions库通过简化常见操作和添加实用功能，使得在Rust中处理ZIP文件变得更加方便。