Working with Zip Files in Node.js

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

创建一个Zip文件

从 adm-zip 的 npm 模块中导出一个 AdmZip 类。 AdmZip的实例对应于一个zip文件。如果想要创建一个新的 zip 文件,在调用 new AdmZip() 时不应带任何参数:

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

const file = new AdmZip();

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

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 中打开的文件。

img

addLocalFile()addLocalFolder() 的第二个参数是将文件或目录内容放入zip的路径。例如,如果要将 package.jsonnode_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 文件中的方法。

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 文件变得容易。