springboot多文件或者文件夾壓縮成zip的方法
最近碰到個(gè)需要下載zip壓縮包的需求,于是我在網(wǎng)上找了下別人寫(xiě)好的zip工具類(lèi)。但找了好多篇博客,總是發(fā)現(xiàn)有bug。因此就自己來(lái)寫(xiě)了個(gè)工具類(lèi)。
這個(gè)工具類(lèi)的功能為:
- (1)可以壓縮文件,也可以壓縮文件夾
- (5)代碼中提供了2個(gè)壓縮文件的方法,一個(gè)的輸入?yún)?shù)為文件夾路徑,一個(gè)為文件列表,可根據(jù)實(shí)際需求選擇方法。
- (4)可以選擇是否保留原來(lái)的目錄結(jié)構(gòu),如果不保留,所有文件跑壓縮包根目錄去了,且空文件夾直接舍棄。注意:如果不保留文件原來(lái)目錄結(jié)構(gòu),在碰到文件名相同的文件時(shí),會(huì)壓縮失敗。
- (3)碰到空的文件夾,也可以壓縮
- (2)同時(shí)支持壓縮多級(jí)文件夾,工具內(nèi)部做了遞歸處理
下面直接上代碼
一、代碼
import java.io.*;
import java.util.List;
import java.util.zip.ZipEntry;
import java.util.zip.ZipOutputStream;
public class demo {
private static final int BUFFER_SIZE = 2 * 1024;
/**
* 壓縮成ZIP 方法1
*
* @param srcDir 壓縮文件夾路徑
* @param out 壓縮文件輸出流
* @param KeepDirStructure 是否保留原來(lái)的目錄結(jié)構(gòu),true:保留目錄結(jié)構(gòu);
* false:所有文件跑到壓縮包根目錄下(注意:不保留目錄結(jié)構(gòu)可能會(huì)出現(xiàn)同名文件,會(huì)壓縮失敗)
* @throws RuntimeException 壓縮失敗會(huì)拋出運(yùn)行時(shí)異常
*/
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("壓縮完成,耗時(shí):" + (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 壓縮失敗會(huì)拋出運(yùn)行時(shí)異常
*/
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("壓縮完成,耗時(shí):" + (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 壓縮后的名稱(chēng)
* @param KeepDirStructure 是否保留原來(lái)的目錄結(jié)構(gòu),true:保留目錄結(jié)構(gòu);
* false:所有文件跑到壓縮包根目錄下(注意:不保留目錄結(jié)構(gòu)可能會(huì)出現(xiàn)同名文件,會(huì)壓縮失敗)
* @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輸出流中添加一個(gè)zip實(shí)體,構(gòu)造器中name為zip實(shí)體的文件的名字
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) {
// 需要保留原來(lái)的文件結(jié)構(gòu)時(shí),需要對(duì)空文件夾進(jìn)行處理
if (KeepDirStructure) {
// 空文件夾的處理
zos.putNextEntry(new ZipEntry(name + "/"));
// 沒(méi)有文件,不需要文件的copy
zos.closeEntry();
}
} else {
for (File file : listFiles) {
// 判斷是否需要保留原來(lái)的文件結(jié)構(gòu)
if (KeepDirStructure) {
// 注意:file.getName()前面需要帶上父文件夾的名字加一斜杠,
// 不然最后壓縮包中就不能保留原來(lái)的文件結(jié)構(gòu),即:所有文件都跑到壓縮包根目錄下了
compress(file, zos, name + "/" + file.getName(), KeepDirStructure);
} else {
compress(file, zos, file.getName(), KeepDirStructure);
}
}
}
}
}
public static void main(String[] args) throws Exception {
/** 測(cè)試壓縮方法1 */
FileOutputStream fos1 = new FileOutputStream(new File("c:/mytest01.zip"));
demo.toZip("D:\\common_files\\online", fos1, true);
/** 測(cè)試壓縮方法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"));
//
// demo.toZip(fileList, fos2);
}
}
二、注意事項(xiàng)
寫(xiě)該工具類(lèi)時(shí),有些注意事項(xiàng)說(shuō)一下:
- (1)支持選擇是否保留原來(lái)的文件目錄結(jié)構(gòu),如果不保留,那么空文件夾直接不用處理。碰到空文件夾時(shí),如果需要保留目錄結(jié)構(gòu),則直接添加個(gè)ZipEntry就可以了,不過(guò)就是這個(gè)entry的名字后面需要帶上一斜杠(/)表示這個(gè)是目錄。
- (2)遞歸時(shí),不需要把zip輸出流關(guān)閉,zip輸出流的關(guān)閉應(yīng)該是在調(diào)用完遞歸方法后面關(guān)閉
- (3)遞歸時(shí),如果是個(gè)文件夾且需要保留目錄結(jié)構(gòu),那么在調(diào)用方法壓縮他的子文件時(shí),需要把文件夾的名字加一斜杠給添加到子文件名字前面,這樣壓縮后才有多級(jí)目錄。
三、如何在javaWeb項(xiàng)目中使用該工具類(lèi)
這個(gè)工具類(lèi)在web項(xiàng)目中的使用場(chǎng)景就是多文件下載,我就簡(jiǎn)單說(shuō)個(gè)下載多個(gè)excel表格的案例吧。
代碼中的步驟為:
- (1)創(chuàng)建一個(gè)臨時(shí)文件夾
- (2)將要下載的文件生成至該臨時(shí)文件夾內(nèi)
- (3)當(dāng)所有文件生成完后,獲取HttpServletResponse獲取設(shè)置下載的header
- (4)調(diào)用工具類(lèi)的方法,傳入上面生成的臨時(shí)文件夾路徑及response獲取的輸出流;這樣就下載出來(lái)zip包了
- (5)遞歸刪除掉上面生成的臨時(shí)文件夾和文件
下面為一個(gè)示例代碼的代碼片段,不是完整代碼,簡(jiǎn)單看一下代碼中的步驟
if(userList.size() > 0){
/** 下面為下載zip壓縮包相關(guān)流程 */
HttpServletRequest request = ServletActionContext.getRequest();
FileWriter writer;
/** 1.創(chuàng)建臨時(shí)文件夾 */
String rootPath = request.getSession().getServletContext().getRealPath("/");
File temDir = new File(rootPath + "/" + UUID.randomUUID().toString().replaceAll("-", ""));
if(!temDir.exists()){
temDir.mkdirs();
}
/** 2.生成需要下載的文件,存放在臨時(shí)文件夾內(nèi) */
// 這里我們直接來(lái)10個(gè)內(nèi)容相同的文件為例,但這個(gè)10個(gè)文件名不可以相同
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.設(shè)置response的header */
HttpServletResponse response = ServletActionContext.getResponse();
response.setContentType("application/zip");
response.setHeader("Content-Disposition", "attachment; filename=excel.zip");
/** 4.調(diào)用工具類(lèi),下載zip壓縮包 */
// 這里我們不需要保留目錄結(jié)構(gòu)
demo.toZip(temDir.getPath(), response.getOutputStream(),false);
/** 5.刪除臨時(shí)文件和文件夾 */
// 這里我沒(méi)寫(xiě)遞歸,直接就這樣刪除了
File[] listFiles = temDir.listFiles();
for (int i = 0; i < listFiles.length; i++) {
listFiles[i].delete();
}
temDir.delete();
}到此這篇關(guān)于springboot多文件或者文件夾壓縮成zip的文章就介紹到這了,更多相關(guān)springboot文件夾壓縮成zip內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
Java List轉(zhuǎn)換成String數(shù)組幾種實(shí)現(xiàn)方式詳解
這篇文章主要介紹了Java List轉(zhuǎn)換成String數(shù)組幾種實(shí)現(xiàn)方式詳解的相關(guān)資料,需要的朋友可以參考下2016-12-12
Spring TaskScheduler使用實(shí)例解析
這篇文章主要介紹了Spring TaskScheduler使用實(shí)例解析,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2019-11-11
MyBatis如何使用PageHelper實(shí)現(xiàn)分頁(yè)查詢(xún)
這篇文章主要介紹了MyBatis如何使用PageHelper實(shí)現(xiàn)分頁(yè)查詢(xún),具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2021-11-11
Java向數(shù)據(jù)庫(kù)中插入數(shù)據(jù)后獲取自增ID的常用方法
有時(shí)候因?yàn)樾略龅男枨笮枰@取剛剛新增的數(shù)據(jù)的自增的主鍵ID,下面這篇文章主要給大家介紹了關(guān)于Java向數(shù)據(jù)庫(kù)中插入數(shù)據(jù)后獲取自增ID的常用方法,文中通過(guò)代碼介紹的非常詳細(xì),需要的朋友可以參考下2023-11-11
SpringBoot+hutool實(shí)現(xiàn)圖片驗(yàn)證碼
本文主要介紹了SpringBoot+hutool實(shí)現(xiàn)圖片驗(yàn)證碼,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2022-08-08
使用MockMvc進(jìn)行controller層單元測(cè)試 事務(wù)自動(dòng)回滾的完整案例
這篇文章主要介紹了使用MockMvc進(jìn)行controller層單元測(cè)試 事務(wù)自動(dòng)回滾的完整案例,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2021-06-06
java -jar設(shè)置添加啟動(dòng)參數(shù)實(shí)現(xiàn)方法
這篇文章主要介紹了java -jar設(shè)置添加啟動(dòng)參數(shù)實(shí)現(xiàn)方法,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2023-02-02
springboot中@PostConstruct注解使用小結(jié)
本文主要介紹了springboot中@PostConstruct注解使用小結(jié),文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2025-01-01

