Java实现打包压缩文件或文件夹生成zip以实现多文件批量下载

吾悟无

有时候在系统中需要一次性下载多个文件，但逐个下载文件比较麻烦。这时候，最好的解决办法是将所有文件打包成一个压缩文件，然后下载这个压缩文件，这样就可以一次性获取所有所需的文件了。
下面是一个名为CompressUtil的工具类的代码，它提供了一些方法来处理文件压缩和下载操作：

1. import org.apache.commons.lang3.ArrayUtils;
2. import org.apache.commons.lang3.StringUtils;
3. import org.apache.lucene.util.RamUsageEstimator;
4. import org.slf4j.Logger;
5. import org.slf4j.LoggerFactory;
6. import javax.servlet.ServletOutputStream;
7. import javax.servlet.http.HttpServletResponse;
8. import java.io.*;
9. import java.util.*;
10. import java.util.zip.*;
12. /**
13. * @author fhey
14. * @date 2023-05-11 20:48:28
15. * @description: 压缩工具类
16. */
18. public class CompressUtil {
20.     private static final Logger logger = LoggerFactory.getLogger(CompressUtil.class);
22.     /**
23.      * 将文件打包到zip并创建文件
24.      *
25.      * @param sourceFilePath
26.      * @param zipFilePath
27.      * @throws IOException
28.      */
29.     public static void createLocalCompressFile(String sourceFilePath, String zipFilePath) throws IOException {
30.         createLocalCompressFile(sourceFilePath, zipFilePath, null);
31.     }
33.     /**
34.      * 将文件打包到zip并创建文件
35.      *
36.      * @param sourceFilePath
37.      * @param zipFilePath
38.      * @param zipName
39.      * @throws IOException
40.      */
41.     public static void createLocalCompressFile(String sourceFilePath, String zipFilePath, String zipName) throws IOException {
42.         File sourceFile = new File(sourceFilePath);
43.         if (!sourceFile.exists()) {
44.             throw new RuntimeException(sourceFilePath + "不存在！");
45.         }
46.         if(StringUtils.isBlank(zipName)){
47.             zipName = sourceFile.getName();
48.         }
49.         File zipFile = createNewFile(zipFilePath + File.separator + zipName + ".zip");
50.         try (FileOutputStream fileOutputStream = new FileOutputStream(zipFile)) {
51.             compressFile(sourceFile, fileOutputStream);
52.         }
53.     }
55.     /**
56.      * 获取压缩文件流
57.      *
58.      * @param sourceFilePath
59.      * @return ByteArrayOutputStream
60.      * @throws IOException
61.      */
62.     public static OutputStream compressFile(String sourceFilePath, OutputStream outputStream) throws IOException {
63.         File sourceFile = new File(sourceFilePath);
64.         if (!sourceFile.exists()) {
65.             throw new RuntimeException(sourceFilePath + "不存在！");
66.         }
67.         return compressFile(sourceFile, outputStream);
68.     }
70.     /**
71.      * 获取压缩文件流
72.      *
73.      * @param sourceFile
74.      * @return ByteArrayOutputStream
75.      * @throws IOException
76.      */
77.     private static OutputStream compressFile(File sourceFile, OutputStream outputStream) throws IOException {
78.         try (CheckedOutputStream checkedOutputStream = new CheckedOutputStream(outputStream, new CRC32());
79.              ZipOutputStream zipOutputStream = new ZipOutputStream(checkedOutputStream)) {
80.             doCompressFile(sourceFile, zipOutputStream, StringUtils.EMPTY);
81.             return outputStream;
82.         }
83.     }
85.     /**
86.      * 处理目录下的文件
87.      *
88.      * @param sourceFile
89.      * @param zipOutputStream
90.      * @param zipFilePath
91.      * @throws IOException
92.      */
93.     private static void doCompressFile(File sourceFile, ZipOutputStream zipOutputStream, String zipFilePath) throws IOException {
94.         // 如果文件是隐藏的，不进行压缩
95.         if (sourceFile.isHidden()) {
96.             return;
97.         }
98.         if (sourceFile.isDirectory()) {//如果是文件夹
99.             handDirectory(sourceFile, zipOutputStream, zipFilePath);
100.         } else {//如果是文件就添加到压缩包中
101.             try (FileInputStream fileInputStream = new FileInputStream(sourceFile)) {
102.                 //String fileName = zipFilePath + File.separator + sourceFile.getName();
103.                 String fileName = zipFilePath + sourceFile.getName();
104.                 addCompressFile(fileInputStream, fileName, zipOutputStream);
105.                 //String fileName = zipFilePath.replace("\", "/") + "/" + sourceFile.getName();
106.                 //addCompressFile(fileInputStream, fileName, zipOutputStream);
107.             }
108.         }
109.     }
111.     /**
112.      * 处理文件夹
113.      *
114.      * @param dir         文件夹
115.      * @param zipOut      压缩包输出流
116.      * @param zipFilePath 压缩包中的文件夹路径
117.      * @throws IOException
118.      */
119.     private static void handDirectory(File dir, ZipOutputStream zipOut, String zipFilePath) throws IOException {
120.         File[] files = dir.listFiles();
121.         if (ArrayUtils.isEmpty(files)) {
122.             ZipEntry zipEntry = new ZipEntry(zipFilePath + dir.getName() + File.separator);
123.             zipOut.putNextEntry(zipEntry);
124.             zipOut.closeEntry();
125.             return;
126.         }
127.         for (File file : files) {
128.             doCompressFile(file, zipOut, zipFilePath + dir.getName() + File.separator);
129.         }
130.     }
132.     /**
133.      * 获取压缩文件流
134.      *
135.      * @param documentList 需要压缩的文件集合
136.      * @return ByteArrayOutputStream
137.      */
138.     public static OutputStream compressFile(List<FileInfo> documentList, OutputStream outputStream) {
139.         Map<String, List<FileInfo>> documentMap = new HashMap<>();
140.         documentMap.put("", documentList);
141.         return compressFile(documentMap, outputStream);
142.     }
144.     /**
145.      * 将文件打包到zip
146.      *
147.      * @param documentMap 需要下载的附件集合 map的key对应zip里的文件夹名
148.      * @return ByteArrayOutputStream
149.      */
150.     public static OutputStream compressFile(Map<String, List<FileInfo>> documentMap, OutputStream outputStream) {
151.         CheckedOutputStream checkedOutputStream = new CheckedOutputStream(outputStream, new CRC32());
152.         ZipOutputStream zipOutputStream = new ZipOutputStream(checkedOutputStream);
153.         try {
154.             for (Map.Entry<String, List<FileInfo>> documentListEntry : documentMap.entrySet()) {
155.                 String dirName = documentMap.size() > 1 ? documentListEntry.getKey() : "";
156.                 Map<String, Integer> fileNameToLen = new HashMap<>();//记录单个合同号文件夹下每个文件名称出现的次数（对重复文件名重命名）
157.                 for (FileInfo document : documentListEntry.getValue()) {
158.                     try {
159.                         //防止单个文件夹下文件名重复 对重复的文件进行重命名
160.                         String documentName = document.getFileName();
161.                         if (fileNameToLen.get(documentName) == null) {
162.                             fileNameToLen.put(documentName, 1);
163.                         } else {
164.                             int fileLen = fileNameToLen.get(documentName) + 1;
165.                             fileNameToLen.put(documentName, fileLen);
166.                             documentName = documentName + "(" + fileLen + ")";
167.                         }
168.                         String fileName = documentName + "." + document.getSuffix();
169.                         if (StringUtils.isNotBlank(dirName)) {
170.                             fileName = dirName + File.separator + fileName;
171.                         }
172.                         addCompressFile(document.getFileInputStream(), fileName, zipOutputStream);
173.                     } catch (Exception e) {
174.                         logger.info("filesToZip exception :", e);
175.                     }
176.                 }
177.             }
178.         } catch (Exception e) {
179.             logger.error("filesToZip exception:" + e.getMessage(), e);
180.         }
181.         return outputStream;
182.     }
184.     /**
185.      * 将单个文件写入文件压缩包
186.      *
187.      * @param inputStream     文件输入流
188.      * @param fileName        文件在压缩包中的相对全路径
189.      * @param zipOutputStream 压缩包输出流
190.      */
191.     private static void addCompressFile(InputStream inputStream, String fileName, ZipOutputStream zipOutputStream) {
192.         try (BufferedInputStream bufferedInputStream = new BufferedInputStream(inputStream)) {
193.             ZipEntry zipEntry = new ZipEntry(fileName);
194.             zipOutputStream.putNextEntry(zipEntry);
195.             byte[] bytes = new byte[1024];
196.             int length;
197.             while ((length = bufferedInputStream.read(bytes)) >= 0) {
198.                 zipOutputStream.write(bytes, 0, length);
199.                 zipOutputStream.flush();
200.             }
201.             zipOutputStream.closeEntry();
202.             //System.out.println("map size, value is " + RamUsageEstimator.sizeOf(zipOutputStream));
203.         } catch (Exception e) {
204.             logger.info("addFileToZip exception:", e);
205.             throw new RuntimeException(e);
206.         }
207.     }
209.     /**
210.      * 通过网络请求下载zip
211.      *
212.      * @param sourceFilePath       需要压缩的文件路径
213.      * @param response            HttpServletResponse
214.      * @param zipName            压缩包名称
215.      * @throws IOException
216.      */
217.     public static void httpDownloadCompressFile(String sourceFilePath, HttpServletResponse response, String zipName) throws IOException {
218.         File sourceFile = new File(sourceFilePath);
219.         if (!sourceFile.exists()) {
220.             throw new RuntimeException(sourceFilePath + "不存在！");
221.         }
222.         if(StringUtils.isBlank(zipName)){
223.             zipName = sourceFile.getName();
224.         }
225.         try (ServletOutputStream servletOutputStream = response.getOutputStream()){
226.             CompressUtil.compressFile(sourceFile, servletOutputStream);
227.             response.setContentType("application/zip");
228.             response.setHeader("Content-Disposition", "attachment; filename="" + zipName + ".zip"");
229.             servletOutputStream.flush();
230.         }
231.     }
233.     public static void httpDownloadCompressFileOld(String sourceFilePath, HttpServletResponse response, String zipName) throws IOException {
234.         try (ServletOutputStream servletOutputStream = response.getOutputStream()){
235.             ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream();
236.             byte[] zipBytes = byteArrayOutputStream.toByteArray();
237.             response.setContentType("application/zip");
238.             response.setHeader("Content-Disposition", "attachment; filename="" + zipName + ".zip"");
239.             response.setContentLength(zipBytes.length);
240.             servletOutputStream.write(zipBytes);
241.             servletOutputStream.flush();
242.         }
243.     }
245.     /**
246.      * 通过网络请求下载zip
247.      *
248.      * @param sourceFilePath       需要压缩的文件路径
249.      * @param response            HttpServletResponse
250.      * @throws IOException
251.      */
252.     public static void httpDownloadCompressFile(String sourceFilePath, HttpServletResponse response) throws IOException {
253.         httpDownloadCompressFile(sourceFilePath, response, null);
254.     }
257.     /**
258.      * 检查文件名是否已经存在，如果存在，就在文件名后面加上“(1)”，如果文件名“(1)”也存在，则改为“(2)”，以此类推。如果文件名不存在，就直接创建一个新文件。
259.      *
260.      * @param filename 文件名
261.      * @return File
262.      */
263.     public static File createNewFile(String filename) {
264.         File file = new File(filename);
265.         if (!file.exists()) {
266.             try {
267.                 file.createNewFile();
268.             } catch (IOException e) {
269.                 e.printStackTrace();
270.             }
271.         } else {
272.             String base = filename.substring(0, filename.lastIndexOf("."));
273.             String ext = filename.substring(filename.lastIndexOf("."));
274.             int i = 1;
275.             while (true) {
276.                 String newFilename = base + "(" + i + ")" + ext;
277.                 file = new File(newFilename);
278.                 if (!file.exists()) {
279.                     try {
280.                         file.createNewFile();
281.                     } catch (IOException e) {
282.                         e.printStackTrace();
283.                     }
284.                     break;
285.                 }
286.                 i++;
287.             }
288.         }
289.         return file;
290.     }
291. }

