Apache Commons Compress 文件解压缩库

浅浅的花香味﹌ 2023-06-29 10:48 14阅读 0赞

**目录**

Apache Commons Compress 概述

本地文件解压缩代码示例

文件压缩并提供网络下载

--------------------

# Apache Commons Compress 概述 #

1、Apache Commons Compress 官网：http://commons.apache.org/proper/commons-compress/index.html

2、Apache Commons Compress 库定义了一个用于处理 ar，cpio，Unix 转储，tar，zip，gzip，XZ，Pack200，bzip2、7z，arj，lzma，snappy，DEFLATE，lz4，Brotli，Zstandard，DEFLATE64 和 Z 文件的 API 。

3、当前 Compress 版本是 1.19，并且需要 Java 7 及以上支持。

<table> 
 <tbody> 
  <tr> 
   <td> <p>现在 ParallelScatterZipCreator 会按照条目添加到存档的顺序来写入条目。</p> <p>现在默认情况下解析额外的字段时 ZipArchiveInputStream和ZipFile 更具宽容性。</p> <p>TarArchiveInputStream 具有新的宽松模式，该模式可能允许它读取某些已损坏的档案。</p> </td> 
  </tr> 
 </tbody> 
</table>

4、官网用户使用手册提供了各种压缩格式的处理方式（本文仅以常用的 zip 格式为例进行介绍）：http://commons.apache.org/proper/commons-compress/examples.html

5、Apache Commons Compress 官网下载：http://commons.apache.org/proper/commons-compress/download\_compress.cgi

6、可以从 Maven 中央仓库获取依赖：https://mvnrepository.com/artifact/org.apache.commons/commons-compress

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

**核心 API**

1）压缩输入流，用于解压压缩文件：public abstract class ArchiveInputStream extends java.io.InputStream

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly93YW5nbWFveGlvbmcuYmxvZy5jc2RuLm5ldA_size_16_color_FFFFFF_t_70][]

2）压缩输处出流，用于压缩压缩文件：public abstract class ArchiveOutputStream extends java.io.OutputStream

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly93YW5nbWFveGlvbmcuYmxvZy5jc2RuLm5ldA_size_16_color_FFFFFF_t_70 1][]

3）压缩文件内部存档的条目，压缩文件内部的每一个被压缩文件都称为一个条目：public interface ArchiveEntry

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly93YW5nbWFveGlvbmcuYmxvZy5jc2RuLm5ldA_size_16_color_FFFFFF_t_70 2][]

# 本地文件解压缩代码示例 #

1、生产中常见的需求之一就是对服务器上的某些文件进行压缩，或者解压。本文以常用的 zip 格式为例进行介绍。

![20200112104630486.gif][]

# 文件压缩并提供网络下载 #

1、生产中另一个常见的需求是，用户下载的时候，有时候需要将多个文件打包成一个文件后提供下载。

