在Node.js中使用Zip文件

时间 2020-08-13

原文原文链接

做者：Valeri Karpov
翻译：疯狂的技术宅javascript

原文：http://thecodebarbarian.com/w...html

未经容许严禁转载前端

Zip文件是经常使用的压缩文件格式。在本文中，我将演示如何用 adm-zip npm模块建立和提取zip文件。java

建立一个Zip文件

从 adm-zip 的 npm 模块中导出一个 AdmZip 类。 AdmZip的实例对应于一个zip文件。若是想要建立一个新的 zip 文件，在调用 new AdmZip() 时不该带任何参数：node

const AdmZip = require('adm-zip');

const file = new AdmZip();

能够经过多种方式将文件和目录添加到 file。能够用 file.addLocalFile() 和 file.addLocalFolder() 经过文件名从文件系统添加文件和目录。例以下面的代码演示了怎样把 package.json 文件和 node_modules 目录添加到 zip 文件中：git

const AdmZip = require('adm-zip');

const file = new AdmZip();

file.addLocalFile('./package.json');
//第二个node_modules 参数是 zip 中目录的路径。
//若是没有第二个参数，则`./node_modules`中的每一个目录都将是压缩文件中的顶级目录
file.addLocalFolder('./node_modules', 'node_modules');

而后，你可使用下面两种方法中的一个写入文件：程序员

//写入zip文件的第一种方法：将其转换为缓冲区并使用`fs`
const fs = require('fs');

fs.writeFileSync('output.zip', file.toBuffer());

// 另外一种写入 zip 文件的方法：writeZip()
file.writeZip('output.zip');

写入output.zip 文件后，你应该可以在制定的 zip 解压缩程序中打开它。下面是在 Xubuntu 的默认存档管理器 engrampa 中打开的文件。github

addLocalFile() 和 addLocalFolder() 的第二个参数是将文件或目录内容放入zip的路径。例如，若是要将 package.json 和 node_modules 都放在 project 目录下，则能够运行如下脚本：面试

const AdmZip = require('adm-zip');

const file = new AdmZip();

file.addLocalFile('./package.json', 'project');
file.addLocalFolder('./node_modules', 'project/node_modules');

const fs = require('fs');

fs.writeFileSync('output.zip', file.toBuffer());

能够用 file.addFile() 方法从原始 Node.js 缓冲区添加文件。如下是不在文件系统上建立文件的状况下，将包含字符串 Hello，World 的文本文件添加到 zip 文件中的方法。npm

const AdmZip = require('adm-zip');

const file = new AdmZip();

file.addFile('hello.txt', Buffer.fromString('Hello, World'));

const fs = require('fs');

fs.writeFileSync('output.zip', file.toBuffer());

使用现有文件

若是你将参数传递给 AdmZip 构造函数，则adm-zip将在给定路径下解析文件。下面是将全部内容从 output.zip 文件提取到目录 output 的方法。

const AdmZip = require('adm-zip');

const file = new AdmZip('./output.zip');

file.extractAllTo('./output');

也能够用 file.extractEntryTo() 从 zip 文件中提取单个文件。例如，下面是从 zip 文件中拉出 hello.txt 文件并将其写入当前目录的方法：

const AdmZip = require('adm-zip');

const file = new AdmZip('./output.zip');

file.extractEntryTo('hello.txt', './');

你也能够对现有文件使用 addLocalFile()，addLocalFolder() 和 addFile()。

总结

zip 文件一般用于压缩。某些服务（例如AWS Lambda）要求你使用 zip 文件。幸运的是，adm-zip npm 模块使直接从 Node.js 建立和提取 zip 文件变得容易。

本文首发微信公众号：前端先锋

欢迎扫描二维码关注公众号，天天都给你推送新鲜的前端技术文章

欢迎继续阅读本专栏其它高赞文章：

更多文章...