Java實現將文件或者文件夾壓縮成zip

時間  2019-11-09
標籤 java 現將 文件 或者 文件夾 壓縮 zip 欄目 Java 简体版
原文   原文鏈接
         最近碰到個須要下載zip壓縮包的需求，因而我在網上找了下別人寫好的zip工具類。但找了好多篇博客，老是發現有bug。所以就本身來寫了個工具類。
        這個工具類的功能爲：
      • （1）能夠壓縮文件，也能夠壓縮文件夾
      • （2）同時支持壓縮多級文件夾，工具內部作了遞歸處理
      • （3）碰到空的文件夾，也能夠壓縮
      • （4）能夠選擇是否保留原來的目錄結構，若是不保留，全部文件跑壓縮包根目錄去了，且空文件夾直接捨棄。注意：若是不保留文件原來目錄結構，在碰到文件名相同的文件時，會壓縮失敗。
      • （5）代碼中提供了2個壓縮文件的方法，一個的輸入參數爲文件夾路徑，一個爲文件列表，可根據實際需求選擇方法。
      
        下面直接上代碼

1、代碼

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);
	}
}


2、注意事項

    寫該工具類時，有些注意事項說一下：
        （1）支持選擇是否保留原來的文件目錄結構，若是不保留，那麼空文件夾直接不用處理。
        （1）碰到空文件夾時，若是須要保留目錄結構，則直接添加個ZipEntry就能夠了，不過就是這個entry的名字後面須要帶上一斜槓（/）表示這個是目錄。
        （2）遞歸時，不須要把zip輸出流關閉，zip輸出流的關閉應該是在調用完遞歸方法後面關閉
        （3）遞歸時，若是是個文件夾且須要保留目錄結構，那麼在調用方法壓縮他的子文件時，須要把文件夾的名字加一斜槓給添加到子文件名字前面，這樣壓縮後纔有多級目錄。

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();
	}
相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程