Java实现将文件压缩成zip

最近碰到个需要下载zip压缩包的需求,于是我在网上找了下别人写好的zip工具类。但找了好多篇博客,总是发现有bug。因此就自己来写了个工具类。
        这个工具类的功能为:
  • (1)可以压缩文件,也可以压缩文件夹
  • (2)同时支持压缩多级文件夹,工具内部做了递归处理
  • (3)碰到空的文件夹,也可以压缩
  • (4)可以选择是否保留原来的目录结构,如果不保留,所有文件跑压缩包根目录去了,且空文件夹直接舍弃。注意:如果不保留文件原来目录结构,在碰到文件名相同的文件时,会压缩失败。
  • (5)代码中提供了2个压缩文件的方法,一个的输入参数为文件夹路径,一个为文件列表,可根据实际需求选择方法。
      
        下面直接上代码

一、代码

  1. package com.tax.core.util;
  2. import java.io.File;
  3. import java.io.FileInputStream;
  4. import java.io.FileOutputStream;
  5. import java.io.IOException;
  6. import java.io.OutputStream;
  7. import java.util.ArrayList;
  8. import java.util.List;
  9. import java.util.zip.ZipEntry;
  10. import java.util.zip.ZipOutputStream;
  11. /**
  12. * ZipUtils
  13. * @author GDL
  14. * @date 2017年11月20
  15. * @version v1.0
  16. */
  17. public class ZipUtils {
  18. private static final int BUFFER_SIZE = 2 * 1024;
  19. /**
  20. * 压缩成ZIP 方法1
  21. * @param srcDir 压缩文件夹路径
  22. * @param out 压缩文件输出流
  23. * @param KeepDirStructure 是否保留原来的目录结构,true:保留目录结构;
  24. * false:所有文件跑到压缩包根目录下(注意:不保留目录结构可能会出现同名文件,会压缩失败)
  25. * @throws RuntimeException 压缩失败会抛出运行时异常
  26. */
  27. public static void toZip(String srcDir, OutputStream out, boolean KeepDirStructure)
  28. throws RuntimeException{
  29. long start = System.currentTimeMillis();
  30. ZipOutputStream zos = null ;
  31. try {
  32. zos = new ZipOutputStream(out);
  33. File sourceFile = new File(srcDir);
  34. compress(sourceFile,zos,sourceFile.getName(),KeepDirStructure);
  35. long end = System.currentTimeMillis();
  36. System.out.println("压缩完成,耗时:" + (end - start) +" ms");
  37. } catch (Exception e) {
  38. throw new RuntimeException("zip error from ZipUtils",e);
  39. }finally{
  40. if(zos != null){
  41. try {
  42. zos.close();
  43. } catch (IOException e) {
  44. e.printStackTrace();
  45. }
  46. }
  47. }
  48. }
  49. /**
  50. * 压缩成ZIP 方法2
  51. * @param srcFiles 需要压缩的文件列表
  52. * @param out 压缩文件输出流
  53. * @throws RuntimeException 压缩失败会抛出运行时异常
  54. */
  55. public static void toZip(List<File> srcFiles , OutputStream out)throws RuntimeException {
  56. long start = System.currentTimeMillis();
  57. ZipOutputStream zos = null ;
  58. try {
  59. zos = new ZipOutputStream(out);
  60. for (File srcFile : srcFiles) {
  61. byte[] buf = new byte[BUFFER_SIZE];
  62. zos.putNextEntry(new ZipEntry(srcFile.getName()));
  63. int len;
  64. FileInputStream in = new FileInputStream(srcFile);
  65. while ((len = in.read(buf)) != -1){
  66. zos.write(buf, 0, len);
  67. }
  68. zos.closeEntry();
  69. in.close();
  70. }
  71. long end = System.currentTimeMillis();
  72. System.out.println("压缩完成,耗时:" + (end - start) +" ms");
  73. } catch (Exception e) {
  74. throw new RuntimeException("zip error from ZipUtils",e);
  75. }finally{
  76. if(zos != null){
  77. try {
  78. zos.close();
  79. } catch (IOException e) {
  80. e.printStackTrace();
  81. }
  82. }
  83. }
  84. }
  85. /**
  86. * 递归压缩方法
  87. * @param sourceFile 源文件
  88. * @param zos zip输出流
  89. * @param name 压缩后的名称
  90. * @param KeepDirStructure 是否保留原来的目录结构,true:保留目录结构;
  91. * false:所有文件跑到压缩包根目录下(注意:不保留目录结构可能会出现同名文件,会压缩失败)
  92. * @throws Exception
  93. */
  94. private static void compress(File sourceFile, ZipOutputStream zos, String name,
  95. boolean KeepDirStructure) throws Exception{
  96. byte[] buf = new byte[BUFFER_SIZE];
  97. if(sourceFile.isFile()){
  98. // 向zip输出流中添加一个zip实体,构造器中name为zip实体的文件的名字
  99. zos.putNextEntry(new ZipEntry(name));
  100. // copy文件到zip输出流中
  101. int len;
  102. FileInputStream in = new FileInputStream(sourceFile);
  103. while ((len = in.read(buf)) != -1){
  104. zos.write(buf, 0, len);
  105. }
  106. // Complete the entry
  107. zos.closeEntry();
  108. in.close();
  109. } else {
  110. File[] listFiles = sourceFile.listFiles();
  111. if(listFiles == null || listFiles.length == 0){
  112. // 需要保留原来的文件结构时,需要对空文件夹进行处理
  113. if(KeepDirStructure){
  114. // 空文件夹的处理
  115. zos.putNextEntry(new ZipEntry(name + "/"));
  116. // 没有文件,不需要文件的copy
  117. zos.closeEntry();
  118. }
  119. }else {
  120. for (File file : listFiles) {
  121. // 判断是否需要保留原来的文件结构
  122. if (KeepDirStructure) {
  123. // 注意:file.getName()前面需要带上父文件夹的名字加一斜杠,
  124. // 不然最后压缩包中就不能保留原来的文件结构,即:所有文件都跑到压缩包根目录下了
  125. compress(file, zos, name + "/" + file.getName(),KeepDirStructure);
  126. } else {
  127. compress(file, zos, file.getName(),KeepDirStructure);
  128. }
  129. }
  130. }
  131. }
  132. }
  133. public static void main(String[] args) throws Exception {
  134. /** 测试压缩方法1 */
  135. FileOutputStream fos1 = new FileOutputStream(new File("c:/mytest01.zip"));
  136. ZipUtils.toZip("D:/log", fos1,true);
  137. /** 测试压缩方法2 */
  138. List<File> fileList = new ArrayList<>();
  139. fileList.add(new File("D:/Java/jdk1.7.0_45_64bit/bin/jar.exe"));
  140. fileList.add(new File("D:/Java/jdk1.7.0_45_64bit/bin/java.exe"));
  141. FileOutputStream fos2 = new FileOutputStream(new File("c:/mytest02.zip"));
  142. ZipUtils.toZip(fileList, fos2);
  143. }
  144. }


