重构Java压缩工具类ZipUtils

最新推荐文章于 2024-03-11 10:30:16 发布
最新推荐文章于 2024-03-11 10:30:16 发布
阅读量3.6k 收藏 5
点赞数 2
分类专栏： A_Java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/ylchou/article/details/79620058
版权

网上copy了一段Zip压缩文件的代码，问题有点多。现在重构一下。主要修改如下几方面：

  1. 增加私有构造函数
  2. System.out.println输出日志变为LOGGER.info输出
  3. 去掉运行时异常
  4. 超过3个if/for/while的代码控制在3个及以内
  5. 使用JDK7 try-with-resources，省去手动关闭资源和精简代码
  6. 单行注释用//，而不是/*/
  7. 使用JDK7菱形语法，及代码List fileList = new ArrayList();变为List fileList = new ArrayList<>();

重构前：

package com.ylchou.utlis;

import java.io.*;
import java.util.ArrayList;
import java.util.List;
import java.util.zip.ZipEntry;
import java.util.zip.ZipOutputStream;

/**
 * Created by ylchou on 18/3/19.
 */
public class ZipUtils {
    private static final int  BUFFER_SIZE = 2 * 1024;

    /**
     * 压缩成ZIP 方法1
     * @param srcDir 压缩文件夹路径
     * @param out    压缩文件输出流
     * @param KeepDirStructure  是否保留原来的目录结构,true:保留目录结构;
     *                          false:所有文件跑到压缩包根目录下(注意：不保留目录结构可能会出现同名文件,会压缩失败)
     * @throws RuntimeException 压缩失败会抛出运行时异常
     */
    public static void toZip(String srcDir, OutputStream out, boolean KeepDirStructure)
            throws RuntimeException{

        long start = System.currentTimeMillis();
        ZipOutputStream zos = null ;
        try {
            zos = new ZipOutputStream(out);
            File sourceFile = new File(srcDir);
            compress(sourceFile,zos,sourceFile.getName(),KeepDirStructure);
            long end = System.currentTimeMillis();
            System.out.println("压缩完成，耗时：" + (end - start) +" ms");
        } catch (Exception e) {
            throw new RuntimeException("zip error from ZipUtils",e);
        }finally{
            if(zos != null){
                try {
                    zos.close();
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
        }
    }

    /**
     * 压缩成ZIP 方法2
     * @param srcFiles 需要压缩的文件列表
     * @param out           压缩文件输出流
     * @throws RuntimeException 压缩失败会抛出运行时异常
     */
    public static void toZip(List<File> srcFiles , OutputStream out)throws RuntimeException {
        long start = System.currentTimeMillis();
        ZipOutputStream zos = null ;
        try {
            zos = new ZipOutputStream(out);
            for (File srcFile : srcFiles) {
                byte[] buf = new byte[BUFFER_SIZE];
                zos.putNextEntry(new ZipEntry(srcFile.getName()));
                int len;
                FileInputStream in = new FileInputStream(srcFile);
                while ((len = in.read(buf)) != -1){
                    zos.write(buf, 0, len);
                }
                zos.closeEntry();
                in.close();
            }
            long end = System.currentTimeMillis();
            System.out.println("压缩完成，耗时：" + (end - start) +" ms");
        } catch (Exception e) {
            throw new RuntimeException("zip error from ZipUtils",e);
        }finally{
            if(zos != null){
                try {
                    zos.close();
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
        }
    }


    /**
     * 递归压缩方法
     * @param sourceFile 源文件
     * @param zos        zip输出流
     * @param name       压缩后的名称
     * @param KeepDirStructure  是否保留原来的目录结构,true:保留目录结构;
     *                          false:所有文件跑到压缩包根目录下(注意：不保留目录结构可能会出现同名文件,会压缩失败)
     * @throws Exception
     */
    private static void compress(File sourceFile, ZipOutputStream zos, String name,
                                 boolean KeepDirStructure) throws Exception{
        byte[] buf = new byte[BUFFER_SIZE];
        if(sourceFile.isFile()){
            // 向zip输出流中添加一个zip实体，构造器中name为zip实体的文件的名字
            zos.putNextEntry(new ZipEntry(name));
            // copy文件到zip输出流中
            int len;
            FileInputStream in = new FileInputStream(sourceFile);
            while ((len = in.read(buf)) != -1){
                zos.write(buf, 0, len);
            }
            // Complete the entry
            zos.closeEntry();
            in.close();
        } else {
            File[] listFiles = sourceFile.listFiles();
            if(listFiles == null || listFiles.length == 0){
                // 需要保留原来的文件结构时,需要对空文件夹进行处理
                if(KeepDirStructure){
                    // 空文件夹的处理
                    zos.putNextEntry(new ZipEntry(name + "/"));
                    // 没有文件，不需要文件的copy
                    zos.closeEntry();
                }

            }else {
                for (File file : listFiles) {
                    // 判断是否需要保留原来的文件结构
                    if (KeepDirStructure) {
                        // 注意：file.getName()前面需要带上父文件夹的名字加一斜杠,
                        // 不然最后压缩包中就不能保留原来的文件结构,即：所有文件都跑到压缩包根目录下了
                        compress(file, zos, name + "/" + file.getName(),KeepDirStructure);
                    } else {
                        compress(file, zos, file.getName(),KeepDirStructure);
                    }

                }
            }
        }
    }

    public static void main(String[] args) throws Exception {
        /** 测试压缩方法1  */
        FileOutputStream fos1 = new FileOutputStream(new File("/Users/ylchou/Downloads/mytest02.zip"));
        ZipUtils.toZip("/Users/ylchou/Downloads/mail_test", fos1,true);

        /** 测试压缩方法2  */
        List<File> fileList = new ArrayList<File>();
        fileList.add(new File("/Users/ylchou/Downloads/mail_test/aaaa.txt"));
        fileList.add(new File("/Users/ylchou/Downloads/mail_test/jdk7u80.txt"));
        FileOutputStream fos2 = new FileOutputStream(new File("/Users/ylchou/Downloads/mytest03.zip"));
        ZipUtils.toZip(fileList, fos2);
    }
}

重构后：

package com.ylchou.utlis;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.*;
import java.util.ArrayList;
import java.util.List;
import java.util.zip.ZipEntry;
import java.util.zip.ZipOutputStream;

/**
 * 压缩工具类
 * Created by ylchou on 18/3/19.
 */
public class ZipUtils {
    private static final Logger LOGGER = LoggerFactory.getLogger(ZipUtils.class);
    private static final int BUFFER_SIZE = 2 * 1024;

    private ZipUtils(){
    }

    /**
     * 压缩成ZIP 方法1
     * @param srcDir 压缩文件夹路径
     * @param out    压缩文件输出流
     * @param keepDirStructure  是否保留原来的目录结构,true:保留目录结构;
     *                          false:所有文件跑到压缩包根目录下(注意：不保留目录结构可能会出现同名文件,会压缩失败)
     */
    public static void toZip(String srcDir, OutputStream out, boolean keepDirStructure){
        long start = System.currentTimeMillis();
        try (ZipOutputStream zos = new ZipOutputStream(out))
        {
            File sourceFile = new File(srcDir);
            compress(sourceFile,zos,sourceFile.getName(),keepDirStructure);
            long end = System.currentTimeMillis();
            LOGGER.info("压缩完成，耗时：" + (end - start) +" ms");
        } catch (Exception e) {
            LOGGER.info("zip error from ZipUtils",e);
        }
    }

    /**
     * 压缩成ZIP 方法2
     * @param srcFiles 需要压缩的文件列表
     * @param out           压缩文件输出流
     */
    public static void toZip(List<File> srcFiles , OutputStream out){
        long start = System.currentTimeMillis();
        try (ZipOutputStream zos = new ZipOutputStream(out);) {
            for (File srcFile : srcFiles) {
                byte[] buf = new byte[BUFFER_SIZE];
                zos.putNextEntry(new ZipEntry(srcFile.getName()));
                int len;
                FileInputStream in = new FileInputStream(srcFile);
                while ((len = in.read(buf)) != -1){
                    zos.write(buf, 0, len);
                }
                zos.closeEntry();
                in.close();
            }
            long end = System.currentTimeMillis();
            LOGGER.info("压缩完成，耗时：" + (end - start) +" ms");
        } catch (Exception e) {
            LOGGER.info("zip error from ZipUtils",e);
        }
    }


    /**
     * 递归压缩方法
     * @param sourceFile 源文件
     * @param zos        zip输出流
     * @param name       压缩后的名称
     * @param keepDirStructure  是否保留原来的目录结构,true:保留目录结构;
     *                          false:所有文件跑到压缩包根目录下(注意：不保留目录结构可能会出现同名文件,会压缩失败)
     * @throws Exception
     */
    private static void compress(File sourceFile, ZipOutputStream zos, String name,
                                 boolean keepDirStructure) throws Exception{
        if(sourceFile.isFile()){//文件
            byte[] buf = new byte[BUFFER_SIZE];
            // 向zip输出流中添加一个zip实体，构造器中name为zip实体的文件的名字
            zos.putNextEntry(new ZipEntry(name));
            // copy文件到zip输出流中
            int len;
            FileInputStream in = new FileInputStream(sourceFile);
            while ((len = in.read(buf)) != -1){
                zos.write(buf, 0, len);
            }
            // Complete the entry
            zos.closeEntry();
            in.close();
            return;
        }
        //目录
        File[] listFiles = sourceFile.listFiles();
        if(listFiles == null || listFiles.length == 0){//空目录
            // 需要保留原来的文件结构时,需要对空文件夹进行处理
            if(keepDirStructure){
                // 空文件夹的处理
                zos.putNextEntry(new ZipEntry(name + "/"));
                // 没有文件，不需要文件的copy
                zos.closeEntry();
            }
        }else {//非空目录
            for (File file : listFiles) {
                // 判断是否需要保留原来的文件结构
                if (keepDirStructure) {
                    // 注意：file.getName()前面需要带上父文件夹的名字加一斜杠,
                    // 不然最后压缩包中就不能保留原来的文件结构,即：所有文件都跑到压缩包根目录下了
                    compress(file, zos, name + "/" + file.getName(),keepDirStructure);
                } else {
                    compress(file, zos, file.getName(),keepDirStructure);
                }
            }
        }
    }

    public static void main(String[] args) throws Exception {
        //测试压缩方法1
        FileOutputStream fos1 = new FileOutputStream(new File("/Users/ylchou/Downloads/mytest02.zip"));
        ZipUtils.toZip("/Users/ylchou/Downloads/mail_test", fos1,true);

        //测试压缩方法2
        List<File> fileList = new ArrayList<>();
        fileList.add(new File("/Users/ylchou/Downloads/mail_test/aaaa.txt"));
        fileList.add(new File("/Users/ylchou/Downloads/mail_test/jdk7u80.txt"));
        FileOutputStream fos2 = new FileOutputStream(new File("/Users/ylchou/Downloads/mytest03.zip"));
        ZipUtils.toZip(fileList, fos2);
    }
}

pom文件：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.ylchou</groupId>
    <artifactId>private-tools</artifactId>
    <version>1.0</version>

    <dependencies>
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>1.2.6</version>
        </dependency>
        <dependency>
            <groupId>org.apache.httpcomponents</groupId>
            <artifactId>httpclient</artifactId>
            <version>4.5.2</version>
        </dependency>
        <dependency>
            <groupId>org.apache.httpcomponents</groupId>
            <artifactId>httpmime</artifactId>
            <version>4.5.2</version>
        </dependency>

        <!-- log start -->
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
            <version>${slf4j.version}</version>
        </dependency>
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-core</artifactId>
            <version>${log4j2.version}</version>
        </dependency>
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-api</artifactId>
            <version>${log4j2.version}</version>
        </dependency>
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-slf4j-impl</artifactId>
            <version>${log4j2.version}</version>
        </dependency>

        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-web</artifactId>
            <version>${log4j2.version}</version>
        </dependency>

        <!-- adapter log4j -->
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>log4j-over-slf4j</artifactId>
            <version>1.7.12</version>
        </dependency>
        <!-- adapter commons-logging -->
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>jcl-over-slf4j</artifactId>
            <version>1.7.12</version>
        </dependency>
        <!-- log end -->

    </dependencies>

    <properties>
        <log4j2.version>2.4.1</log4j2.version>
        <slf4j.version>1.7.12</slf4j.version>
    </properties>

</project>

结果如下：
这里写图片描述

这里写图片描述

深思千年
关注
  • 2
    点赞
  • 踩
  • 5
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
java压缩文件工具类
09-13
工具类中提供的方法有：压缩单个文件，压缩多个文件，解压文件到制定路径下。获取压缩文件的文件列表。压缩文件的文件注释。
java 压缩zip文件工具类
丶自定义
02-15 1703
 文件压缩成一个zip包 代码： import java.io.File; import java.io.FileInputStream; import java.io.IOException; import java.io.OutputStream; import java.util.List; import java.util.zip.ZipEntry; import java.util...
Java实现解压zip压缩包(支持多层级)
总结分享
03-11 1088
最常见的压缩文件格式之一，可以存储一个或多个文件，并可在不同的操作系统中进行解压缩。
JAVA压缩工具类
weixin_43972670的博客
05-12 373
** 压缩单个文件夹 *//** 压缩多个文件夹 *//** 压缩多个文件 */
java操作压缩包工具类
sl4379的博客
06-20 387
package com.rquest.riskmaster.util;import java.io.BufferedWriter;import java.io.File;import java.io.FileInputStream;import java.io.FileNotFoundException;import java.io.FileOutputStream;import java.io....
java代码重构系统1
08-08
1.3使用工具本项目基于Antlr4进行代码重构，ANTLR—Another Tool for Language Recognition，其前身是PCCTS，它
Java重构示例一.docx
03-06
重构就是通过调整程序代码改善软件的质量、性能，使其程序的设计模式和架构更趋合理，提高软件的扩展性和维护性，系统发展到一定阶段后，使用重构的方式，不改变系统的外部功能，只对内部的结构进行重新的整理。...
压缩感知图像重构算法工具包
03-29
本工具箱包含常用的压缩感知图像重构算法，如OMP,BP,IHT,等算法，非常齐全。
java实现对图片的压缩上传
09-23
该工具类可以实现以下几个功能 1、得到有效文件的长度（即大小），以字节表示 getFileSize(String filePath)，需要传入文件路径 2、可以上传图片与非图片文件。有二个重构方法 一、无限制文件大小上传upLoad(String...
OMP_OMP算法_压缩感知重构_
10-02
文档是压缩感知重构算法中的一种经典重构算法——正交匹配追踪算法，包括测试程序。
使用 Java 实现的压缩/解压 ZIP 文件的工具类
12-05
使用 Java 语言实现并封装的创建 ZIP 格式的压缩文件并解压到指定目录和解压 ZIP 文件到指定目录的工具类。
Java工具类ZIP解压缩
11-05
Java工具类ZIP解压缩Java工具类ZIP解压缩Java工具类ZIP解压缩
重构 modifyCode.rar
03-21
NULL 博文链接：https://czjxdm.iteye.com/blog/963704
Java生成压缩文件工具类
code_now的博客
01-12 548
文件压缩功能在日常项目中经常会使用到，例如文件太多，需要发送给用户，这时就需要将多个文件压缩成一个压缩包，然后再通过邮件或其它方式发送给用户；在这里给大家提供一种文件压缩工具类，并附带测试代码。
Java压缩、解压工具类
tianhongfan10106的专栏
06-09 236
【代码】Java压缩、解压工具类。
java文件压缩工具类，打包zip
csdn952762369的博客
03-25 916
最近工作中需要生成指定的多层文件目录，然后把文件压缩打包下载，当时对这方面的知识并不熟悉，所以花了大量时间来调试程序，目前处理好了mark以下，以方便自己以后查看，直接上代码了: 这是工作中用到的zip打包工具类 import java.io.*; import java.util.zip.ZipEntry; import java.util.zip.ZipOutputStream; pu...
基于VB实现的商场管理系统设计(源代码+系统).zip
05-04
【作品名称】：基于VB实现的商场管理系统设计(源代码+系统) 【适用人群】：适用于希望学习不同技术领域的小白或进阶学习者。可作为毕设项目、课程设计、大作业、工程实训或初期项目立项。
数据更新至2020年主要发电企业火电机组分容量等级发电装机容量情况.xls
最新发布
05-05
数据来源：中国电力统计NJ-2021版
根据上述需要重构这个工具类
05-31
好的，针对同时包含 XLSX 格式和 XLS 格式的 Excel 文件进行处理，可以考虑重构一个工具类，具体如下： ```python import os import xlrd import xlwt from openpyxl import load_workbook class ExcelUtil: @...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值