工具类之ZipUtils

作者: Blankj | 来源:发表于2016-09-12 20:56 被阅读1391次

    这个工具类撸了好多天,今天完整测试完毕,比较满意,具体测试可以参考这里,话不多说,直接开车上方法列表和代码,嘟嘟嘟嘟。。。

    zipFiles           : 批量压缩文件
    zipFile            : 压缩文件
    unzipFiles         : 批量解压文件
    unzipFile          : 解压文件
    unzipFileByKeyword : 解压带有关键字的文件
    getFilesPath       : 获取压缩文件中的文件路径链表
    getComments        : 获取压缩文件中的注释链表
    getEntries         : 获取压缩文件中的文件对象
    

    import java.io.BufferedInputStream;
    import java.io.BufferedOutputStream;
    import java.io.File;
    import java.io.FileInputStream;
    import java.io.FileOutputStream;
    import java.io.IOException;
    import java.io.InputStream;
    import java.io.OutputStream;
    import java.util.ArrayList;
    import java.util.Collection;
    import java.util.Enumeration;
    import java.util.List;
    import java.util.zip.ZipEntry;
    import java.util.zip.ZipFile;
    import java.util.zip.ZipOutputStream;
    
    import static com.blankj.utilcode.utils.ConstUtils.KB;
    
    /**
     * <pre>
     *     author: Blankj
     *     blog  : http://blankj.com
     *     time  : 2016/8/27
     *     desc  : 压缩相关工具类
     * </pre>
     */
    public class ZipUtils {
    
        private ZipUtils() {
            throw new UnsupportedOperationException("u can't instantiate me...");
        }
    
        /**
         * 批量压缩文件
         *
         * @param resFiles    待压缩文件集合
         * @param zipFilePath 压缩文件路径
         * @return {@code true}: 压缩成功<br>{@code false}: 压缩失败
         * @throws IOException IO错误时抛出
         */
        public static boolean zipFiles(Collection<File> resFiles, String zipFilePath)
                throws IOException {
            return zipFiles(resFiles, zipFilePath, null);
        }
    
        /**
         * 批量压缩文件
         *
         * @param resFiles    待压缩文件集合
         * @param zipFilePath 压缩文件路径
         * @param comment     压缩文件的注释
         * @return {@code true}: 压缩成功<br>{@code false}: 压缩失败
         * @throws IOException IO错误时抛出
         */
        public static boolean zipFiles(Collection<File> resFiles, String zipFilePath, String comment)
                throws IOException {
            return zipFiles(resFiles, FileUtils.getFileByPath(zipFilePath), comment);
        }
    
        /**
         * 批量压缩文件
         *
         * @param resFiles 待压缩文件集合
         * @param zipFile  压缩文件
         * @return {@code true}: 压缩成功<br>{@code false}: 压缩失败
         * @throws IOException IO错误时抛出
         */
        public static boolean zipFiles(Collection<File> resFiles, File zipFile)
                throws IOException {
            return zipFiles(resFiles, zipFile, null);
        }
    
        /**
         * 批量压缩文件
         *
         * @param resFiles 待压缩文件集合
         * @param zipFile  压缩文件
         * @param comment  压缩文件的注释
         * @return {@code true}: 压缩成功<br>{@code false}: 压缩失败
         * @throws IOException IO错误时抛出
         */
        public static boolean zipFiles(Collection<File> resFiles, File zipFile, String comment)
                throws IOException {
            if (resFiles == null || zipFile == null) return false;
            ZipOutputStream zos = null;
            try {
                zos = new ZipOutputStream(new FileOutputStream(zipFile));
                for (File resFile : resFiles) {
                    if (!zipFile(resFile, "", zos, comment)) return false;
                }
                return true;
            } finally {
                if (zos != null) {
                    zos.finish();
                    FileUtils.closeIO(zos);
                }
            }
        }
    
        /**
         * 压缩文件
         *
         * @param resFilePath 待压缩文件路径
         * @param zipFilePath 压缩文件路径
         * @return {@code true}: 压缩成功<br>{@code false}: 压缩失败
         * @throws IOException IO错误时抛出
         */
        public static boolean zipFile(String resFilePath, String zipFilePath)
                throws IOException {
            return zipFile(resFilePath, zipFilePath, null);
        }
    
        /**
         * 压缩文件
         *
         * @param resFilePath 待压缩文件路径
         * @param zipFilePath 压缩文件路径
         * @param comment     压缩文件的注释
         * @return {@code true}: 压缩成功<br>{@code false}: 压缩失败
         * @throws IOException IO错误时抛出
         */
        public static boolean zipFile(String resFilePath, String zipFilePath, String comment)
                throws IOException {
            return zipFile(FileUtils.getFileByPath(resFilePath), FileUtils.getFileByPath(zipFilePath), comment);
        }
    
        /**
         * 压缩文件
         *
         * @param resFile 待压缩文件
         * @param zipFile 压缩文件
         * @return {@code true}: 压缩成功<br>{@code false}: 压缩失败
         * @throws IOException IO错误时抛出
         */
        public static boolean zipFile(File resFile, File zipFile)
                throws IOException {
            return zipFile(resFile, zipFile, null);
        }
    
        /**
         * 压缩文件
         *
         * @param resFile 待压缩文件
         * @param zipFile 压缩文件
         * @param comment 压缩文件的注释
         * @return {@code true}: 压缩成功<br>{@code false}: 压缩失败
         * @throws IOException IO错误时抛出
         */
        public static boolean zipFile(File resFile, File zipFile, String comment)
                throws IOException {
            if (resFile == null || zipFile == null) return false;
            ZipOutputStream zos = null;
            try {
                zos = new ZipOutputStream(new FileOutputStream(zipFile));
                return zipFile(resFile, "", zos, comment);
            } finally {
                if (zos != null) {
                    FileUtils.closeIO(zos);
                }
            }
        }
    
        /**
         * 压缩文件
         *
         * @param resFile  待压缩文件
         * @param rootPath 相对于压缩文件的路径
         * @param zos      压缩文件输出流
         * @param comment  压缩文件的注释
         * @return {@code true}: 压缩成功<br>{@code false}: 压缩失败
         * @throws IOException IO错误时抛出
         */
        private static boolean zipFile(File resFile, String rootPath, ZipOutputStream zos, String comment)
                throws IOException {
            rootPath = rootPath + (StringUtils.isSpace(rootPath) ? "" : File.separator) + resFile.getName();
            if (resFile.isDirectory()) {
                File[] fileList = resFile.listFiles();
                // 如果是空文件夹那么创建它,我把'/'换为File.separator测试就不成功,eggPain
                if (fileList == null || fileList.length <= 0) {
                    ZipEntry entry = new ZipEntry(rootPath + '/');
                    if (!StringUtils.isEmpty(comment)) entry.setComment(comment);
                    zos.putNextEntry(entry);
                    zos.closeEntry();
                } else {
                    for (File file : fileList) {
                        // 如果递归返回false则返回false
                        if (!zipFile(file, rootPath, zos, comment)) return false;
                    }
                }
            } else {
                InputStream is = null;
                try {
                    is = new BufferedInputStream(new FileInputStream(resFile));
                    ZipEntry entry = new ZipEntry(rootPath);
                    if (!StringUtils.isEmpty(comment)) entry.setComment(comment);
                    zos.putNextEntry(entry);
                    byte buffer[] = new byte[KB];
                    int len;
                    while ((len = is.read(buffer, 0, KB)) != -1) {
                        zos.write(buffer, 0, len);
                    }
                    zos.closeEntry();
                } finally {
                    FileUtils.closeIO(is);
                }
            }
            return true;
        }
    
        /**
         * 批量解压文件
         *
         * @param zipFiles    压缩文件集合
         * @param destDirPath 目标目录路径
         * @return {@code true}: 解压成功<br>{@code false}: 解压失败
         * @throws IOException IO错误时抛出
         */
        public static boolean unzipFiles(Collection<File> zipFiles, String destDirPath)
                throws IOException {
            return unzipFiles(zipFiles, FileUtils.getFileByPath(destDirPath));
        }
    
        /**
         * 批量解压文件
         *
         * @param zipFiles 压缩文件集合
         * @param destDir  目标目录
         * @return {@code true}: 解压成功<br>{@code false}: 解压失败
         * @throws IOException IO错误时抛出
         */
        public static boolean unzipFiles(Collection<File> zipFiles, File destDir)
                throws IOException {
            if (zipFiles == null || destDir == null) return false;
            for (File zipFile : zipFiles) {
                if (!unzipFile(zipFile, destDir)) return false;
            }
            return true;
        }
    
        /**
         * 解压文件
         *
         * @param zipFilePath 待解压文件路径
         * @param destDirPath 目标目录路径
         * @return {@code true}: 解压成功<br>{@code false}: 解压失败
         * @throws IOException IO错误时抛出
         */
        public static boolean unzipFile(String zipFilePath, String destDirPath)
                throws IOException {
            return unzipFile(FileUtils.getFileByPath(zipFilePath), FileUtils.getFileByPath(destDirPath));
        }
    
        /**
         * 解压文件
         *
         * @param zipFile 待解压文件
         * @param destDir 目标目录
         * @return {@code true}: 解压成功<br>{@code false}: 解压失败
         * @throws IOException IO错误时抛出
         */
        public static boolean unzipFile(File zipFile, File destDir)
                throws IOException {
            return unzipFileByKeyword(zipFile, destDir, null) != null;
        }
    
        /**
         * 解压带有关键字的文件
         *
         * @param zipFilePath 待解压文件路径
         * @param destDirPath 目标目录路径
         * @param keyword     关键字
         * @return 返回带有关键字的文件链表
         * @throws IOException IO错误时抛出
         */
        public static List<File> unzipFileByKeyword(String zipFilePath, String destDirPath, String keyword)
                throws IOException {
            return unzipFileByKeyword(FileUtils.getFileByPath(zipFilePath),
                    FileUtils.getFileByPath(destDirPath), keyword);
        }
    
        /**
         * 解压带有关键字的文件
         *
         * @param zipFile 待解压文件
         * @param destDir 目标目录
         * @param keyword 关键字
         * @return 返回带有关键字的文件链表
         * @throws IOException IO错误时抛出
         */
        public static List<File> unzipFileByKeyword(File zipFile, File destDir, String keyword)
                throws IOException {
            if (zipFile == null || destDir == null) return null;
            List<File> files = new ArrayList<>();
            ZipFile zf = new ZipFile(zipFile);
            Enumeration<?> entries = zf.entries();
            while (entries.hasMoreElements()) {
                ZipEntry entry = ((ZipEntry) entries.nextElement());
                String entryName = entry.getName();
                if (StringUtils.isEmpty(keyword) || FileUtils.getFileName(entryName).toLowerCase().contains(keyword.toLowerCase())) {
                    String filePath = destDir + File.separator + entryName;
                    File file = new File(filePath);
                    files.add(file);
                    if (entry.isDirectory()) {
                        if (!FileUtils.createOrExistsDir(file)) return null;
                    } else {
                        if (!FileUtils.createOrExistsFile(file)) return null;
                        InputStream in = null;
                        OutputStream out = null;
                        try {
                            in = new BufferedInputStream(zf.getInputStream(entry));
                            out = new BufferedOutputStream(new FileOutputStream(file));
                            byte buffer[] = new byte[KB];
                            int len;
                            while ((len = in.read(buffer)) != -1) {
                                out.write(buffer, 0, len);
                            }
                        } finally {
                            FileUtils.closeIO(in, out);
                        }
                    }
                }
            }
            return files;
        }
    
        /**
         * 获取压缩文件中的文件路径链表
         *
         * @param zipFilePath 压缩文件路径
         * @return 压缩文件中的文件路径链表
         * @throws IOException IO错误时抛出
         */
        public static List<String> getFilesPath(String zipFilePath)
                throws IOException {
            return getFilesPath(FileUtils.getFileByPath(zipFilePath));
        }
    
        /**
         * 获取压缩文件中的文件路径链表
         *
         * @param zipFile 压缩文件
         * @return 压缩文件中的文件路径链表
         * @throws IOException IO错误时抛出
         */
        public static List<String> getFilesPath(File zipFile)
                throws IOException {
            if (zipFile == null) return null;
            List<String> paths = new ArrayList<>();
            Enumeration<?> entries = getEntries(zipFile);
            while (entries.hasMoreElements()) {
                paths.add(((ZipEntry) entries.nextElement()).getName());
            }
            return paths;
        }
    
        /**
         * 获取压缩文件中的注释链表
         *
         * @param zipFilePath 压缩文件路径
         * @return 压缩文件中的注释链表
         * @throws IOException IO错误时抛出
         */
        public static List<String> getComments(String zipFilePath)
                throws IOException {
            return getComments(FileUtils.getFileByPath(zipFilePath));
        }
    
        /**
         * 获取压缩文件中的注释链表
         *
         * @param zipFile 压缩文件
         * @return 压缩文件中的注释链表
         * @throws IOException IO错误时抛出
         */
        public static List<String> getComments(File zipFile)
                throws IOException {
            if (zipFile == null) return null;
            List<String> comments = new ArrayList<>();
            Enumeration<?> entries = getEntries(zipFile);
            while (entries.hasMoreElements()) {
                ZipEntry entry = ((ZipEntry) entries.nextElement());
                comments.add(entry.getComment());
            }
            return comments;
        }
    
        /**
         * 获取压缩文件中的文件对象
         *
         * @param zipFilePath 压缩文件路径
         * @return 压缩文件中的文件对象
         * @throws IOException IO错误时抛出
         */
        public static Enumeration<?> getEntries(String zipFilePath)
                throws IOException {
            return getEntries(FileUtils.getFileByPath(zipFilePath));
        }
    
        /**
         * 获取压缩文件中的文件对象
         *
         * @param zipFile 压缩文件
         * @return 压缩文件中的文件对象
         * @throws IOException IO错误时抛出
         */
        public static Enumeration<?> getEntries(File zipFile)
                throws IOException {
            if (zipFile == null) return null;
            return new ZipFile(zipFile).entries();
        }
    }
    

    如果该工具类依赖其他工具类,都可以在我的Android开发人员不得不收集的代码(持续更新中)中找到。

    相关文章

      网友评论

      本文标题:工具类之ZipUtils

      本文链接:https://www.haomeiwen.com/subject/gtapettx.html