[Java]-zip包的使用

Pacifica_

已于 2022-05-12 20:39:51 修改

阅读量1.5k

点赞数 4

文章标签： java

于 2022-03-20 17:15:04 首次发布

本文链接：https://blog.csdn.net/Pacifica_/article/details/123582972

版权

前言

java.util.zip包提供了一系列用于在Java程序中对ZIP文件进行部分操作的API，例如读取，生成ZIP文件等。本文对相关内容进行简单学习

主要的类

在文档中可以看到四个主要的类，分别为ZipEntry，ZipFile，ZipInputStream，ZipOutputStream
ZipFile对应一个.zip文件。无需使用到ZipFile类中提供的针对ZIP文件的API时，也可以直接使用File类创建对应ZIP文件的对象。而如果要使用 ZipFile 实例对象的话，其不能指向一个不存在的 zip 文件；不能指向一个存在但调用 length() 方法返回值为 0 的文件；不能指向一个不是 zip 文件的文件 (后缀名不为 .zip)
ZipEntry对应.zip文件中每一个文件条目
ZipInputStream以及ZipOutputStream分别是以ZIP文件格式读取以及写入文件的输入输出流

对zip文件解压

假设项目的当前目录下有一个名为tmp.zip的zip文件需要解压
首先创建一个ZipFile对象

String zipFileName = "tmp.zip";
ZipFile zipFile = new ZipFile(zipFileName);

获取压缩包中的每一个文件条目，可以通过ZipFile类中的Enumeration<? extends ZipEntry> entries()方法，返回所有文件条目的枚举。如果需要对压缩包内的文件先进行一次过滤，可以使用Stream<? extends ZipEntry> stream()返回包中所有文件条目构成的stream流，配合stream API对文件条目进行过滤等操作后，再调用toArray()方法得到文件条目数组

Stream<? extends ZipEntry> stream = zipFile.stream()
        .filter(zipEntry -> targetName.equals(zipEntry.getName()));
Object[] objects = stream.toArray();

得到压缩包内的文件条目后就是读取条目ZipEntry内的内容了。使用ZipFile类的InputStream getInputStream(ZipEntry entry)可以返回用于读取指定ZIP文件条目内容的输入流。然后可以创建一个与所读取ZipEntry条目同名的文件 (使用ZipEntry类的getName()方法可以返回该文件条目的文件名) 作为输出流，然后将输入流中的内容读入

zipEntry = (ZipEntry) objects[0];
inputStream = zipFile.getInputStream(zipEntry);
fileOutputStream = new FileOutputStream(zipEntry.getName());
int count;
while ((count = inputStream.read()) != -1){
    fileOutputStream.write(count);
}

这样的解压并不是真的把zip压缩包解压得到其中的所有文件条目，而是读取压缩包内的每个文件，复制到压缩包外

压缩文件得到zip文件

假设当前项目目录下有一个tmp.index文件需要压缩得到tmp.zip文件
既然要得到ZIP文件，就需要一个输出流关联到所需的ZIP文件中，压缩文件条目时需要ZipOutputStream类中提供的部分API，所以不能直接使用FileOutputStream来关联zip文件，需要使用ZipOutputStream类，而ZipOutputStream提供的构造函数需要一个OutputStream对象：
在这里插入图片描述
所以需要先用FileOutputStream打开zip文件的输出流，再通过这个流来构造相应的ZipOutputStream
构建出ZipOutputStream后，接下来就是读取需要添加到压缩包内的文件了，使用putNextEntry(ZipEntry e)可以开始编写新的zip文件条目，并将流定位到条目数据的开头

