【超解説】Node.jsでZIP圧縮！archiver、zlib、JSZip、Streams徹底比較。最適な方法はコレだ！

2024-05-21

Node.jsを使ってディレクトリ全体をZIP圧縮する方法

archiverモジュールを使う

archiverは、Node.js用の圧縮ライブラリです。ディレクトリやファイルの圧縮、解凍など様々な機能を提供します。

手順:

archiverモジュールをインストールします。

npm install archiver

以下のコードのように、圧縮したいディレクトリと出力ファイルパスを指定してarchiverモジュールを使います。

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

const output = fs.createWriteStream('compressed.zip');
const archive = archiver('zip');

archive.pipe(output);

archive.directory('dirToCompress', 'compressed');

archive.finalize();

zlibモジュールとfsモジュールを使う

zlibモジュールは、Node.js標準ライブラリに含まれる圧縮ライブラリです。fsモジュールは、ファイルシステムへのアクセスを提供します。

以下のコードのように、zlibモジュールとfsモジュールをインポートします。

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

圧縮したいディレクトリ内のファイルを個別に読み込み、圧縮して出力ファイルに書き込みます。

const dir = 'dirToCompress';
const output = fs.createWriteStream('compressed.zip');

fs.readdirSync(dir).forEach(file => {
  const filePath = `${dir}/${file}`;
  const fileStream = fs.createReadStream(filePath);
  const gzip = zlib.createGzip();

  fileStream.pipe(gzip).pipe(output);

  fileStream.on('end', () => {
    console.log(`${file} compressed`);
  });
});

補足:

上記はあくまで基本的な例です。オプションやエラー処理などを追加する必要があります。
archiverモジュールの方が、zlibモジュールとfsモジュールを使うよりもコードが簡潔で読みやすいです。
圧縮対象のディレクトリが大きい場合は、分割圧縮が必要になる場合があります。

Node.jsでZIP圧縮を行うライブラリは、archiver以外にもいくつかあります。
圧縮オプションや圧縮レベルなどを調整することもできます。
詳細については、各ライブラリのドキュメントを参照してください。

Node.jsでディレクトリ全体をZIP圧縮するサンプルコード

archiverモジュールを使う

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

const output = fs.createWriteStream('compressed.zip');
const archive = archiver('zip');

archive.pipe(output);

archive.directory('dirToCompress', 'compressed');

archive.finalize();

説明:

出力ファイル用のストリームを作成します。
archiver インスタンスを作成し、圧縮形式をZIPに設定します。
出力ストリームを archiver インスタンスにパイプします。
archive.directory() メソッドを使用して、圧縮したいディレクトリと出力ファイル名を指定します。
archive.finalize() メソッドを呼び出して、圧縮処理を完了します。

zlibモジュールとfsモジュールを使う

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

const dir = 'dirToCompress';
const output = fs.createWriteStream('compressed.zip');

fs.readdirSync(dir).forEach(file => {
  const filePath = `${dir}/${file}`;
  const fileStream = fs.createReadStream(filePath);
  const gzip = zlib.createGzip();

  fileStream.pipe(gzip).pipe(output);

  fileStream.on('end', () => {
    console.log(`${file} compressed`);
  });
});

圧縮したいディレクトリと出力ファイル名を指定します。
fs.readdirSync() メソッドを使用して、ディレクトリ内のファイルをすべて取得します。
ループで各ファイルに対して、以下の処理を行います。
- zlib.createGzip() メソッドを使用して、Gzip圧縮ストリームを作成します。
- ファイルストリームを圧縮ストリームにパイプし、圧縮ストリームを出力ファイルにパイプします。
- ファイルの読み取りが完了したら、コンソールにログを出力します。

補足

上記のコードはあくまで基本的な例です。必要に応じて、オプションやエラー処理を追加してください。

Node.jsでディレクトリをZIP圧縮するその他の方法

yauzl モジュール:

yauzl は、Promiseベースの API を備えた軽量で高速な ZIP アーカイブライブラリです。
インストール: npm install yauzl
利点:
- 非同期処理に適しています。
- メモリ使用量が少ないです。
欠点:
サンプル:

const yauzl = require('yauzl');

const zipFilePath = 'compressed.zip';
const outputDir = 'extractedDir';

yauzl.open(zipFilePath, { autoClose: false })
  .then(zipFile => {
    zipFile.on('entry', entry => {
      if (entry.isDirectory) {
        fs.mkdirSync(`${outputDir}/${entry.fileName}`);
      } else {
        entry.readStream().pipe(fs.createWriteStream(`${outputDir}/${entry.fileName}`));
      }
      entry.on('end', () => {
        if (!entry.isDirectory) {
          console.log(`${entry.fileName} extracted`);
        }
      });
    });
  })
  .catch(error => {
    console.error('Error extracting ZIP:', error);
  });

JSZip モジュール:

JSZip は、ブラウザとNode.jsの両方で使用できる、包括的で使いやすいZIPライブラリです。
利点:
- メタデータの処理など、高度な機能を備えています。
欠点:

const JSZip = require('jszip');

const zip = new JSZip();

zip.folder('dirToCompress').addRecursively(['dirToCompress/*']);

zip.generateAsync({ type: 'nodebuffer' })
  .then(content => {
    fs.writeFileSync('compressed.zip', content);
    console.log('ZIP file created');
  })
  .catch(error => {
    console.error('Error creating ZIP:', error);
  });

Streams を使用したカスタムソリューション:

低レベルな制御が必要な場合、または特定のニーズに合わせたカスタムロジックを実装したい場合は、fs と zlib モジュールの Streams API を直接使用して、独自のZIP圧縮ソリューションを構築することができます。
利点:
欠点:

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

const dir = 'dirToCompress';
const output = fs.createWriteStream('compressed.zip');

const gzip = zlib.createGzip();

const compressFile = (filePath) => {
  const fileStream = fs.createReadStream(filePath);

  fileStream.pipe(gzip).pipe(output);

  fileStream.on('end', () => {
    console.log(`${filePath} compressed`);
  });
};

fs.readdirSync(dir).forEach(file => {
  compressFile(`${dir}/${file}`);
});