二、注意事项

    写该工具类时,有些注意事项说一下:
        (1)支持选择是否保留原来的文件目录结构,如果不保留,那么空文件夹直接不用处理。
        (1)碰到空文件夹时,如果需要保留目录结构,则直接添加个ZipEntry就可以了,不过就是这个entry的名字后面需要带上一斜杠(/)表示这个是目录。
        (2)递归时,不需要把zip输出流关闭,zip输出流的关闭应该是在调用完递归方法后面关闭
        (3)递归时,如果是个文件夹且需要保留目录结构,那么在调用方法压缩他的子文件时,需要把文件夹的名字加一斜杠给添加到子文件名字前面,这样压缩后才有多级目录。

三、如何在javaWeb项目中使用该工具类

    这个工具类在web项目中的使用场景就是多文件下载,我就简单说个下载多个excel表格的案例吧。
    代码中的步骤为:
        (1)创建一个临时文件夹
        (2)将要下载的文件生成至该临时文件夹内
        (3)当所有文件生成完后,获取HttpServletResponse获取设置下载的header
        (4)调用工具类的方法,传入上面生成的临时文件夹路径及response获取的输出流;这样就下载出来zip包了
        (5)递归删除掉上面生成的临时文件夹和文件

    下面为一个示例代码的代码片段,不是完整代码,简单看一下代码中的步骤
  1. if(userList.size() > 0){
  2. /** 下面为下载zip压缩包相关流程 */
  3. HttpServletRequest request = ServletActionContext.getRequest();
  4. FileWriter writer;
  5. /** 1.创建临时文件夹 */
  6. String rootPath = request.getSession().getServletContext().getRealPath("/");
  7. File temDir = new File(rootPath + "/" + UUID.randomUUID().toString().replaceAll("-", ""));
  8. if(!temDir.exists()){
  9. temDir.mkdirs();
  10. }
  11. /** 2.生成需要下载的文件,存放在临时文件夹内 */
  12. // 这里我们直接来10个内容相同的文件为例,但这个10个文件名不可以相同
  13. for (int i = 0; i < 10; i++) {
  14. dataMap.put("userList", userList);
  15. Map<String, String> endMap = new HashMap<>();
  16. endMap.put("user", "老王");
  17. endMap.put("time", "2017-10-10 10:50:55");
  18. dataMap.put("endMap", endMap);
  19. Configuration cfg = new Configuration(Configuration.VERSION_2_3_22);
  20. cfg.setServletContextForTemplateLoading(ServletActionContext.getServletContext(), "/ftl");
  21. Template template = cfg.getTemplate("exportExcel.ftl");
  22. writer = new FileWriter(temDir.getPath()+"/excel"+ i +".xls");
  23. template.process(dataMap, writer);
  24. writer.flush();
  25. writer.close();
  26. }
  27. /** 3.设置response的header */
  28. HttpServletResponse response = ServletActionContext.getResponse();
  29. response.setContentType("application/zip");
  30. response.setHeader("Content-Disposition", "attachment; filename=excel.zip");
  31. /** 4.调用工具类,下载zip压缩包 */
  32. // 这里我们不需要保留目录结构
  33. ZipUtils.toZip(temDir.getPath(), response.getOutputStream(),false);
  34. /** 5.删除临时文件和文件夹 */
  35. // 这里我没写递归,直接就这样删除了
  36. File[] listFiles = temDir.listFiles();
  37. for (int i = 0; i < listFiles.length; i++) {
  38. listFiles[i].delete();
  39. }
  40. temDir.delete();
  41. }
阅读更多

没有更多推荐了,返回首页