1. 程式人生 > 程式設計 >Java實現把檔案及資料夾壓縮成zip

Java實現把檔案及資料夾壓縮成zip

最近碰到個需要下載zip壓縮包的需求,於是我在網上找了下別人寫好的zip工具類。但找了好多篇部落格,總是發現有bug。因此就自己來寫了個工具類。
這個工具類的功能為:

(1)可以壓縮檔案,也可以壓縮資料夾

(2)同時支援壓縮多級資料夾,工具內部做了遞迴處理

(3)碰到空的資料夾,也可以壓縮

(4)可以選擇是否保留原來的目錄結構,如果不保留,所有檔案跑壓縮包根目錄去了,且空資料夾直接捨棄。注意:如果不保留檔案原來目錄結構,在碰到檔名相同的檔案時,會壓縮失敗。

(5)程式碼中提供了2個壓縮檔案的方法,一個的輸入引數為資料夾路徑,一個為檔案列表,可根據實際需求選擇方法。

下面直接上程式碼

一、程式碼

ZipUtils

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;
/**
 * @author Nemo
 * @version 1.0
 * @date 2019/11/5
 */
public class ZipUtils {
  private static final int BUFFER_SIZE = 2 * 1024;
  /**
   * 壓縮成ZIP 方法1
   * @param sourceFile 壓縮資料夾路徑
   * @param out  壓縮檔案輸出流
   * @param KeepDirStructure 是否保留原來的目錄結構,true:保留目錄結構;
   *             false:所有檔案跑到壓縮包根目錄下(注意:不保留目錄結構可能會出現同名檔案,會壓縮失敗)
   * @throws RuntimeException 壓縮失敗會丟擲執行時異常
   */
  public static void toZip(File sourceFile,OutputStream out,boolean KeepDirStructure)
      throws RuntimeException{
    ZipOutputStream zos = null ;
    try {
      zos = new ZipOutputStream(out);
      compress(sourceFile,zos,sourceFile.getName(),KeepDirStructure);
    } 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,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 是否保留原來的目錄結構,會壓縮失敗)
   * @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,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,name + "/" + file.getName(),KeepDirStructure);
          } else {
            compress(file,file.getName(),KeepDirStructure);
          }
        }
      }
    }
  }
  public static void main(String[] args) throws Exception {
    /** 測試壓縮方法1 */
    FileOutputStream fos1 = new FileOutputStream(new File("c:/mytest01.zip"));
    ZipUtils.toZip(new File("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);
  }
}

二、注意事項

寫該工具類時,有些注意事項說一下:

(1)支援選擇是否保留原來的檔案目錄結構,如果不保留,那麼空資料夾直接不用處理。

(1)碰到空資料夾時,如果需要保留目錄結構,則直接添加個ZipEntry就可以了,不過就是這個entry的名字後面需要帶上一斜槓(/)表示這個是目錄。

(2)遞迴時,不需要把zip輸出流關閉,zip輸出流的關閉應該是在呼叫完遞迴方法後面關閉

(3)遞迴時,如果是個資料夾且需要保留目錄結構,那麼在呼叫方法壓縮他的子檔案時,需要把資料夾的名字加一斜槓給新增到子檔名字前面,這樣壓縮後才有多級目錄。

三、如何在javaWeb專案中使用該工具類

這個工具類在web專案中的使用場景就是多檔案下載,我就簡單說個下載多個excel表格的案例吧。

程式碼中的步驟為:

(1)建立一個臨時資料夾

(2)將要下載的檔案生成至該臨時資料夾內

(3)當所有檔案生成完後,獲取HttpServletResponse獲取設定下載的header

(4)呼叫工具類的方法,傳入上面生成的臨時資料夾路徑及response獲取的輸出流;這樣就下載出來zip包了

(5)遞迴刪除掉上面生成的臨時資料夾和檔案

下面為一個示例程式碼的程式碼片段,不是完整程式碼,簡單看一下程式碼中的步驟

import org.apache.commons.io.FileUtils;
import java.io.*;

/**
   * 圖片打包下載
   * @author: wangzhouchao
   */
  @ApiImplicitParams({
      @ApiImplicitParam(name = "id",value = "申請人id",required = true,dataType = "Long",paramType = "query"),})
  @ApiOperation(value = "圖片打包下載",notes = "圖片打包下載")
  @RequestMapping(value = "/downloadPictureList",method = RequestMethod.GET)
  public void downloadPictureList(TProposerDataVO tProposerDataVO) {

    long readyStart = System.currentTimeMillis();

    // ************* 1. 獲取到存在資料庫中的圖片的url *************
    PictureDownloadVO picturesById = tOrderService.getPicturesByProposerDataId(tProposerDataVO.getId());

    // 獲取當前類的所在專案路徑
    File file = null;
    try {
      file = new File(ResourceUtils.getURL("classpath:").getPath());
    } catch (FileNotFoundException e) {
      throw new RuntimeException("獲取根目錄失敗,無法獲取檔案目錄!");
    }
    if(!file.exists()) {
      file = new File("");
    }
    String absolutePath = file.getAbsolutePath();


    // 要打包的資料夾列表
    String order_number = picturesById.getOrder_number();
    String country_name = picturesById.getCountry_name();
    String visa_type = picturesById.getVisa_type();
    String dirName = order_number + country_name + visa_type;

    // ************* 2. 建立要壓縮的資料夾 *************
    // 根據訂單號+國家名稱+簽證型別建立資料夾
    File dirOfOrder = new File(absolutePath,dirName);
    if(!dirOfOrder.exists()) {
      dirOfOrder.mkdirs();
    }

    ZipOutputStream zos = null;
    OutputStream out = null;

    long readyEnd = System.currentTimeMillis();
    System.out.println("準備完成,耗時:" + (readyEnd - readyStart) + " ms");
    try {

      long downStart = System.currentTimeMillis();


      System.out.println("開始下載");

      TProposerDataVO vo = picturesById.getProposerDataVO();

      // ************* 3. 根據獲取到的圖片的url,把圖片按照想要的資料夾目錄進行下載 *************
      // 根據申請人姓名建立資料夾
      File proposerFile = new File(dirOfOrder,vo.getReal_name());
      if (!proposerFile.exists()) {
        proposerFile.mkdirs();
      }
      // 下載申請人照片
      if (StringUtil.checkNotNull(vo.getPhoto_url())) {
        System.out.println("開始下載申請人照片");
        WordExportUtil.downloadHttpUrl(DOMAIN + vo.getPhoto_url(),proposerFile.toString(),File.separator + "photo.jpg");
      }
      // 下載申請人護照首頁
      if (StringUtil.checkNotNull(vo.getPassport_home_page_url())) {
        System.out.println("開始下載申請人護照照片");
        WordExportUtil.downloadHttpUrl(DOMAIN + vo.getPassport_home_page_url(),File.separator + "passport.jpg");
      }
      // 下載申請人戶口本照片
      if (StringUtil.checkNotNull(vo.getResidence_booklet_url())) {
        System.out.println("開始下載申請人戶口本照片");
        String[] booklets = vo.getResidence_booklet_url().split(",");
        // 建立戶口本照片資料夾
        File bookletsFile = new File(proposerFile,"hukouben");
        if (!bookletsFile.exists()) {
          bookletsFile.mkdirs();
        }
        for (int k = 0; k < booklets.length; k++) {
          WordExportUtil.downloadHttpUrl(DOMAIN + booklets[k],bookletsFile.toString(),File.separator + "residenceBooklet" + k + ".jpg");
        }
      }
      // 下載申請人身份證照片
      if (StringUtil.checkNotNull(vo.getId_card_status()) && vo.getId_card_status() == 0) {
        System.out.println("開始下載申請人身份證照片");
        // 建立身份證照片資料夾
        File idCards = new File(proposerFile,"idCards");
        if (!idCards.exists()) {
          idCards.mkdirs();
        }
        if (StringUtil.checkNotNull(vo.getId_card_positive_url())) {
          WordExportUtil.downloadHttpUrl(DOMAIN + vo.getId_card_positive_url(),idCards.toString(),File.separator + "idCardPostive.jpg");
        }
        if (StringUtil.checkNotNull(vo.getId_card_reverse_url())) {
          WordExportUtil.downloadHttpUrl(DOMAIN + vo.getId_card_reverse_url(),File.separator + "idCardReverse.jpg");
        }
      }
      // 下載申請人婚姻證明照片
      if (StringUtil.checkNotNull(vo.getMar_div_card_url())) {
        System.out.println("開始下載申請人婚姻證明照片");
        WordExportUtil.downloadHttpUrl(DOMAIN + vo.getMar_div_card_url(),File.separator + "marriage.jpg");
      }
      // 下載申請人輔助資產照片
      if (StringUtil.checkNotNull(vo.getAuxiliary_assets_url())) {
        System.out.println("開始下載申請人輔助資產照片");
        String[] auxiliarys = vo.getAuxiliary_assets_url().split(",");
        // 建立輔助資產照片資料夾
        File auxiliarysFile = new File(proposerFile,"fuzhuzichan");
        if (!auxiliarysFile.exists()) {
          auxiliarysFile.mkdirs();
        }
        for (int k = 0; k < auxiliarys.length; k++) {
          WordExportUtil.downloadHttpUrl(DOMAIN + auxiliarys[k],auxiliarysFile.toString(),File.separator + "auxiliary" + k + ".jpg");
        }
      }
      // 下載申請人居住證照片
      if (StringUtil.checkNotNull(vo.getResidence_permit_url())) {
        System.out.println("開始下載申請人居住證照片");
        String[] residences = vo.getResidence_permit_url().split(",");
        // 建立居住證照片資料夾
        File residencesFile = new File(proposerFile,"juzhuzheng");
        if (!residencesFile.exists()) {
          residencesFile.mkdirs();
        }
        for (int k = 0; k < residences.length; k++) {
          WordExportUtil.downloadHttpUrl(DOMAIN + residences[k],residencesFile.toString(),File.separator + "residence" + k + ".jpg");
        }
      }
      // 下載申請人其餘補充資料照片
      if (StringUtil.checkNotNull(vo.getOther_data_url())) {
        System.out.println("開始下載申請人其餘補充資料照片");
        String[] others = vo.getOther_data_url().split(",");
        // 建立其餘補充資料照片資料夾
        File othersFile = new File(proposerFile,"qitabuchongziliao");
        if (!othersFile.exists()) {
          othersFile.mkdirs();
        }
        for (int k = 0; k < others.length; k++) {
          WordExportUtil.downloadHttpUrl(DOMAIN + others[k],othersFile.toString(),File.separator + "other" + k + ".jpg");
        }
      }
      // 下載申請人證明資料照片
      if (StringUtil.checkNotNull(vo.getProve_url())) {
        System.out.println("開始下載申請人證明資料照片");
        String[] prove_urls = vo.getProve_url().split(",");
        // 建立證明資料照片資料夾
        File proveFile = new File(proposerFile,"zhengmingziliao");
        if (!proveFile.exists()) {
          proveFile.mkdirs();
        }
        for (int k = 0; k < prove_urls.length; k++) {
          WordExportUtil.downloadHttpUrl(DOMAIN + prove_urls[k],proveFile.toString(),File.separator + "prove" + k + ".jpg");
        }
      }

      long downEnd = System.currentTimeMillis();
      System.out.println("下載完成,耗時:" + (downEnd - downStart) + " ms");
      long zipStart = System.currentTimeMillis();

      response.setContentType("application/x-zip-compressed");
      response.setHeader("Content-disposition","attachment;filename=" + StringUtil.getUUID() + ".zip");
      out = response.getOutputStream();
      zos = new ZipOutputStream(out);

      // ************* 4. 把要壓縮的資料夾路徑、壓縮檔案輸出流傳入到ZipUtils.toZip方法,對資料夾進行壓縮 *************
      // 對資料夾進行壓縮,保留原資料夾路徑
      ZipUtils.toZip(dirOfOrder,out,true);
      long zipEnd = System.currentTimeMillis();
      System.out.println("壓縮完成,耗時:" + (zipEnd - zipStart) + " ms");

      out.flush();
    } catch (IOException e) {
      e.printStackTrace();
    } catch (Exception e) {
      throw new RuntimeException("zip error from ZipUtils",e);
    } finally {
      if (zos != null) {
        try {
          zos.close();
        } catch (IOException e) {
          e.printStackTrace();
        }
      }
      if (out != null) {
        try {
          zos.close();
          out.close();
        } catch (IOException e) {
          e.printStackTrace();
        }
      }
    }

    // ************* 5. 刪除壓縮前準備的中間檔案 *************
    if (dirOfOrder != null) {
      try {
        FileUtils.deleteDirectory(dirOfOrder);
        System.out.println("中間檔案已刪除");
      } catch (IOException e) {
        e.printStackTrace();
        System.out.println("中間檔案刪除失敗");
      }
    }
  }

以上就是本文的全部內容,希望對大家的學習有所幫助,也希望大家多多支援我們。