复制代码

FileInfo类代码：

1. /**
2. * @author fhey
3. * @date 2023-05-11 21:01:26
4. * @description: TODO
5. */
6. @Data
7. public class FileInfo {
8.     private InputStream fileInputStream;
10.     private String suffix;
12.     private String fileName;
13.    
14.     private boolean isDirectory;
15. }

复制代码

测试压缩并在本地生成文件：

1. public static void main(String[] args) throws Exception {
2.         //在本地创建压缩文件
3.         CompressUtil.createLocalCompressFile("D:\\书籍\\电子书\\医书", "D:\\test");
4.     }

复制代码

压缩并在本地生成文件验证结果：

压缩文件并通过http请求下载：

1. /**
2. * @author fhey
3. */
4. @RestController
5. public class TestController {
7.     @GetMapping(value = "/testFileToZip")
8.     public void testFileToZip(HttpServletResponse response) throws IOException {
9.         String zipFileName = "myFiles";
10.         String sourceFilePath = "D:\\picture";
11.         CompressUtil.httpDownloadCompressFile(sourceFilePath,response, zipFileName);
12.     }
13. }

复制代码

压缩文件并通过http请求下载验证结果：

来源:https://www.cnblogs.com/fhey/p/17433021.html
免责声明：由于采集信息均来自互联网，如果侵犯了您的权益，请联系我们【E-Mail:cb@itdo.tech】 我们会及时删除侵权内容，谢谢合作！