//不需要ZipFile类的API，使用普通的File类即可
File zipFile = new File("tmp.zip");
if(!zip.exists()){
	zipFile.createNewFile();
}
try(FileOutputStream fos = new FileOutputStream(zipFile);ZipOutputStream zos = new ZipOutputStream(fos)){
    File indexFile = new File("tmp.index");
    if(indexFile.exists()){
    try (FileInputStream fis = new FileInputStream(file)) {
        zos.putNextEntry(new ZipEntry(entryName));
        int read;
        while ((read = fis.read()) != -1) {
            zos.write(read);
        }
        zos.flush();
    }
}

注意的问题

最重要的，涉及到输入输出流的操作都要记得 close 关闭流
同一个 zip 文件中两个不同的 entry 不能有相同的 entryName，否则在调用 putNewEntry() 方法放入第二个 entry 的时候会报 duplicate entry 的异常
以上仅限于将要压缩的文件压缩到一个不存在的新创建的 zip 文件中，如果是打开一个已存在的 zip 文件往里面添加文件的话，会把 zip 文件中原有的内容覆盖掉。如何往已存在的 zip 文件中追加新文件见下文

往已存在的zip中添加新文件

将已存在的 zip 文件重命名得到一个文件 tmp，然后新建一个文件 final 作为最终要得到的 zip 文件，将他命名为已存在的 zip 文件的原先的名字
将 tmp 中的条目 (ZipEntry) 遍历添加到 final 中，然后再往 final 中继续添加新的条目

下面先给出跑得通的代码：

public static void zipFile(File targetZipFile,File toBeZippedFile,String entryName){
    boolean fileExist = toBeZippedFile.exists();
    if(!file1Exist){ //文件存在才继续后续的步骤，不然开了句柄也会浪费资源
        return;
    }
    FileOutputStream finalZipFileFos = null;
    ZipOutputStream finalZipFileZos = null;
    try{
        if(targetZipFile.length() > 0){ //原文件中有内容要先拷贝出来
            String targetZipFilePath = targetZipFile.getPath();
            String tmpOriginZipFilePath = targetZipFilePath.substring(0, targetZipFilePath.lastIndexOf('.'))
                    + "_tmp_"
                    + ".zip";
            File tmpOriginFile = new File(tmpOriginZipFilePath);
            //以下的renameFile() 方法会使用targetZipFile去调用 renameTo() 方法，参数为tmpOriginFile
            renameFile(targetZipFile, tmpOriginFile);
            //rename之后targetZipFilePath “所指向的文件”就不存在了，重新创建
            File finalZipFile = createFileIfNotExist(targetZipFilePath);
            finalZipFileFos = new FileOutputStream(finalZipFile);
            finalZipFileZos = new ZipOutputStream(finalZipFileFos);
            //接下来是拷贝tmpOriginFile中的内容到finalZipFile中
            ZipFile tmpOriginZip = new ZipFile(tmpOriginFile);
            Enumeration<? extends ZipEntry> entries = tmpOriginZip.entries();
            //枚举每一个entry
            while(entries.hasMoreElements()){
                ZipEntry zipEntry = entries.nextElement();
                //！！！重点来了，这里必须是 new ZipEntry(zipEntry.getName()) 这么写，本人在修改的时候就是因为这里浪费了很多时间
                finalZipFileZos.putNextEntry(new ZipEntry(zipEntry.getName()));
                try(InputStream inputStream = tmpOriginZip.getInputStream(zipEntry)){
                    int read;
                    while ((read = inputStream.read()) != -1){
                        finalZipFileZos.write(read);
                    }
                }
                finalZipFileZos.flush();
            }
            tmpOriginZip.close();
            tmpOriginFile.delete(); //删除 zip 文件前，要把关联的 ZipFile 对象先调用 close() 方法关闭才能删除
        }else{ //如果原zip文件中没有内容，那就直接往里面压缩要压缩的文件就可以了
            finalZipFileFos = new FileOutputStream(targetZipFile);
            finalZipFileZos = new ZipOutputStream(finalZipFileFos);
        }
        zipOneFile(finalZipFileZos,toBeZippedFile,entryName);
    }finally {
        if(finalZipFileZos != null){
            finalZipFileZos.close();
        }
        if(finalZipFileFos != null){
            finalZipFileFos.close();
        }
    }
}

注意的问题

renamrTo() 之后被重命名的文件句柄不会指向重命名后的文件，不能错误地以为只是文件单纯改了个名字而句柄还是指向原来的文件
一个 File 对象跟其调用 getAbsoluteFile() 得到的 File 对象是不一样的，一个是抽象路径，即以 src 所在目录为根目录；而一个是绝对路径，即以计算机文件系统中的绝对路径为准
一般的 File::getPath() 返回的是以src所在目录为根目录的文件路径，而 File::getAbsolutePath() 方法返回的就是系统中的绝对路径
deleteOnExist() 不能根据方法名认为其是当文件存在就删除，它是等虚拟机终止时才会被删除。文档说的是：在虚拟机终止时，请求删除此抽象路径名表示的文件或目录
zip 文件刚创建的时候调用 length() 方法返回的是 0，但如果用 Stream 打开它再关闭后，其再调用 length() 就不为 0 了；这时虽然其中确实没有内容但 length() 不为 0，所以用其实例化一个 ZipFile 对象指向它 (并调用其它相关方法) 是没有问题的。总而言之就是只要 zip 文件对应的 File 类对象调用 length() 返回值大于 0，就可以实例化 ZipFile 对象指向它

关于重命名 renameTo() 方法

除了前面提到的句柄失效，renameTo() 还有以下注意点
文件句柄还在的话，即文件关联着 stream 且 stream 还未关闭，那么是无法rename成功的

public void testtttttttt() throws Exception{
    File file = FileUtils.createFileIfNotExist("test.zip");
    File dest = new File("test_tmp_.zip");
    System.out.println(file.exists());
    System.out.println(dest.exists());
    file.renameTo(dest);
    System.out.println(file.exists());
    System.out.println(dest.exists());
}

输出结果为：

true
false
false
true

设置压缩级别

ZipOutputStream 类对象可以调用 setLevel() 方法来设置压缩级别，不设置的话默认是 Deflater::DEFAULT_COMPRESSION，数值来自 Deflater 类。可以设置的数为 0-9，压缩级别越高，耗时越久，但是压缩效果越好
项目开发中有需求说几w条数据压缩时不超过几秒的话，就可以通过调整压缩级别来做尝试