import org.apache.commons.compress.archivers.ArchiveEntry;
    import org.apache.commons.compress.archivers.zip.Zip64Mode;
    import org.apache.commons.compress.archivers.zip.ZipArchiveEntry;
    import org.apache.commons.compress.archivers.zip.ZipArchiveOutputStream;
    
    import javax.servlet.ServletOutputStream;
    import javax.servlet.http.HttpServletResponse;
    import java.io.*;
    import java.net.MalformedURLException;
    import java.net.URL;
    import java.net.URLEncoder;
    import java.text.SimpleDateFormat;
    import java.util.*;
    
    /**
     * 压缩文件下载工具类。用于将多文件文件压缩后，提供给 ServletOutputStream 输出流共用户网页下载
     */
    @SuppressWarnings("all")
    public class ZipFileDownloadUtils {
    
        /**
         * 压缩本地多个文件并提供输出流下载
         *
         * @param filePaths   ：本地文件路径，如 ["C:\\wmx\\temp\\data1.json","C:\\wmx\\temp\\data2.json"]。只支持文件，不能有目录,否则抛异常。
         * @param zipFileName ：压缩文件输出的名称，如 "年终总结" 不含扩展名。默认文件当前时间。如 20200108111213.zip
         * @param response    ：提供输出流
         */
        public static void zipFileDownloadByFile(Set<String> filePaths, String zipFileName, HttpServletResponse response) {
            try {
                //1）参数校验
                if (filePaths == null || filePaths.size() <= 0) {
                    throw new RuntimeException("待压缩导出文件为空.");
                }
                if (zipFileName == null || "".equals(zipFileName)) {
                    zipFileName = new SimpleDateFormat("yyyyMMddHHmmss").format(new Date()) + ".zip";
                } else {
                    zipFileName = zipFileName + ".zip";
                }
                //2）设置 response 参数。这里文件名如果是中文，则导出乱码，可以
                response.reset();
                response.setContentType("content-type:octet-stream;charset=UTF-8");
                response.setHeader("Content-Disposition", "attachment;filename=" + URLEncoder.encode(zipFileName, "utf-8"));
    
                //3）通过 OutputStream 创建 zip 压缩流。如果是压缩到本地，也可以直接使用 ZipArchiveOutputStream(final File file)
                ServletOutputStream servletOutputStream = response.getOutputStream();
                ZipArchiveOutputStream zipArchiveOutputStream = new ZipArchiveOutputStream(servletOutputStream);
                //4）setUseZip64(final Zip64Mode mode)：是否使用 Zip64 扩展。
                // Zip64Mode 枚举有 3 个值：Always：对所有条目使用 Zip64 扩展、Never：不对任何条目使用Zip64扩展、AsNeeded：对需要的所有条目使用Zip64扩展
                zipArchiveOutputStream.setUseZip64(Zip64Mode.AsNeeded);
    
                for (String filePath : filePaths) {
                    File file = new File(filePath);
                    String fileName = file.getName();
                    InputStream inputStream = new FileInputStream(file);
                    //5）使用 ByteArrayOutputStream 读取文件字节
                    ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream();
                    byte[] buffer = new byte[1024];
                    int readLength = -1;
                    while ((readLength = inputStream.read(buffer)) != -1) {
                        byteArrayOutputStream.write(buffer, 0, readLength);
                    }
                    if (byteArrayOutputStream != null) {
                        byteArrayOutputStream.flush();
                    }
                    byte[] fileBytes = byteArrayOutputStream.toByteArray();//整个文件字节数据
    
                    //6）用指定的名称创建一个新的 zip 条目(zip压缩实体)，然后设置到 zip 压缩输出流中进行写入.
                    ArchiveEntry entry = new ZipArchiveEntry(fileName);
                    zipArchiveOutputStream.putArchiveEntry(entry);
                    //6.1、write(byte b[])：从指定的字节数组写入 b.length 个字节到此输出流
                    zipArchiveOutputStream.write(fileBytes);
                    //6.2、写入此条目的所有必要数据。如果条目未压缩或压缩后的大小超过4 GB 则抛出异常
                    zipArchiveOutputStream.closeArchiveEntry();
                    if (byteArrayOutputStream != null) {
                        byteArrayOutputStream.close();
                    }
                }
                //7）最后关闭 zip 压缩输出流.
                if (zipArchiveOutputStream != null) {
                    zipArchiveOutputStream.close();
                }
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    
        /**
         * 压缩本地多个文件并提供输出流下载。只支持文件，不能有目录,否则抛异常。
         *
         * @param fileLists   ：本地文件，如 ["C:\\wmx\\temp\\data1.json","C:\\wmx\\temp\\data2.json"]。
         * @param zipFileName ：压缩文件输出的名称，如 "年终总结" 不含扩展名。默认文件当前时间。如 20200108111213.zip
         * @param response    ：提供输出流
         */
        public static void zipFileDownloadByFile(List<File> fileLists, String zipFileName, HttpServletResponse response) {
            if (fileLists == null || fileLists.size() <= 0) {
                throw new RuntimeException("待压缩导出文件为空.");
            }
            Set<String> filePaths = new HashSet<>();
            for (File file : fileLists) {
                filePaths.add(file.getAbsolutePath());
            }
            zipFileDownloadByFile(filePaths, zipFileName, response);
        }
    
        /**
         * 压缩网络文件。
         *
         * @param urlLists，待压缩的网络文件地址，如 ["http://www.baidu.com/img/bd_logo1.png"]
         * @param zipFileName
         * @param response
         */
        public static void zipFileDownloadByUrl(List<URL> urlLists, String zipFileName, HttpServletResponse response) {
            try {
                //1）参数校验
                if (urlLists == null || urlLists.size() <= 0) {
                    throw new RuntimeException("待压缩导出文件为空.");
                }
                if (zipFileName == null || "".equals(zipFileName)) {
                    zipFileName = new SimpleDateFormat("yyyyMMddHHmmss").format(new Date()) + ".zip";
                } else {
                    zipFileName = zipFileName + ".zip";
                }
                //2）设置 response 参数
                response.reset();
                response.setContentType("content-type:octet-stream;charset=UTF-8");
                response.setHeader("Content-Disposition", "attachment;filename=" + URLEncoder.encode(zipFileName, "utf-8"));
    
                //3）通过 OutputStream 创建 zip 压缩流。如果是压缩到本地，也可以直接使用 ZipArchiveOutputStream(final File file)
                ServletOutputStream servletOutputStream = response.getOutputStream();
                ZipArchiveOutputStream zipArchiveOutputStream = new ZipArchiveOutputStream(servletOutputStream);
                //4）setUseZip64(final Zip64Mode mode)：是否使用 Zip64 扩展。
                // Zip64Mode 枚举有 3 个值：Always：对所有条目使用 Zip64 扩展、Never：不对任何条目使用Zip64扩展、AsNeeded：对需要的所有条目使用Zip64扩展
                zipArchiveOutputStream.setUseZip64(Zip64Mode.AsNeeded);
    
                for (URL url : urlLists) {
                    String fileName = getNameByUrl(url);
                    InputStream inputStream = url.openStream();
                    //5）使用 ByteArrayOutputStream 读取文件字节
                    ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream();
                    byte[] buffer = new byte[1024];
                    int readLength = -1;
                    while ((readLength = inputStream.read(buffer)) != -1) {
                        byteArrayOutputStream.write(buffer, 0, readLength);
                    }
                    if (byteArrayOutputStream != null) {
                        byteArrayOutputStream.flush();
                    }
                    byte[] fileBytes = byteArrayOutputStream.toByteArray();//整个文件字节数据
    
                    //6）用指定的名称创建一个新的 zip 条目(zip压缩实体)，然后设置到 zip 压缩输出流中进行写入.
                    ArchiveEntry entry = new ZipArchiveEntry(fileName);
                    zipArchiveOutputStream.putArchiveEntry(entry);
                    //6.1、write(byte b[])：从指定的字节数组写入 b.length 个字节到此输出流
                    zipArchiveOutputStream.write(fileBytes);
                    //6.2、写入此条目的所有必要数据。如果条目未压缩或压缩后的大小超过4 GB 则抛出异常
                    zipArchiveOutputStream.closeArchiveEntry();
                    if (byteArrayOutputStream != null) {
                        byteArrayOutputStream.close();
                    }
                }
                //7）最后关闭 zip 压缩输出流.
                if (zipArchiveOutputStream != null) {
                    zipArchiveOutputStream.close();
                }
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    
        /**
         * 压缩网络文件
         *
         * @param urlPaths    待压缩的网络文件地址，如 ["http://www.baidu.com/img/bd_logo1.png"]
         * @param zipFileName
         * @param response
         */
        public static void zipFileDownloadByUrl(Set<String> urlPaths, String zipFileName, HttpServletResponse response) {
            if (urlPaths == null || urlPaths.size() <= 0) {
                throw new RuntimeException("待压缩导出文件为空.");
            }
            List<URL> urlList = new ArrayList<>();
            for (String urlPath : urlPaths) {
                try {
                    urlList.add(new URL(urlPath));
                } catch (MalformedURLException e) {
                    e.printStackTrace();
                }
            }
            zipFileDownloadByUrl(urlList, zipFileName, response);
        }
    
        /**
         * 通过 url 获取文件的名称
         *
         * @param url，如 http://www.baidu.com/img/bd_logo1.png
         * @return
         */
        private static String getNameByUrl(URL url) {
            String name = url.toString();
            int lastIndexOf1 = name.lastIndexOf("/");
            int lastIndexOf2 = name.lastIndexOf("\\");
            if (lastIndexOf1 > 0) {
                name = name.substring(lastIndexOf1 + 1, name.length());
            } else if (lastIndexOf2 > 0) {
                name = name.substring(lastIndexOf1 + 2, name.length());
            }
            return name;
        }
    }

![20200112104656410.gif][]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly93YW5nbWFveGlvbmcuYmxvZy5jc2RuLm5ldA_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/2020011210450480.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly93YW5nbWFveGlvbmcuYmxvZy5jc2RuLm5ldA==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly93YW5nbWFveGlvbmcuYmxvZy5jc2RuLm5ldA_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20200112104515807.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly93YW5nbWFveGlvbmcuYmxvZy5jc2RuLm5ldA==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly93YW5nbWFveGlvbmcuYmxvZy5jc2RuLm5ldA_size_16_color_FFFFFF_t_70 2]: https://img-blog.csdnimg.cn/20200112104531501.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly93YW5nbWFveGlvbmcuYmxvZy5jc2RuLm5ldA==,size_16,color_FFFFFF,t_70
[20200112104630486.gif]: https://img-blog.csdnimg.cn/20200112104630486.gif
[20200112104656410.gif]: https://img-blog.csdnimg.cn/20200112104656410.gif