zip.js 教程：创建与管理 ZIP 文件的 JavaScript 库

zip.js 教程：创建与管理 ZIP 文件的 JavaScript 库

zip.jsJavaScript library to zip and unzip files supporting multi-core compression, compression streams, zip64, split files and encryption.项目地址:https://gitcode.com/gh_mirrors/zi/zip.js

1. 项目介绍

zip.js 是一个功能丰富的 JavaScript 库，用于创建、读取和编辑 ZIP 文件。它支持多种特性，如 Zip64 格式、WinZIP AES 和 PKWare ZipCrypto 加密、并行读写操作以及内置的 Web Worker 管理器。这个库依赖于 Promise、TypedArray、Streams API，同时也可选地使用 Web Workers 和其他压缩相关 API。

• 主要特点

  • 支持 Zip64 扩展格式
  • 提供 WinZIP AES 和 PKWare ZipCrypto 加密
  • 可同时处理多个 ZIP 文件的读写
  • 内置工作线程池管理器
  • 不依赖第三方库

• 兼容性

  • 兼容最新版本的 Chrome、Firefox、Safari、Microsoft Edge 和 Deno

2. 项目快速启动

安装

你可以通过以下方式安装 zip.js：

npm

npm install @zip-js/zip-js

手动下载

从 GitHub 下载 dist/jszip.min.js 或 dist/jszip-full.min.js（不使用 Web Workers 的情况）到你的项目中，并在 HTML 中引入。

使用示例

创建一个新的 ZIP 文件并保存：

import { JSZip } from '@zip-js/zip-js';

// 创建一个 JSZip 对象
const zip = new JSZip();

// 添加文件
zip.file('Hello.txt', 'Hello World\n');

// 添加图片（假定你有一个 base64 编码的图像数据）
const imageData = ...;
zip.folder('images').file('smile.gif', imageData, { base64: true });

// 生成 ZIP 文件
zip.generateAsync({ type: 'blob' })
  .then(function (content) {
    // 使用 FileSaver.js 将 ZIP 文件保存
    saveAs(content, 'example.zip');
  });

确保你的代码以 UTF-8 编码解析，否则文件名可能会被破坏。

3. 应用案例与最佳实践

• 制作文件下载服务，将一组文件打包成 ZIP 并提供下载。
• 在浏览器中处理 ZIP 压缩包，例如在预览或编辑文本文件之前。
• 搭配 React 或 Vue 等前端框架，构建 ZIP 文件管理界面。

最佳实践包括：

• 使用 Web Workers 进行大文件处理，以避免阻塞主线程。
• 错误处理：捕捉可能出现的异常，如文件读取失败或加密解密错误。
• 性能优化：按需加载文件，避免一次性加载整个 ZIP。

4. 典型生态项目

• FileSaver.js：用于保存文件到本地的库，配合 zip.js 使用。
• Deno：现代 JavaScript/TypeScript 运行时，可以无缝集成 zip.js。
• Service Worker：结合使用，可以在离线状态下处理 ZIP 文件。
• Bun.js：另一个JavaScript文件系统库，可以与 zip.js 配合进行更复杂的数据管理和操作。

---

要获取更多详细信息，包括完整的 API 文档和示例，参见 官方 GitHub 页面。如有疑问，可以在仓库的 Issue 页面提交问题，或查看已有的常见问答（FAQ）。

zip.jsJavaScript library to zip and unzip files supporting multi-core compression, compression streams, zip64, split files and encryption.项目地址:https://gitcode.com/gh_mirrors/zi/zip.js