archiver 是 Node.js 上一個跨平台的打包模組,zip 與 tar 都支援,API 直觀,是這類需求裡相當順手的一個選擇。
先安裝:
npm install archiver
接著寫一段最小可用的程式:
var archiver = require('archiver');
var fs = require('fs');
//被打包文件
var files = [
'files/001.png',
'files/002.png'
];
var zipPath = 'test.zip';
//創建一最終打包文件的輸出流
var output = fs.createWriteStream(zipPath);
//生成archiver對象,打包類型為zip
var zipArchiver = archiver('zip');
//將打包對象與輸出流關聯
zipArchiver.pipe(output);
for(var i=0; i < files.length; i++) {
console.log(files[i]);
//將被打包文件的流添加進archiver對象中
zipArchiver.append(fs.createReadStream(files[i]), {'name': files[i]});
}
//打包
zipArchiver.finalize();
流程拆開看只有四步:建立目標檔案的寫入流、建立指定格式的 archiver 實例、用 pipe 把兩者接起來、逐一 append 要打包的內容,最後呼叫 finalize() 收尾。
值得留意的是 append 收的是 stream,所以大檔案不必整份讀進記憶體;而 {'name': ...} 讓你能控制檔案在壓縮檔內的名稱與路徑,這在需要重新組織目錄結構時很好用。除了 append,archiver 也提供 directory()、file() 等方法,可以直接把整個目錄或單一檔案塞進去。
專案位址:https://github.com/ctalkington/node-archiver