java實(shí)現(xiàn)文件壓縮成zip的工具類(lèi)
最近碰到個(gè)需要下載zip壓縮包的需求,于是我在網(wǎng)上找了下別人寫(xiě)好的zip工具類(lèi)。但找了好多篇博客,總是發(fā)現(xiàn)有bug。因此就自己來(lái)寫(xiě)了個(gè)工具類(lèi)。
這個(gè)工具類(lèi)的功能為:
(1)可以壓縮文件,也可以壓縮文件夾
(2)同時(shí)支持壓縮多級(jí)文件夾,工具內(nèi)部做了遞歸處理
(3)碰到空的文件夾,也可以壓縮
(4)可以選擇是否保留原來(lái)的目錄結(jié)構(gòu),如果不保留,所有文件跑壓縮包根目錄去了,且空文件夾直接舍棄。注意:如果不保留文件原來(lái)目錄結(jié)構(gòu),在碰到文件名相同的文件時(shí),會(huì)壓縮失敗。
(5)代碼中提供了2個(gè)壓縮文件的方法,一個(gè)的輸入?yún)?shù)為文件夾路徑,一個(gè)為文件列表,可根據(jù)實(shí)際需求選擇方法。
下面直接上代碼
一、代碼
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 GDL * @date 2017年11月20日 * @version v1.0 */ public class ZipUtils { 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")); ZipUtils.toZip("D:/log", 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")); ZipUtils.toZip(fileList, fos2); } }
二、注意事項(xiàng)
寫(xiě)該工具類(lèi)時(shí),有些注意事項(xiàng)說(shuō)一下:
(1)支持選擇是否保留原來(lái)的文件目錄結(jié)構(gòu),如果不保留,那么空文件夾直接不用處理。
(2)碰到空文件夾時(shí),如果需要保留目錄結(jié)構(gòu),則直接添加個(gè)ZipEntry就可以了,不過(guò)就是這個(gè)entry的名字后面需要帶上一斜杠(/)表示這個(gè)是目錄。
(3)遞歸時(shí),不需要把zip輸出流關(guān)閉,zip輸出流的關(guān)閉應(yīng)該是在調(diào)用完遞歸方法后面關(guān)閉
(4)遞歸時(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) ZipUtils.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(); }
以上就是本文的全部?jī)?nèi)容,希望對(duì)大家的學(xué)習(xí)有所幫助,也希望大家多多支持腳本之家。
相關(guān)文章
java Scanner輸入數(shù)字、字符串過(guò)程解析
這篇文章主要介紹了java Scanner輸入數(shù)字、字符串過(guò)程解析,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2019-10-10Java的super關(guān)鍵字與instanceof運(yùn)算符使用方法
這篇文章主要介紹了Java的super關(guān)鍵字與instanceof運(yùn)算符使用方法,是Java入門(mén)學(xué)習(xí)中的基礎(chǔ)知識(shí),需要的朋友可以參考下2015-09-09IntelliJ IDEA 2021.1 首個(gè) Beta 版本發(fā)布
這篇文章主要介紹了IntelliJ IDEA 2021.1 首個(gè) Beta 版本發(fā)布,本文通過(guò)圖文并茂的形式給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2021-03-03Java中shiro框架和security框架的區(qū)別
這篇文章主要介紹了Java中shiro框架和security框架的區(qū)別,shiro和security作為兩款流行的功能強(qiáng)大的且易于使用的java安全認(rèn)證框架,在近些年中的項(xiàng)目開(kāi)發(fā)過(guò)程中使用廣泛,今天我們就來(lái)一起了解一下兩者的區(qū)別2023-08-08使用Mybatis-Plus時(shí)的SqlSessionFactory問(wèn)題及處理
這篇文章主要介紹了使用Mybatis-Plus時(shí)的SqlSessionFactory問(wèn)題及處理方式,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2021-12-12java內(nèi)存泄漏與內(nèi)存溢出關(guān)系解析
這篇文章主要介紹了java內(nèi)存泄漏與內(nèi)存溢出關(guān)系解析,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2019-12-12maven基礎(chǔ)教程——簡(jiǎn)單了解maven的特點(diǎn)與功能
這篇文章主要介紹了Maven基礎(chǔ)教程的相關(guān)資料,文中講解非常細(xì)致,幫助大家開(kāi)始學(xué)習(xí)maven,感興趣的朋友可以了解下2020-07-07