使用Java API進行tar.gz檔案及資料夾壓縮解壓縮

在java(JDK)中我們可以使用ZipOutputStream去建立zip壓縮檔案，（參考我之前寫的文章 ），也可以使用GZIPOutputStream去建立gzip（gz）壓縮檔案，但是java中沒有一種官方的API可以去建立tar.gz檔案。所以我們需要使用到第三方庫去建立.tar.gz檔案。

在pom.xml中，我們可以透過如下的maven座標引入commons-compress。

<dependency>
    <groupId>org.apache.commons</groupId>
    <artifactId>commons-compress</artifactId>
    <version>1.20</version>
</dependency>

解釋說明

1. tar檔案準確的說是打包檔案，將檔案打包到一個tar檔案中，檔名字尾是.tar
2. Gzip是將檔案的儲存空間壓縮儲存，檔名字尾是.gz
3. tar.gz或.tgz通常是指將檔案打包到一個tar檔案中，並將它使用Gzip進行壓縮。

如果您閱讀完本文覺得對您有幫助的話，請給我一個贊，您的支援是我不竭的創作動力！

一、將兩個檔案打包到tar.gz

下面的這個例子是將2個檔案打包為tar.gz壓縮檔案。下文程式碼中的流操作使用了try-with-resources語法，所以不用寫程式碼手動的close流。

import org.apache.commons.compress.archivers.tar.TarArchiveEntry;
import org.apache.commons.compress.archivers.tar.TarArchiveOutputStream;
import org.apache.commons.compress.compressors.gzip.GzipCompressorOutputStream;
import org.junit.jupiter.api.Test;

import java.io.BufferedOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.Arrays;
import java.util.List;

public class TarGzTest {

  @Test
  void testFilesTarGzip() throws IOException {
    //輸入檔案，被壓縮檔案
    Path path1 = Paths.get("/home/test/file-a.xml");
    Path path2 = Paths.get("/home/test/file-b.txt");
    List<Path> paths = Arrays.asList(path1, path2);

    //輸出檔案壓縮結果
    Path output = Paths.get("/home/test/output.tar.gz");

    //OutputStream輸出流、BufferedOutputStream緩衝輸出流
    //GzipCompressorOutputStream是gzip壓縮輸出流
    //TarArchiveOutputStream打tar包輸出流（包含gzip壓縮輸出流）
    try (OutputStream fOut = Files.newOutputStream(output);
         BufferedOutputStream buffOut = new BufferedOutputStream(fOut);
         GzipCompressorOutputStream gzOut = new GzipCompressorOutputStream(buffOut);
         TarArchiveOutputStream tOut = new TarArchiveOutputStream(gzOut)) {

      //遍歷檔案list
      for (Path path : paths) {
        //該檔案不是目錄或者符號連結
        if (!Files.isRegularFile(path)) {
          throw new IOException("Support only file!");
        }
        //將該檔案放入tar包，並執行gzip壓縮
        TarArchiveEntry tarEntry = new TarArchiveEntry(
                path.toFile(),
                path.getFileName().toString());

        tOut.putArchiveEntry(tarEntry);
        Files.copy(path, tOut);

        tOut.closeArchiveEntry();
      }
      //for迴圈完成之後，finish-tar包輸出流
      tOut.finish();
    }
  }
}

將file-a.xml和file-b.txt打包到output.tar檔案中，並使用gzip對這個tar包進行壓縮。可以使用如下命令檢視tar包裡面包含的檔案。

$ tar -tvf /home/test/output.tar.gz
-rw-r--r-- 0/0          23546 2020-08-17 12:07 file-a.xml
-rw-r--r-- 0/0              34  2020-08-17 12:36 file-b.txt

二、將一個資料夾壓縮為tar.gz

下面的例子將一個資料夾，包含其子資料夾的檔案或子目錄，打包為tar，並使用gzip進行壓縮。最終成為一個tar.gz打包壓縮檔案。
其核心原理是：使用到Files.walkFileTree依次遍歷檔案目錄樹中的檔案，將其一個一個的新增到TarArchiveOutputStream.輸出流。

