在android开发工程中经常会使用到文件上传相关。单多个文件上传常常需要将一个文件夹中的文件先压缩成一个zip文件,之后再次上传到服务器上。
经过Google一番,最终发现一个比较简单的解压缩工具类。
使用:
public static void compressDB(Context context){
String inPath = Environment.getExternalStorageDirectory().getAbsolutePath()+File.separator+"testfile";
String outPath = Environment.getExternalStorageDirectory().getAbsolutePath() + "/test_file.zip";
try {
// 压缩 (保证 testfile 文件夹 存在)
ZipUtils.zipFile(inPath,outPath);
// 解压 时(保证 check_file.zip 文件 存在)
// ZipUtils.unzipFile(outPath,inPath);
} catch (IOException e) {
e.printStackTrace();
}
}
先上源码
package com.taoche.gearlib;
import android.util.Log;
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;
/**
* Created By : fumm
* DATE : 2019/7/11 11:02
* Describe : zip 解压缩工具类
**/
public class ZipUtils {
private static final int BUFFER_LEN = 8192;
private ZipUtils() {
throw new UnsupportedOperationException("u can't instantiate me...");
}
/**
* Zip the files.
*
* @param srcFiles The source of files.
* @param zipFilePath The path of ZIP file.
* @return {@code true}: success<br>{@code false}: fail
* @throws IOException if an I/O error has occurred
*/
public static boolean zipFiles(final Collection<String> srcFiles,
final String zipFilePath)
throws IOException {
return zipFiles(srcFiles, zipFilePath, null);
}
/**
* Zip the files.
*
* @param srcFilePaths The paths of source files.
* @param zipFilePath The path of ZIP file.
* @param comment The comment.
* @return {@code true}: success<br>{@code false}: fail
* @throws IOException if an I/O error has occurred
*/
public static boolean zipFiles(final Collection<String> srcFilePaths,
final String zipFilePath,
final String comment)
throws IOException {
if (srcFilePaths == null || zipFilePath == null) return false;
ZipOutputStream zos = null;
try {
zos = new ZipOutputStream(new FileOutputStream(zipFilePath));
for (String srcFile : srcFilePaths) {
if (!zipFile(getFileByPath(srcFile), "", zos, comment)) return false;
}
return true;
} finally {
if (zos != null) {
zos.finish();
zos.close();
}
}
}
/**
* Zip the files.
*
* @param srcFiles The source of files.
* @param zipFile The ZIP file.
* @return {@code true}: success<br>{@code false}: fail
* @throws IOException if an I/O error has occurred
*/
public static boolean zipFiles(final Collection<File> srcFiles, final File zipFile)
throws IOException {
return zipFiles(srcFiles, zipFile, null);
}
/**
* Zip the files.
*
* @param srcFiles The source of files.
* @param zipFile The ZIP file.
* @param comment The comment.
* @return {@code true}: success<br>{@code false}: fail
* @throws IOException if an I/O error has occurred
*/
public static boolean zipFiles(final Collection<File> srcFiles,
final File zipFile,
final String comment)
throws IOException {
if (srcFiles == null || zipFile == null) return false;
ZipOutputStream zos = null;
try {
zos = new ZipOutputStream(new FileOutputStream(zipFile));
for (File srcFile : srcFiles) {
if (!zipFile(srcFile, "", zos, comment)) return false;
}
return true;
} finally {
if (zos != null) {
zos.finish();
zos.close();
}
}
}
/**
* Zip the file.
*
* @param srcFilePath The path of source file.
* @param zipFilePath The path of ZIP file.
* @return {@code true}: success<br>{@code false}: fail
* @throws IOException if an I/O error has occurred
*/
public static boolean zipFile(final String srcFilePath,
final String zipFilePath)
throws IOException {
return zipFile(getFileByPath(srcFilePath), getFileByPath(zipFilePath), null);
}
/**
* Zip the file.
*
* @param srcFilePath The path of source file.
* @param zipFilePath The path of ZIP file.
* @param comment The comment.
* @return {@code true}: success<br>{@code false}: fail
* @throws IOException if an I/O error has occurred
*/
public static boolean zipFile(final String srcFilePath,
final String zipFilePath,
final String comment)
throws IOException {
return zipFile(getFileByPath(srcFilePath), getFileByPath(zipFilePath), comment);
}
/**
* Zip the file.
*
* @param srcFile The source of file.
* @param zipFile The ZIP file.
* @return {@code true}: success<br>{@code false}: fail
* @throws IOException if an I/O error has occurred
*/
public static boolean zipFile(final File srcFile,
final File zipFile)
throws IOException {
return zipFile(srcFile, zipFile, null);
}
/**
* Zip the file.
*
* @param srcFile The source of file.
* @param zipFile The ZIP file.
* @param comment The comment.
* @return {@code true}: success<br>{@code false}: fail
* @throws IOException if an I/O error has occurred
*/
public static boolean zipFile(final File srcFile,
final File zipFile,
final String comment)
throws IOException {
if (srcFile == null || zipFile == null) return false;
ZipOutputStream zos = null;
try {
zos = new ZipOutputStream(new FileOutputStream(zipFile));
return zipFile(srcFile, "", zos, comment);
} finally {
if (zos != null) {
zos.close();
}
}
}
// 核心压缩类
private static boolean zipFile(final File srcFile,
String rootPath,
final ZipOutputStream zos,
final String comment)
throws IOException {
rootPath = rootPath + (isSpace(rootPath) ? "" : File.separator) + srcFile.getName();
// 被压缩的源文件 是否是文件夹
if (srcFile.isDirectory()) {
// 获取文件夹中所有文件
File[] fileList = srcFile.listFiles();
if (fileList == null || fileList.length <= 0) {
// 1、空文件夹处理
// zip文件项 根据文件路径
ZipEntry entry = new ZipEntry(rootPath + '/');
// 设置单个zip实体备注 非必填
entry.setComment(comment);
// 开始编写新的ZIP文件项
zos.putNextEntry(entry);
// 关闭当前ZIP项
zos.closeEntry();
} else {
// 2、非空文件夹处理
for (File file : fileList) {
// 递归 处理文件夹中每一个 文件夹和文件
if (!zipFile(file, rootPath, zos, comment)) return false;
}
}
} else {
// 3、文件处理
InputStream is = null;
try {
// 获得文件输入流
is = new BufferedInputStream(new FileInputStream(srcFile));
// 创建zip文件项 根据文件路径
ZipEntry entry = new ZipEntry(rootPath);
entry.setComment(comment);
// 开始编写新的ZIP文件项
zos.putNextEntry(entry);
// 将文件流 写入 zip
byte buffer[] = new byte[BUFFER_LEN];
int len;
while ((len = is.read(buffer, 0, BUFFER_LEN)) != -1) {
zos.write(buffer, 0, len);
}
// 关闭当前ZIP项
zos.closeEntry();
} finally {
if (is != null) {
is.close();
}
}
}
return true;
}
/**
* Unzip the file.
*
* @param zipFilePath The path of ZIP file.
* @param destDirPath The path of destination directory.
* @return the unzipped files
* @throws IOException if unzip unsuccessfully
*/
public static List<File> unzipFile(final String zipFilePath,
final String destDirPath)
throws IOException {
return unzipFileByKeyword(zipFilePath, destDirPath, null);
}
/**
* Unzip the file.
*
* @param zipFile The ZIP file.
* @param destDir The destination directory.
* @return the unzipped files
* @throws IOException if unzip unsuccessfully
*/
public static List<File> unzipFile(final File zipFile,
final File destDir)
throws IOException {
return unzipFileByKeyword(zipFile, destDir, null);
}
/**
* Unzip the file by keyword.
*
* @param zipFilePath The path of ZIP file.
* @param destDirPath The path of destination directory.
* @param keyword The keyboard.
* @return the unzipped files
* @throws IOException if unzip unsuccessfully
*/
public static List<File> unzipFileByKeyword(final String zipFilePath,
final String destDirPath,
final String keyword)
throws IOException {
return unzipFileByKeyword(getFileByPath(zipFilePath), getFileByPath(destDirPath), keyword);
}
/**
* Unzip the file by keyword.
*
* @param zipFile The ZIP file.
* @param destDir The destination directory.
* @param keyword The keyboard.
* @return the unzipped files
* @throws IOException if unzip unsuccessfully
*/
public static List<File> unzipFileByKeyword(final File zipFile,
final File destDir,
final String keyword)
throws IOException {
if (zipFile == null || destDir == null) return null;
List<File> files = new ArrayList<>();
// 打开一个ZIP文件,用于读取给定的指定文件对象。
ZipFile zip = new ZipFile(zipFile);
// 获得ZIP文件项的枚举。
Enumeration<?> entries = zip.entries();
try {
if (isSpace(keyword)) {
// 关键字为空
while (entries.hasMoreElements()) {
// 获得每一个zip文件元素
ZipEntry entry = ((ZipEntry) entries.nextElement());
String entryName = entry.getName();
if (entryName.contains("../")) {
Log.e("ZipUtils", "entryName: " + entryName + " is dangerous!");
continue;
}
// 解压每一个zip文件元素
if (!unzipChildFile(destDir, files, zip, entry, entryName)) return files;
}
} else {
while (entries.hasMoreElements()) {
ZipEntry entry = ((ZipEntry) entries.nextElement());
String entryName = entry.getName();
if (entryName.contains("../")) {
Log.e("ZipUtils", "entryName: " + entryName + " is dangerous!");
continue;
}
// zip文件元素名包含关键字 才解压
if (entryName.contains(keyword)) {
// 解压每一个zip文件元素
if (!unzipChildFile(destDir, files, zip, entry, entryName)) return files;
}
}
}
} finally {
zip.close();
}
return files;
}
private static boolean unzipChildFile(final File destDir,
final List<File> files,
final ZipFile zip,
final ZipEntry entry,
final String name) throws IOException {
// 创建文件 解压目录:destDir 解压:文件名
File file = new File(destDir, name);
// 添加到file列表中
files.add(file);
// 是否是文件夹
if (entry.isDirectory()) {
// 创建文件夹
return createOrExistsDir(file);
} else {
if (!createOrExistsFile(file)) return false;
InputStream in = null;
OutputStream out = null;
try {
// 读写生产解压后的文件
in = new BufferedInputStream(zip.getInputStream(entry));
out = new BufferedOutputStream(new FileOutputStream(file));
byte buffer[] = new byte[BUFFER_LEN];
int len;
while ((len = in.read(buffer)) != -1) {
out.write(buffer, 0, len);
}
} finally {
if (in != null) {
in.close();
}
if (out != null) {
out.close();
}
}
}
return true;
}
/**
* Return the files' path in ZIP file.
*
* @param zipFilePath The path of ZIP file.
* @return the files' path in ZIP file
* @throws IOException if an I/O error has occurred
*/
public static List<String> getFilesPath(final String zipFilePath)
throws IOException {
return getFilesPath(getFileByPath(zipFilePath));
}
/**
* Return the files' path in ZIP file.
*
* @param zipFile The ZIP file.
* @return the files' path in ZIP file
* @throws IOException if an I/O error has occurred
*/
public static List<String> getFilesPath(final File zipFile)
throws IOException {
if (zipFile == null) return null;
List<String> paths = new ArrayList<>();
ZipFile zip = new ZipFile(zipFile);
Enumeration<?> entries = zip.entries();
while (entries.hasMoreElements()) {
String entryName = ((ZipEntry) entries.nextElement()).getName();
if (entryName.contains("../")) {
Log.e("ZipUtils", "entryName: " + entryName + " is dangerous!");
paths.add(entryName);
} else {
paths.add(entryName);
}
}
zip.close();
return paths;
}
/**
* Return the files' comment in ZIP file.
*
* @param zipFilePath The path of ZIP file.
* @return the files' comment in ZIP file
* @throws IOException if an I/O error has occurred
*/
public static List<String> getComments(final String zipFilePath)
throws IOException {
return getComments(getFileByPath(zipFilePath));
}
/**
* Return the files' comment in ZIP file.
*
* @param zipFile The ZIP file.
* @return the files' comment in ZIP file
* @throws IOException if an I/O error has occurred
*/
public static List<String> getComments(final File zipFile)
throws IOException {
if (zipFile == null) return null;
List<String> comments = new ArrayList<>();
ZipFile zip = new ZipFile(zipFile);
Enumeration<?> entries = zip.entries();
while (entries.hasMoreElements()) {
ZipEntry entry = ((ZipEntry) entries.nextElement());
comments.add(entry.getComment());
}
zip.close();
return comments;
}
private static boolean createOrExistsDir(final File file) {
return file != null && (file.exists() ? file.isDirectory() : file.mkdirs());
}
private static boolean createOrExistsFile(final File file) {
if (file == null) return false;
if (file.exists()) return file.isFile();
if (!createOrExistsDir(file.getParentFile())) return false;
try {
return file.createNewFile();
} catch (IOException e) {
e.printStackTrace();
return false;
}
}
private static File getFileByPath(final String filePath) {
return isSpace(filePath) ? null : new File(filePath);
}
private static boolean isSpace(final String s) {
if (s == null) return true;
for (int i = 0, len = s.length(); i < len; ++i) {
if (!Character.isWhitespace(s.charAt(i))) {
return false;
}
}
return true;
}
}
该工具类的主要的两个方法
// 核心压缩类
private static boolean zipFile(final File srcFile,
String rootPath,
final ZipOutputStream zos,
final String comment)
// 核心解压类
public static List<File> unzipFileByKeyword(final File zipFile,
final File destDir,
final String keyword)
都添加了详细的注释。
参考:
https://github.com/864381832/xJavaFxTool