在nodejs中,archiver用于将一些文件压缩打包成zip格式或tar格式的压缩包;archiver是一个能跨平台实现打包功能的模块,打包的格式是zip和tar,可以利用“npm install archiver”语句在使用前安装该模块。
本文操作环境:Windows10系统、nodejs 12.19.0版、Dell G3电脑。
有时候我们需要将一些文件压缩打包成zip格式或tar格式的压缩包,也有可能需要将目录进行打包。在Node.js中就可以用到archiver这个第三方包来进行操作。
archiver是一个在nodejs中能跨平台实现打包功能的模块,可以打zip和tar包,是一个比较好用的三方模块。
使用前先安装archiver模块。
代码如下:
npm install archiver
引入:
// 由于需要读取文件所以需要fs模块,也必须导入 const fs = require('fs'); const archiver = require('archiver');
基本使用如下:
// 第一步,导入必要的模块 const fs = require('fs'); const archiver = require('archiver'); // 第二步,创建可写流来写入数据 const output = fs.createWriteStream(__dirname + "/hello.zip");// 将压缩包保存到当前项目的目录下,并且压缩包名为test.zip const archive = archiver('zip', {zlib: {level: 9}});// 设置压缩等级 // 第三步,建立管道连接 archive.pipe(output); // 第四步,压缩指定文件 var stream = fs.createReadStream(__dirname + "/hello.txt");// 读取当前目录下的hello.txt archive.append(stream, {name: 'hello.txt'}); // 第五步,完成压缩 archive.finalize();
执行代码成功后,就会在项目的所在目录下生成一个名为hello.zip压缩包,该压缩包内就是压缩的文件hello.txt。
压缩文件可以使用archive.append()
和archive.file()
来进行操作。
压缩单个文件的API如下:
// 添加一个文件到压缩包,通过可写流的方式读取数据附加文件 const file1 = __dirname + '/file1.txt'; archive.append(fs.createReadStream(file1), { name: 'file1.txt' }); //添加一个文件到压缩包,通过将字符串写入到文件的方式附加文件 archive.append('string cheese!', { name: 'file2.txt' }); // 添加一个文件到压缩包,通过Buffer数据的方式附加文件 const buffer3 = Buffer.from('buff it!'); archive.append(buffer3, { name: 'file3.txt' }); // 添加一个文件到压缩包,直接传入文件路径 archive.file('file1.txt', { name: 'file4.txt' });
完整的例子如下:
// 第一步,导入必要的模块 const fs = require('fs'); const archiver = require('archiver'); // 第二步,创建可写流来写入数据 const output = fs.createWriteStream(__dirname + "/hello.zip");// 将压缩包保存到当前项目的目录下,并且压缩包名为test.zip const archive = archiver('zip', {zlib: {level: 9}});// 设置压缩等级 // 第三步,建立管道连接 archive.pipe(output); // 第四步,压缩指定文件 archive.append(fs.createReadStream(__dirname + '/hello.txt'), {name: 'hello.txt'});// 文件流 archive.append('index.html', {name: 'index.html'});// 文件路径 archive.append(Buffer.from("这是Buffer格式的数据"), {name: 'buffer.txt'});// Buffer对象 archive.append("直接传入字符串", {name: 'string.txt'});// 字符串 // 第五步,完成压缩 archive.finalize();
注意:archive.append()
第二个参数{name: 'hello.txt'}
是对压缩包中对应的文件进行重命名。
如果要压缩多个文件,直接调用archive.append()
方法附加文件即可,这些附加的文件都会被添加到压缩包中。如例:
// 第一步,导入必要的模块 const fs = require('fs'); const archiver = require('archiver'); // 第二步,创建可写流来写入数据 const output = fs.createWriteStream(__dirname + "/hello.zip");// 将压缩包保存到当前项目的目录下,并且压缩包名为test.zip const archive = archiver('zip', {zlib: {level: 9}});// 设置压缩等级 // 第三步,建立管道连接 archive.pipe(output); // 第四步,压缩多个文件到压缩包中 archive.append('index.html', {name: 'index.html'}); archive.append('hello.js', {name: 'hello.js'}); archive.append('hello.html', {name: 'hello.html'}); archive.append('db.json', {name: 'db.json'}); // 第五步,完成压缩 archive.finalize();
如果要压缩目录,则需要使用archive.directory()
来完成。API如下:
// 将指定目录打包压缩到压缩包中,并且重命名为new-subdir,并且subdir目录下的所有文件仍然在new-subdir目录下,而不是在压缩包的根目录下 archive.directory('subdir/', 'new-subdir'); // 将指定目录下的所有文件打包压缩到压缩包中,而这些文件在压缩包的根目录,而非子目录中 archive.directory('subdir/', false);
完整实例如下:
// 第一步,导入必要的模块 const fs = require('fs'); const archiver = require('archiver'); // 第二步,创建可写流来写入数据 const output = fs.createWriteStream(__dirname + "/hello.zip");// 将压缩包保存到当前项目的目录下,并且压缩包名为test.zip const archive = archiver('zip', {zlib: {level: 9}});// 设置压缩等级 // 第三步,建立管道连接 archive.pipe(output); // 第四步,压缩目录到压缩包中 archive.directory('public/', 'new-public'); archive.directory('demo/', false); // 第五步,完成压缩 archive.finalize();
推荐学习:《nodejs视频教程》
以上就是nodejs中archiver怎么用的详细内容,更多请关注php中文网其它相关文章!
已抢186986个
抢已抢67465个
抢已抢353658个
抢已抢668187个
抢已抢123581个
抢已抢25497个
抢