|
最近碰到個(gè)需要下載zip壓縮包的需求,于是我在網(wǎng)上找了下別人寫好的zip工具類。但找了好多篇博客,總是發(fā)現(xiàn)有bug。因此就自己來寫了個(gè)工具類。 這個(gè)工具類的功能為:
下面直接上代碼 一、代碼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 * ZipUtils14 * @author ZENG.XIAO.YAN15 * @date 2017年11月19日 下午7:16:0816 * @version v1.017 */18 public class ZipUtils {19 20 private static final int BUFFER_SIZE = 2 * 1024;21 22 /**23 * 壓縮成ZIP 方法124 * @param srcDir 壓縮文件夾路徑 25 * @param out 壓縮文件輸出流26 * @param KeepDirStructure 是否保留原來的目錄結(jié)構(gòu),true:保留目錄結(jié)構(gòu); 27 * false:所有文件跑到壓縮包根目錄下(注意:不保留目錄結(jié)構(gòu)可能會(huì)出現(xiàn)同名文件,會(huì)壓縮失敗)28 * @throws RuntimeException 壓縮失敗會(huì)拋出運(yùn)行時(shí)異常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("壓縮完成,耗時(shí):" + (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 方法257 * @param srcFiles 需要壓縮的文件列表58 * @param out 壓縮文件輸出流59 * @throws RuntimeException 壓縮失敗會(huì)拋出運(yùn)行時(shí)異常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("壓縮完成,耗時(shí):" + (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 是否保留原來的目錄結(jié)構(gòu),true:保留目錄結(jié)構(gòu); 99 * false:所有文件跑到壓縮包根目錄下(注意:不保留目錄結(jié)構(gòu)可能會(huì)出現(xiàn)同名文件,會(huì)壓縮失敗)100 * @throws Exception101 */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輸出流中添加一個(gè)zip實(shí)體,構(gòu)造器中name為zip實(shí)體的文件的名字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 entry115 zos.closeEntry();116 in.close();117 } else {118 File[] listFiles = sourceFile.listFiles();119 if(listFiles == null || listFiles.length == 0){120 // 需要保留原來的文件結(jié)構(gòu)時(shí),需要對空文件夾進(jìn)行處理121 if(KeepDirStructure){122 // 空文件夾的處理123 zos.putNextEntry(new ZipEntry(name + "/"));124 // 沒有文件,不需要文件的copy125 zos.closeEntry();126 }127 128 }else {129 for (File file : listFiles) {130 // 判斷是否需要保留原來的文件結(jié)構(gòu)131 if (KeepDirStructure) {132 // 注意:file.getName()前面需要帶上父文件夾的名字加一斜杠,133 // 不然最后壓縮包中就不能保留原來的文件結(jié)構(gòu),即:所有文件都跑到壓縮包根目錄下了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 }二、注意事項(xiàng) 寫該工具類時(shí),有些注意事項(xiàng)說一下: (1)支持選擇是否保留原來的文件目錄結(jié)構(gòu),如果不保留,那么空文件夾直接不用處理。 (1)碰到空文件夾時(shí),如果需要保留目錄結(jié)構(gòu),則直接添加個(gè)ZipEntry就可以了,不過就是這個(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í),需要把文件夾的名字加一斜杠給添加到子文件名字前面,這樣壓縮后才有多級目錄。 三、如何在javaWeb項(xiàng)目中使用該工具類 這個(gè)工具類在web項(xiàng)目中的使用場景就是多文件下載,我就簡單說個(gè)下載多個(gè)excel表格的案例吧。 代碼中的步驟為: (1)創(chuàng)建一個(gè)臨時(shí)文件夾 (2)將要下載的文件生成至該臨時(shí)文件夾內(nèi) (3)當(dāng)所有文件生成完后,獲取HttpServletResponse獲取設(shè)置下載的header (4)調(diào)用工具類的方法,傳入上面生成的臨時(shí)文件夾路徑及response獲取的輸出流;這樣就下載出來zip包了 (5)遞歸刪除掉上面生成的臨時(shí)文件夾和文件 下面為一個(gè)示例代碼的代碼片段,不是完整代碼,簡單看一下代碼中的步驟 1 if(userList.size() > 0){2 /** 下面為下載zip壓縮包相關(guān)流程 */3 HttpServletRequest request = ServletActionContext.getRequest();4 FileWriter writer;5 /** 1.創(chuàng)建臨時(shí)文件夾 */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.生成需要下載的文件,存放在臨時(shí)文件夾內(nèi) */13 // 這里我們直接來10個(gè)內(nèi)容相同的文件為例,但這個(gè)10個(gè)文件名不可以相同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.設(shè)置response的header */30 HttpServletResponse response = ServletActionContext.getResponse();31 response.setContentType("application/zip");32 response.setHeader("Content-Disposition", "attachment; filename=excel.zip"); 33 34 /** 4.調(diào)用工具類,下載zip壓縮包 */35 // 這里我們不需要保留目錄結(jié)構(gòu)36 ZipUtils.toZip(temDir.getPath(), response.getOutputStream(),false);37 38 /** 5.刪除臨時(shí)文件和文件夾 */39 // 這里我沒寫遞歸,直接就這樣刪除了40 File[] listFiles = temDir.listFiles();41 for (int i = 0; i < listFiles.length; i++) {42 listFiles[i].delete();43 }44 temDir.delete();45 } |
|
|