Node.js 下打包模块 archiver 详解

简介

archiver 是一个基于 Node.js 的打包压缩模块，可以用于创建 zip、tar 等格式的文件。它内部是使用 Node.js 的 stream 实现的，可以流式地处理大规模的文件。

安装

可以使用 npm 在项目中安装 archiver 模块：

npm install archiver

使用

压缩文件夹

以下是一个压缩文件夹的简单例子：

const fs = require('fs');
const archiver = require('archiver');

// 创建压缩包文件流
const output = fs.createWriteStream(__dirname + '/example.zip');
const archive = archiver('zip', {
  zlib: { level: 9 } // 设置压缩级别
});

// 监听到错误事件时，输出错误信息
output.on('error', function(err) {
  console.log(err);
});

// 监听打包结束事件，输出打包文件大小
output.on('close', function() {
  console.log(archive.pointer() + ' total bytes');
  console.log(
    'Archiver has been finalized and the output file descriptor has closed.'
  );
});

// 开始打包压缩
archive.pipe(output);
archive.directory(__dirname + '/myDir/', false);
archive.finalize();

压缩多个文件

以下是一个压缩多个文件的简单例子：

const fs = require('fs');
const archiver = require('archiver');

// 创建压缩包文件流
const output = fs.createWriteStream(__dirname + '/example.zip');
const archive = archiver('zip', {
  zlib: { level: 9 } // 设置压缩级别
});

// 监听到错误事件时，输出错误信息
output.on('error', function(err) {
  console.log(err);
});

// 监听打包结束事件，输出打包文件大小
output.on('close', function() {
  console.log(archive.pointer() + ' total bytes');
  console.log(
    'Archiver has been finalized and the output file descriptor has closed.'
  );
});

// 开始打包压缩
archive.pipe(output);
archive.file(__dirname + '/file1.txt', { name: 'file1.txt' });
archive.file(__dirname + '/file2.txt', { name: 'file2.txt' });
archive.directory(__dirname + '/myDir/', false);
archive.finalize();

在以上例子中，我们使用 archive.file 方法添加了两个文件和 archive.directory 方法添加了一个文件夹到压缩包中。

结束语

以上是 archiver 模块的一些简单使用方法，如果需要更加详细的使用方法，可以阅读其文档或者查看其 GitHub 仓库中的示例代码。