Javaでの圧縮と解凍

投稿日: 2019-10-18 2022-10-13
タグ: Java

1. 概要

このクイックチュートリアルでは、Javaが提供するコアライブラリを使用して、ファイルをアーカイブに圧縮する方法とアーカイブを解凍する方法を学習します。

これらのコアライブラリは、 java.util.zip パッケージ、ここで、すべての圧縮および解凍関連のユーティリティを見つけることができます。

2. ファイルを圧縮する

まず、1つのファイルをzip形式で圧縮する簡単な操作を見てみましょう。

この例では、test1.txtという名前のファイルをcompressed.zip。という名前のアーカイブに圧縮します。

もちろん、最初にディスクからファイルにアクセスします。

public class ZipFile {
    public static void main(String[] args) throws IOException {
        String sourceFile = "test1.txt";
        FileOutputStream fos = new FileOutputStream("compressed.zip");
        ZipOutputStream zipOut = new ZipOutputStream(fos);
        File fileToZip = new File(sourceFile);
        FileInputStream fis = new FileInputStream(fileToZip);
        ZipEntry zipEntry = new ZipEntry(fileToZip.getName());
        zipOut.putNextEntry(zipEntry);
        byte[] bytes = new byte[1024];
        int length;
        while((length = fis.read(bytes)) >= 0) {
            zipOut.write(bytes, 0, length);
        }
        zipOut.close();
        fis.close();
        fos.close();
    }
}

3. 複数のファイルをZipする

次に、複数のファイルを1つのzipファイルに圧縮する方法を見てみましょう。 test1.txtとtest2.txtをmultiCompressed.zipに圧縮します。

public class ZipMultipleFiles {
    public static void main(String[] args) throws IOException {
        List<String> srcFiles = Arrays.asList("test1.txt", "test2.txt");
        FileOutputStream fos = new FileOutputStream("multiCompressed.zip");
        ZipOutputStream zipOut = new ZipOutputStream(fos);
        for (String srcFile : srcFiles) {
            File fileToZip = new File(srcFile);
            FileInputStream fis = new FileInputStream(fileToZip);
            ZipEntry zipEntry = new ZipEntry(fileToZip.getName());
            zipOut.putNextEntry(zipEntry);

            byte[] bytes = new byte[1024];
            int length;
            while((length = fis.read(bytes)) >= 0) {
                zipOut.write(bytes, 0, length);
            }
            fis.close();
        }
        zipOut.close();
        fos.close();
    }
}

4. ディレクトリを圧縮する

次に、ディレクトリ全体を圧縮する方法について説明します。 zipTestをdirCompressed.zipに圧縮します。

public class ZipDirectory {
    public static void main(String[] args) throws IOException {
        String sourceFile = "zipTest";
        FileOutputStream fos = new FileOutputStream("dirCompressed.zip");
        ZipOutputStream zipOut = new ZipOutputStream(fos);
        File fileToZip = new File(sourceFile);

        zipFile(fileToZip, fileToZip.getName(), zipOut);
        zipOut.close();
        fos.close();
    }

    private static void zipFile(File fileToZip, String fileName, ZipOutputStream zipOut) throws IOException {
        if (fileToZip.isHidden()) {
            return;
        }
        if (fileToZip.isDirectory()) {
            if (fileName.endsWith("/")) {
                zipOut.putNextEntry(new ZipEntry(fileName));
                zipOut.closeEntry();
            } else {
                zipOut.putNextEntry(new ZipEntry(fileName + "/"));
                zipOut.closeEntry();
            }
            File[] children = fileToZip.listFiles();
            for (File childFile : children) {
                zipFile(childFile, fileName + "/" + childFile.getName(), zipOut);
            }
            return;
        }
        FileInputStream fis = new FileInputStream(fileToZip);
        ZipEntry zipEntry = new ZipEntry(fileName);
        zipOut.putNextEntry(zipEntry);
        byte[] bytes = new byte[1024];
        int length;
        while ((length = fis.read(bytes)) >= 0) {
            zipOut.write(bytes, 0, length);
        }
        fis.close();
    }
}

ご了承ください：

サブディレクトリを圧縮するために、それらを再帰的に繰り返し処理します。
ディレクトリを見つけるたびに、その名前を子孫の ZipEntry 名に追加して、階層を保存します。
また、空のディレクトリごとにディレクトリエントリを作成します。

5. アーカイブを解凍します

それでは、アーカイブを解凍してその内容を抽出しましょう。

この例では、 compressed.zipをunzipTest：という名前の新しいフォルダーに解凍します。

public class UnzipFile {
    public static void main(String[] args) throws IOException {
        String fileZip = "src/main/resources/unzipTest/compressed.zip";
        File destDir = new File("src/main/resources/unzipTest");
        byte[] buffer = new byte[1024];
        ZipInputStream zis = new ZipInputStream(new FileInputStream(fileZip));
        ZipEntry zipEntry = zis.getNextEntry();
        while (zipEntry != null) {
           // ...
        }
        zis.closeEntry();
        zis.close();
    }
}

while ループ内で、各ZipEntryを繰り返し処理し、最初にディレクトリかどうかを確認します。そうである場合は、 mkdirs（）メソッドを使用してディレクトリを作成します。それ以外の場合は、ファイルの作成を続行します。

while (zipEntry != null) {
     File newFile = newFile(destDir, zipEntry);
     if (zipEntry.isDirectory()) {
         if (!newFile.isDirectory() && !newFile.mkdirs()) {
             throw new IOException("Failed to create directory " + newFile);
         }
     } else {
         // fix for Windows-created archives
         File parent = newFile.getParentFile();
         if (!parent.isDirectory() && !parent.mkdirs()) {
             throw new IOException("Failed to create directory " + parent);
         }
         
         // write file content
         FileOutputStream fos = new FileOutputStream(newFile);
         int len;
         while ((len = zis.read(buffer)) > 0) {
             fos.write(buffer, 0, len);
         }
         fos.close();
     }
 zipEntry = zis.getNextEntry();
}

ここでの注意点は、 else ブランチで、ファイルの親ディレクトリが存在するかどうかも確認していることです。これは、ルートディレクトリのzipファイルに対応するエントリがないWindowsで作成されたアーカイブに必要です。

もう1つの重要なポイントは、 newFile（）メソッドにあります。

public static File newFile(File destinationDir, ZipEntry zipEntry) throws IOException {
    File destFile = new File(destinationDir, zipEntry.getName());

    String destDirPath = destinationDir.getCanonicalPath();
    String destFilePath = destFile.getCanonicalPath();

    if (!destFilePath.startsWith(destDirPath + File.separator)) {
        throw new IOException("Entry is outside of the target dir: " + zipEntry.getName());
    }

    return destFile;
}

このメソッドは、ターゲットフォルダの外部のファイルシステムにファイルを書き込むことを防ぎます。この脆弱性はZipSlipと呼ばれ、ここで詳細を読むことができます。

6. 結論

この記事では、ファイルを圧縮および解凍するためにJavaライブラリを使用する方法を説明しました。

これらの例の実装は、GitHubのにあります。

getdocs

13036