最近碰到個需要下載zip壓縮包的需求，於是我在網上找了下別人寫好的zip工具類。但找了好多篇博客，總是發現有bug。因此就自己來寫了個工具類。
這個工具類的功能為：
- （1）可以壓縮文件，也可以壓縮文件夾
- （2）同時支持壓縮多級文件夾，工具內部做了遞歸處理
- （3）碰到空的文件夾，也可以壓縮
- （4）可以選擇是否保留原來的目錄結構，如果不保留，所有文件跑壓縮包根目錄去了，且空文件夾直接舍棄。注意：如果不保留文件原來目錄結構，在碰到文件名相同的文件時，會壓縮失敗。
- （5）代碼中提供了2個壓縮文件的方法，一個的輸入參數為文件夾路徑，一個為文件列表，可根據實際需求選擇方法。
下面直接上代碼
一、代碼
package com.tax.core.util;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.util.ArrayList;
import java.util.List;
import java.util.zip.ZipEntry;
import java.util.zip.ZipOutputStream;
/**
* ZipUtils
* @author ZENG.XIAO.YAN
* @date 2017年11月19日 下午7:16:08
* @version v1.0
*/
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("c:/mytest01.zip"));
ZipUtils.toZip("D:/log", fos1,true);
/** 測試壓縮方法2 */
List<File> fileList = new ArrayList<>();
fileList.add(new File("D:/Java/jdk1.7.0_45_64bit/bin/jar.exe"));
fileList.add(new File("D:/Java/jdk1.7.0_45_64bit/bin/java.exe"));
FileOutputStream fos2 = new FileOutputStream(new File("c:/mytest02.zip"));
ZipUtils.toZip(fileList, fos2);
}
}
x
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
/**
13
* ZipUtils
14
* @author ZENG.XIAO.YAN
15
* @date 2017年11月19日 下午7:16:08
16
* @version v1.0
17
*/
18
public class ZipUtils {
19
20
private static final int BUFFER_SIZE = 2 * 1024;
21
22
/**
23
* 壓縮成ZIP 方法1
24
* @param srcDir 壓縮文件夾路徑
25
* @param out 壓縮文件輸出流
26
* @param KeepDirStructure 是否保留原來的目錄結構,true:保留目錄結構;
27
* false:所有文件跑到壓縮包根目錄下(注意：不保留目錄結構可能會出現同名文件,會壓縮失敗)
28
* @throws RuntimeException 壓縮失敗會拋出運行時異常
29
*/
30
public static void toZip(String srcDir, OutputStream out, boolean KeepDirStructure)
31
throws RuntimeException{
32
33
long start = System.currentTimeMillis();
34
ZipOutputStream zos = null ;
35
try {
36
zos = new ZipOutputStream(out);
37
File sourceFile = new File(srcDir);
38
compress(sourceFile,zos,sourceFile.getName(),KeepDirStructure);
39
long end = System.currentTimeMillis();
40
System.out.println("壓縮完成，耗時：" + (end - start) +" ms");
41
} catch (Exception e) {
42
throw new RuntimeException("zip error from ZipUtils",e);
43
}finally{
44
if(zos != null){
45
try {
46
zos.close();
47
} catch (IOException e) {
48
e.printStackTrace();
49
}
50
}
51
}
52
53
}
54
55
/**
56
* 壓縮成ZIP 方法2
57
* @param srcFiles 需要壓縮的文件列表
58
* @param out 壓縮文件輸出流
59
* @throws RuntimeException 壓縮失敗會拋出運行時異常
60
*/
61
public static void toZip(List<File> srcFiles , OutputStream out)throws RuntimeException {
62
long start = System.currentTimeMillis();
63
ZipOutputStream zos = null ;
64
try {
65
zos = new ZipOutputStream(out);
66
for (File srcFile : srcFiles) {
67
byte[] buf = new byte[BUFFER_SIZE];
68
zos.putNextEntry(new ZipEntry(srcFile.getName()));
69
int len;
70
FileInputStream in = new FileInputStream(srcFile);
71
while ((len = in.read(buf)) != -1){
72
zos.write(buf, 0, len);
73
}
74
zos.closeEntry();
75
in.close();
76
}
77
long end = System.currentTimeMillis();
78
System.out.println("壓縮完成，耗時：" + (end - start) +" ms");
79
} catch (Exception e) {
80
throw new RuntimeException("zip error from ZipUtils",e);
81
}finally{
82
if(zos != null){
83
try {
84
zos.close();
85
} catch (IOException e) {
86
e.printStackTrace();
87
}
88
}
89
}
90
}
91
92
93
/**
94
* 遞歸壓縮方法
95
* @param sourceFile 源文件
96
* @param zos zip輸出流
97
* @param name 壓縮后的名稱
98
* @param KeepDirStructure 是否保留原來的目錄結構,true:保留目錄結構;
99
* false:所有文件跑到壓縮包根目錄下(注意：不保留目錄結構可能會出現同名文件,會壓縮失敗)
100
* @throws Exception
101
*/
102
private static void compress(File sourceFile, ZipOutputStream zos, String name,
103
boolean KeepDirStructure) throws Exception{
104
byte[] buf = new byte[BUFFER_SIZE];
105
if(sourceFile.isFile()){
106
// 向zip輸出流中添加一個zip實體，構造器中name為zip實體的文件的名字
107
zos.putNextEntry(new ZipEntry(name));
108
// copy文件到zip輸出流中
109
int len;
110
FileInputStream in = new FileInputStream(sourceFile);
111
while ((len = in.read(buf)) != -1){
112
zos.write(buf, 0, len);
113
}
114
// Complete the entry
115
zos.closeEntry();
116
in.close();
117
} else {
118
File[] listFiles = sourceFile.listFiles();
119
if(listFiles == null || listFiles.length == 0){
120
// 需要保留原來的文件結構時,需要對空文件夾進行處理
121
if(KeepDirStructure){
122
// 空文件夾的處理
123
zos.putNextEntry(new ZipEntry(name + "/"));
124
// 沒有文件，不需要文件的copy
125
zos.closeEntry();
126
}
127
128
}else {
129
for (File file : listFiles) {
130
// 判斷是否需要保留原來的文件結構
131
if (KeepDirStructure) {
132
// 注意：file.getName()前面需要帶上父文件夾的名字加一斜杠,
133
// 不然最后壓縮包中就不能保留原來的文件結構,即：所有文件都跑到壓縮包根目錄下了
134
compress(file, zos, name + "/" + file.getName(),KeepDirStructure);
135
} else {
136
compress(file, zos, file.getName(),KeepDirStructure);
137
}
138
139
}
140
}
141
}
142
}
143
144
public static void main(String[] args) throws Exception {
145
/** 測試壓縮方法1 */
146
FileOutputStream fos1 = new FileOutputStream(new File("c:/mytest01.zip"));
147
ZipUtils.toZip("D:/log", fos1,true);
148
149
/** 測試壓縮方法2 */
150
List<File> fileList = new ArrayList<>();
151
fileList.add(new File("D:/Java/jdk1.7.0_45_64bit/bin/jar.exe"));
152
fileList.add(new File("D:/Java/jdk1.7.0_45_64bit/bin/java.exe"));
153
FileOutputStream fos2 = new FileOutputStream(new File("c:/mytest02.zip"));
154
ZipUtils.toZip(fileList, fos2);
155
}
156
}
二、注意事項
寫該工具類時，有些注意事項說一下：
（1）支持選擇是否保留原來的文件目錄結構，如果不保留，那么空文件夾直接不用處理。
（1）碰到空文件夾時，如果需要保留目錄結構，則直接添加個ZipEntry就可以了，不過就是這個entry的名字后面需要帶上一斜杠（/）表示這個是目錄。
（2）遞歸時，不需要把zip輸出流關閉，zip輸出流的關閉應該是在調用完遞歸方法后面關閉
（3）遞歸時，如果是個文件夾且需要保留目錄結構，那么在調用方法壓縮他的子文件時，需要把文件夾的名字加一斜杠給添加到子文件名字前面，這樣壓縮后才有多級目錄。
三、如何在javaWeb項目中使用該工具類
這個工具類在web項目中的使用場景就是多文件下載，我就簡單說個下載多個excel表格的案例吧。
代碼中的步驟為：
（1）創建一個臨時文件夾
（2）將要下載的文件生成至該臨時文件夾內
（3）當所有文件生成完后，獲取HttpServletResponse獲取設置下載的header
（4）調用工具類的方法，傳入上面生成的臨時文件夾路徑及response獲取的輸出流；這樣就下載出來zip包了
（5）遞歸刪除掉上面生成的臨時文件夾和文件
下面為一個示例代碼的代碼片段，不是完整代碼，簡單看一下代碼中的步驟
if(userList.size() > 0){
/** 下面為下載zip壓縮包相關流程 */
HttpServletRequest request = ServletActionContext.getRequest();
FileWriter writer;
/** 1.創建臨時文件夾 */
String rootPath = request.getSession().getServletContext().getRealPath("/");
File temDir = new File(rootPath + "/" + UUID.randomUUID().toString().replaceAll("-", ""));
if(!temDir.exists()){
temDir.mkdirs();
}
/** 2.生成需要下載的文件，存放在臨時文件夾內 */
// 這里我們直接來10個內容相同的文件為例，但這個10個文件名不可以相同
for (int i = 0; i < 10; i++) {
dataMap.put("userList", userList);
Map<String, String> endMap = new HashMap<>();
endMap.put("user", "老王");
endMap.put("time", "2017-10-10 10:50:55");
dataMap.put("endMap", endMap);
Configuration cfg = new Configuration(Configuration.VERSION_2_3_22);
cfg.setServletContextForTemplateLoading(ServletActionContext.getServletContext(), "/ftl");
Template template = cfg.getTemplate("exportExcel.ftl");
writer = new FileWriter(temDir.getPath()+"/excel"+ i +".xls");
template.process(dataMap, writer);
writer.flush();
writer.close();
}
/** 3.設置response的header */
HttpServletResponse response = ServletActionContext.getResponse();
response.setContentType("application/zip");
response.setHeader("Content-Disposition", "attachment; filename=excel.zip");
/** 4.調用工具類，下載zip壓縮包 */
// 這里我們不需要保留目錄結構
ZipUtils.toZip(temDir.getPath(), response.getOutputStream(),false);
/** 5.刪除臨時文件和文件夾 */
// 這里我沒寫遞歸，直接就這樣刪除了
File[] listFiles = temDir.listFiles();
for (int i = 0; i < listFiles.length; i++) {
listFiles[i].delete();
}
temDir.delete();
}
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
12
/** 2.生成需要下載的文件，存放在臨時文件夾內 */
13
// 這里我們直接來10個內容相同的文件為例，但這個10個文件名不可以相同
14
for (int i = 0; i < 10; i++) {
15
dataMap.put("userList", userList);
16
Map<String, String> endMap = new HashMap<>();
17
endMap.put("user", "老王");
18
endMap.put("time", "2017-10-10 10:50:55");
19
dataMap.put("endMap", endMap);
20
Configuration cfg = new Configuration(Configuration.VERSION_2_3_22);
21
cfg.setServletContextForTemplateLoading(ServletActionContext.getServletContext(), "/ftl");
22
Template template = cfg.getTemplate("exportExcel.ftl");
23
writer = new FileWriter(temDir.getPath()+"/excel"+ i +".xls");
24
template.process(dataMap, writer);
25
writer.flush();
26
writer.close();
27
}
28
29
/** 3.設置response的header */
30
HttpServletResponse response = ServletActionContext.getResponse();
31
response.setContentType("application/zip");
32
response.setHeader("Content-Disposition", "attachment; filename=excel.zip");
33
34
/** 4.調用工具類，下載zip壓縮包 */
35
// 這里我們不需要保留目錄結構
36
ZipUtils.toZip(temDir.getPath(), response.getOutputStream(),false);
37
38
/** 5.刪除臨時文件和文件夾 */
39
// 這里我沒寫遞歸，直接就這樣刪除了
40
File[] listFiles = temDir.listFiles();
41
for (int i = 0; i < listFiles.length; i++) {
42
listFiles[i].delete();
43
}
44
temDir.delete();
45
}