Zipper：PHP ZipArchive终极封装库，10分钟掌握高效压缩与解压技巧

Zipper：PHP ZipArchive终极封装库，10分钟掌握高效压缩与解压技巧

【免费下载链接】ZipperThis is a simple Wrapper around the ZipArchive methods with some handy functions项目地址: https://gitcode.com/gh_mirrors/zi/Zipper

Zipper是一个基于PHP ZipArchive的终极封装库，它提供了简单易用的API和丰富的功能，帮助开发者快速实现文件的压缩与解压操作。无论是处理单个文件还是整个目录，Zipper都能让你轻松搞定，无需深入了解复杂的ZipArchive底层方法。

为什么选择Zipper？

在PHP开发中，文件压缩与解压是常见的需求。虽然PHP自带了ZipArchive类，但直接使用它需要编写大量冗余代码，而且处理目录、筛选文件等操作不够直观。Zipper的出现解决了这些痛点，它通过简洁的API封装了ZipArchive的核心功能，同时添加了许多实用的便捷方法，让压缩解压工作变得前所未有的简单高效。

主要优势

• 简单易用：Zipper提供了直观的链式调用API，几行代码就能完成复杂的压缩解压任务。
• 功能丰富：支持文件添加、删除、内容获取、按条件提取等多种操作。
• 灵活性高：可以轻松实现文件筛选、目录操作、权限控制等高级功能。
• 安全可靠：内置安全机制，有效防止zip目录遍历攻击等安全问题。

快速安装指南

要开始使用Zipper，只需按照以下简单步骤进行安装：

1. 添加依赖

在你的composer.json文件中添加Zipper依赖：

"require": { "chumper/zipper": "1.0.x" }

2. 安装依赖

运行Composer更新命令安装Zipper：

composer update

3. 配置Laravel（如使用Laravel框架）

如果你在Laravel项目中使用Zipper，需要进行简单的配置：

1. 打开app/config/app.php文件
2. 在providers数组中添加服务提供者：

   Chumper\Zipper\ZipperServiceProvider::class

3. 在aliases数组中添加别名：

   'Zipper' => Chumper\Zipper\Zipper::class

完成以上步骤后，你就可以在项目中通过Zipper别名轻松访问Zipper的所有功能了。

核心功能详解

Zipper提供了一系列强大的方法，让文件压缩与解压变得简单直观。下面我们将介绍一些最常用的核心功能。

创建和打开Zip文件

使用make方法可以创建新的Zip文件或打开已存在的Zip文件：

// 创建新的Zip文件 Zipper::make('path/to/your/file.zip'); // 打开已存在的Zip文件 Zipper::make('path/to/existing/file.zip');

添加文件和目录

add方法允许你向Zip文件中添加单个文件、多个文件或整个目录：

// 添加单个文件 Zipper::make('test.zip')->add('path/to/file.txt')->close(); // 添加多个文件 Zipper::make('test.zip')->add(['file1.txt', 'file2.txt'])->close(); // 添加整个目录 Zipper::make('test.zip')->add('path/to/directory')->close();

向Zip中添加字符串内容

使用addString方法可以直接向Zip文件中添加字符串内容作为文件：

Zipper::make('test.zip') ->addString('hello.txt', 'Hello, Zipper!') ->close();

从Zip中删除文件

remove方法允许你从Zip文件中删除一个或多个文件：

Zipper::make('test.zip') ->remove('file-to-remove.txt') ->close(); // 或删除多个文件 Zipper::make('test.zip') ->remove(['file1.txt', 'file2.txt']) ->close();

提取Zip文件内容

extractTo方法是Zipper的亮点功能之一，它提供了灵活的文件提取选项：

// 提取整个Zip文件内容 Zipper::make('test.zip')->extractTo('path/to/extract'); // 仅提取特定文件（白名单） Zipper::make('test.zip')->extractTo('path', ['file1.txt', 'file2.txt'], Zipper::WHITELIST); // 提取除特定文件外的所有内容（黑名单） Zipper::make('test.zip')->extractTo('path', ['file-to-exclude.txt'], Zipper::BLACKLIST);

按正则表达式提取文件

extractMatchingRegex方法允许你使用正则表达式来筛选需要提取的文件：

// 提取所有.php文件 Zipper::make('test.zip')->extractMatchingRegex('path', '/\.php$/i'); // 提取所有非测试文件 Zipper::make('test.zip')->extractMatchingRegex('path', '/^(?!.*test\.php).*$/i');

实用示例：常见场景解决方案

下面我们通过几个实用示例，展示Zipper在实际开发中的应用。

示例1：快速创建压缩包

// 获取目录下的所有文件 $files = glob('public/files/*'); // 创建压缩包并添加文件 Zipper::make('public/archive.zip')->add($files)->close();

示例2：创建带目录结构的压缩包

Zipper::make('project.zip') ->folder('src')->add('app/Controllers') ->folder('config')->add('config/app.php') ->close();

示例3：从压缩包中提取特定文件

// 仅提取压缩包中的vendor目录和composer.json文件 Zipper::make('package.zip') ->extractTo('public', ['vendor', 'composer.json'], Zipper::WHITELIST);

示例4：读取压缩包中的文件内容

// 获取压缩包中特定文件的内容 $content = Zipper::make('test.zip')->getFileContent('folder/file.txt'); echo $content;

注意事项与最佳实践

在使用Zipper时，请注意以下几点以确保最佳体验：

1. 始终调用close()方法：完成所有操作后，务必调用close()方法来保存并关闭Zip文件。

2. 注意文件路径：Zipper内部使用'/'作为目录分隔符，Windows用户应避免使用''。

3. 安全考虑：虽然Zipper已经包含安全修复，但处理不可信来源的Zip文件时仍需谨慎。

4. 链式调用限制：getFileContent、getStatus、close和extractTo方法不能在链式调用的中间使用，它们应该放在链式调用的末尾。

总结

Zipper作为PHP ZipArchive的终极封装库，为开发者提供了简单、高效的文件压缩解压解决方案。通过其直观的API和丰富的功能，你可以在短短10分钟内掌握各种压缩解压技巧，轻松应对日常开发中的文件处理需求。无论你是PHP新手还是有经验的开发者，Zipper都能帮助你节省时间，提高工作效率。

现在就开始使用Zipper，体验PHP文件压缩解压的新方式吧！

【免费下载链接】ZipperThis is a simple Wrapper around the ZipArchive methods with some handy functions项目地址: https://gitcode.com/gh_mirrors/zi/Zipper