專案裡需要對一個已存在的資料夾做打包與解包。找方案的時候試了幾個目前比較流行的套件:adm-zip、JSZip、archiver。以下是我實際使用後的比較。
同時支援壓縮與解壓,只要給路徑就能處理已存在的檔案或資料夾,介面相當直覺。
var adm_zip = require('adm-zip'); //creating archives var zip = new adm_zip(); zip.addLocalFolder('archiver'); zip.writeZip('adm/adm-archive.zip'); //extracting archives var unzip = new adm_zip('adm/adm-archive.zip'); unzip.extractAllTo("adm/adm-unarchive/", /*overwrite*/true);
優缺點:
1. 壓縮解壓一手包,給路徑就能對整個資料夾操作,API 設計簡單好用。
2. 本身存在一些 bug,偶爾會發生解壓後的檔案與原始檔不一致的情況,只能期望後續版本修正。
這個套件需要把檔案一個個加進 zip 物件,內容也要自己讀出來傳入,最後再把記憶體中的 zip 物件寫成實體檔案。面對整個資料夾時,就必須自己遞迴遍歷。
var JSZip = require("jszip"); var fs = require("fs"); var zip = new JSZip(); var file_content = fs.readFileSync('archive/a.txt'); zip.file("a.txt",file_content); var data = fs.readFileSync("archive/img/pic.jpeg"); zip.file("img/pic.jpeg", data, {base64: true}); var zipfolder = zip.generate({type:"nodebuffer"}); fs.writeFile("jszip.zip", zipfolder, function(err) { if (err) throw err; });
裡面也有 folder() 方法,但它只是切換 zip 物件內部的虛擬路徑,例如 zip.folder("img").file('a.txt') 等同於 zip.file("img/a.txt"),並不會幫你去讀實體檔案。只呼叫 zip.file("a.txt") 而不給內容,只會得到一個空檔案;而且它只存在記憶體中,必須寫檔之後才真的落地。
優缺點:
1. 很適合把「即時收到的資料」直接打包成 zip。
2. 對已存在的資料夾操作不便,得逐一讀取內容。
3. 編碼細節需要多留意,處理中文檔名時尤其如此。
4. 只有壓縮,沒有解壓。
這是我最後採用的一組。archiver 功能相當完整,支援 zip 與 tar 格式,給路徑就能壓縮整包資料夾。
壓縮:
var fs = require('fs'); var archiver = require('archiver'); var output = fs.createWriteStream('archiver-unzip.zip'); var archive = archiver('zip'); archive.on('error', function(err){ throw err; }); archive.pipe(output); archive.bulk([ { src: ['archiver/**']} ]); archive.finalize();
解壓:
var fs = require("fs"); var unzip = require("unzip"); fs.createReadStream('archiver-unzip.zip').pipe(unzip.Extract({ path: 'unarchive' }));
優缺點:
1. 經過長期實戰檢驗,bug 相對少。
2. 使用方便,不需要自己遍歷資料夾。
3. 兩者分工明確:一個只壓、一個只解,沒有單一包同時做好兩件事。(這也是 adm-zip 誘人之處,但 bug 是硬傷。)
補充兩點實務經驗:archive.finalize() 一定要呼叫,否則輸出流不會結束;另外 archive.on('error') 與串流的 error 事件都要掛上,不然任何 I/O 異常都可能讓整個行程直接結束。
這些是我目前整理出來的選擇,若有更好用的推薦也歡迎提出。