@Test
void testDirTarGzip() throws IOException {
  // 被壓縮打包的資料夾
  Path source = Paths.get("/home/test");
  //如果不是資料夾丟擲異常
  if (!Files.isDirectory(source)) {
    throw new IOException("請指定一個資料夾");
  }

  //壓縮之後的輸出檔名稱
  String tarFileName = "/home/" + source.getFileName().toString() + ".tar.gz";

  //OutputStream輸出流、BufferedOutputStream緩衝輸出流
  //GzipCompressorOutputStream是gzip壓縮輸出流
  //TarArchiveOutputStream打tar包輸出流（包含gzip壓縮輸出流）
  try (OutputStream fOut = Files.newOutputStream(Paths.get(tarFileName));
       BufferedOutputStream buffOut = new BufferedOutputStream(fOut);
       GzipCompressorOutputStream gzOut = new GzipCompressorOutputStream(buffOut);
       TarArchiveOutputStream tOut = new TarArchiveOutputStream(gzOut)) {
    //遍歷檔案目錄樹
    Files.walkFileTree(source, new SimpleFileVisitor<Path>() {

      //當成功訪問到一個檔案
      @Override
      public FileVisitResult visitFile(Path file,
                                       BasicFileAttributes attributes) throws IOException {

        // 判斷當前遍歷檔案是不是符號連結(快捷方式)，不做打包壓縮處理
        if (attributes.isSymbolicLink()) {
          return FileVisitResult.CONTINUE;
        }

        //獲取當前遍歷檔名稱
        Path targetFile = source.relativize(file);

        //將該檔案打包壓縮
        TarArchiveEntry tarEntry = new TarArchiveEntry(
                file.toFile(), targetFile.toString());
        tOut.putArchiveEntry(tarEntry);
        Files.copy(file, tOut);
        tOut.closeArchiveEntry();
        //繼續下一個遍歷檔案處理
        return FileVisitResult.CONTINUE;
      }

      //當前遍歷檔案訪問失敗
      @Override
      public FileVisitResult visitFileFailed(Path file, IOException exc) {
        System.err.printf("無法對該檔案壓縮打包為tar.gz : %s%n%s%n", file, exc);
        return FileVisitResult.CONTINUE;
      }

    });
    //for迴圈完成之後，finish-tar包輸出流
    tOut.finish();
  }
}

三、解壓tar.gz壓縮檔案

下面一個例子說明如何解壓一個tar.gz檔案，具體內容請看程式碼註釋。

@Test
void testDeCompressTarGzip() throws IOException {
  //解壓檔案
  Path source = Paths.get("/home/test/output.tar.gz");
  //解壓到哪
  Path target = Paths.get("/home/test2");
  
  if (Files.notExists(source)) {
    throw new IOException("您要解壓的檔案不存在");
  }

  //InputStream輸入流，以下四個流將tar.gz讀取到記憶體並操作
  //BufferedInputStream緩衝輸入流
  //GzipCompressorInputStream解壓輸入流
  //TarArchiveInputStream解tar包輸入流
  try (InputStream fi = Files.newInputStream(source);
       BufferedInputStream bi = new BufferedInputStream(fi);
       GzipCompressorInputStream gzi = new GzipCompressorInputStream(bi);
       TarArchiveInputStream ti = new TarArchiveInputStream(gzi)) {

    ArchiveEntry entry;
    while ((entry = ti.getNextEntry()) != null) {

      //獲取解壓檔案目錄，並判斷檔案是否損壞
      Path newPath = zipSlipProtect(entry, target);
      
      if (entry.isDirectory()) {
        //建立解壓檔案目錄
        Files.createDirectories(newPath);
      } else {
        //再次校驗解壓檔案目錄是否存在
        Path parent = newPath.getParent();
        if (parent != null) {
          if (Files.notExists(parent)) {
            Files.createDirectories(parent);
          }
        }
        // 將解壓檔案輸入到TarArchiveInputStream，輸出到磁碟newPath目錄
        Files.copy(ti, newPath, StandardCopyOption.REPLACE_EXISTING);

      }
    }
  }
  
}

//判斷壓縮檔案是否被損壞，並返回該檔案的解壓目錄
private  Path zipSlipProtect(ArchiveEntry entry,Path targetDir)
        throws IOException {

  Path targetDirResolved = targetDir.resolve(entry.getName());
  Path normalizePath = targetDirResolved.normalize();

  if (!normalizePath.startsWith(targetDir)) {
    throw new IOException("壓縮檔案已被損壞: " + entry.getName());
  }

  return normalizePath;
}

歡迎關注我的部落格，裡面有很多精品合集

• 本文轉載註明出處（必須帶連線，不能只轉文字）：。