关于spring:使用Java-API进行targz文件及文件夹压缩解压缩

在 java(JDK)中咱们能够应用 ZipOutputStream 去创立 zip 压缩文件，（参考我之前写的文章 应用 java API 进行 zip 递归压缩文件夹以及解压），也能够应用 GZIPOutputStream 去创立 gzip（gz）压缩文件，然而 java 中没有一种官网的 API 能够去创立 tar.gz 文件。所以咱们须要应用到第三方库 Apache Commons Compress 去创立 .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;
}

欢送关注我的博客，外面有很多精品合集

• 本文转载注明出处（必须带连贯，不能只转文字）：字母哥博客。

感觉对您有帮忙的话，帮我点赞、分享！您的反对是我不竭的创作能源！。另外，笔者最近一段时间输入了如下的精品内容，期待您的关注。

• 《手摸手教你学 Spring Boot2.0》
• 《Spring Security-JWT-OAuth2 一本通》
• 《实战前后端拆散 RBAC 权限管理系统》
• 《实战 SpringCloud 微服务从青铜到王者》
• 《VUE 深入浅出系列》