SpringBoot将文件打包成zip存放或导出

浅浅的花香味﹌ 2022-10-05 13:59 364阅读 0赞

### 目录 ###

*  前言
 *  环境准备
 *  将文件打包成Zip存放
 *   *  代码
     *  测试
 *  将文件打包成zip并导出
 *   *  代码
     *  测试
 *  结尾

# 前言 #

相信各位看官在工作中都会遇到过要把多个文件打包成一个压缩文件然后导出，或者将文件打包成Zip存放，这就来上代码，废话不多说。

# 环境准备 #

其实也没什么准备，准备好Springboot就行，还有几张图片：  
![在这里插入图片描述][20210609163732184.png]

# 将文件打包成Zip存放 #

## 代码 ##

**Controller**代码：

@RequestMapping("/zip")
    @RestController
    public class ZipController { 
    
        /** * 将文件打包成zip并存放在特定位置 */
        @PostMapping("package")
        public void packageFileToZip() throws IOException { 
            // 为了方便我直接将文件地址写好了，各位可以根据自己的情况修改
            String[] filePath = new String[]{ "E:\\ykds\\1068128498917799516.jpg", "E:\\ykds\\1068128498917917980.jpg", "E:\\ykds\\1068128498917807874.jpg"};
            // 将需要打包的文件都放在一个集合中
            List<File> fileList = new ArrayList<>();
            for (String s : filePath) { 
                File file = new File(s);
                fileList.add(file);
            }
            // 先在D盘创建一个压缩包
            File zipFile = new File("D:\\package.zip");
            if(!zipFile.exists())
                zipFile.createNewFile();
            // 将package.zip的File对象传到toZip对象中
            ZipUtils.toZip(fileList, zipFile);
        }
    }

**ZipUTils工具类**代码

public class ZipUtils { 
    
        /** * 把文件集合打成zip压缩包 * @param srcFiles 压缩文件集合 * @param zipFile zip文件名 * @throws RuntimeException 异常 */
        public static void toZip(List<File> srcFiles, File zipFile) throws IOException { 
            if(zipFile == null){ 
                return;
            }
            if(!zipFile.getName().endsWith(".zip")){ 
                return;
            }
            ZipOutputStream zos = null;
            FileOutputStream out = new FileOutputStream(zipFile);
            try { 
                zos = new ZipOutputStream(out);
                for (File srcFile : srcFiles) { 
                    byte[] buf = new byte[BUFFER_SIZE];
                    zos.putNextEntry(new ZipEntry(srcFile.getName()));
                    int len;
                    // 读取文件并写入到zip中
                    FileInputStream in = new FileInputStream(srcFile);
                    while ((len = in.read(buf)) != -1) { 
                        zos.write(buf, 0, len);
                        zos.flush();
                    }
                    in.close();
                }
    
            } catch (Exception e) { 
                e.printStackTrace();
            }finally { 
                if (zos != null) { 
                    zos.close();
                }
            }
        }
    }

## 测试 ##

代码打好了，接下来测试下，打开熟悉的postman：  
![在这里插入图片描述][20210609170322672.png]  
调用接口后就会在D盘中新建一个package.zip的压缩包：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODE2ODk0Nw_size_16_color_FFFFFF_t_70]  
可以看到，我打包的文件都在这里，再看看能不能正常显示：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODE2ODk0Nw_size_16_color_FFFFFF_t_70 1]  
very good!

# 将文件打包成zip并导出 #

上面的方法只是将压缩包保存在本地，如果需要导出的话代码有点不一样。

## 代码 ##

**Controller**代码:

/** * 将文件打包成zip并下载 */
        @PostMapping("download")
        public void download(HttpServletResponse response) throws IOException { 
            // 这里还是和上面一样
            String[] filePath = new String[]{ "E:\\ykds\\1068128498917799516.jpg", "E:\\ykds\\1068128498917917980.jpg", "E:\\ykds\\1068128498917807874.jpg"};
            List<File> fileList = new ArrayList<>();
            for (String s : filePath) { 
                File file = new File(s);
                fileList.add(file);
            }
            response.setHeader("content-type", "application/octet-stream");
            response.setContentType("application/octet-stream");
            response.setHeader(HttpHeaders.CONTENT_DISPOSITION, "attachment; filename=download.zip");
            ZipUtils.downloadZip(response.getOutputStream(), fileList);
        }

**ZipUtils工具类**代码

public static void downloadZip(OutputStream outputStream, List<File> fileList){ 
            BufferedInputStream bufferedInputStream = null;
            ZipOutputStream zipOutputStream = null;
            try { 
                zipOutputStream = new ZipOutputStream(outputStream);
                for (File file : fileList) { 
                    ZipEntry zipEntry = new ZipEntry(file.getName());
                    zipOutputStream.putNextEntry(zipEntry);
                    byte[] buf = new byte[BUFFER_SIZE];
                    int len;
                    FileInputStream in = new FileInputStream(file);
                    while ((len = in.read(buf)) != -1) { 
                        zipOutputStream.write(buf, 0, len);
                        zipOutputStream.flush();
                    }
                }
                zipOutputStream.flush();
                zipOutputStream.close();
    
            } catch (IOException e) { 
                e.printStackTrace();
            } finally { 
                // 关闭流
                try { 
                    if (bufferedInputStream != null) { 
                        bufferedInputStream.close();
                    }
                    if (zipOutputStream != null ) { 
                        zipOutputStream.close();
                    }
                    if (outputStream != null) { 
                        outputStream.close();
                    }
                } catch (IOException e) { 
                    e.printStackTrace();
                }
            }
    
        }

## 测试 ##

还是用postman：  
![在这里插入图片描述][20210609172140480.png]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODE2ODk0Nw_size_16_color_FFFFFF_t_70 2]  
下载完成后打开看看  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODE2ODk0Nw_size_16_color_FFFFFF_t_70 3]  
very good!

# 结尾 #

zip的分享就到这里啦，各位喜欢的话可以点个赞哦！

[20210609163732184.png]: /images/20221005/d714c8b6dcb34e18a632b9dec57091a9.png
[20210609170322672.png]: /images/20221005/fa71fc10c880444995c42d5b52feeca4.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODE2ODk0Nw_size_16_color_FFFFFF_t_70]: /images/20221005/034788d88aa6488cb66ccc9dbaba56c1.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODE2ODk0Nw_size_16_color_FFFFFF_t_70 1]: /images/20221005/a33e4e62172c4e78a74ab403fa1df3dc.png
[20210609172140480.png]: /images/20221005/a8b1852818ec4cea9e90dbb020cb3f75.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODE2ODk0Nw_size_16_color_FFFFFF_t_70 2]: /images/20221005/6f56ff2610a6460e972433ef288ddb64.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODE2ODk0Nw_size_16_color_FFFFFF_t_70 3]: /images/20221005/b5fc828def904bcab8e97632788802bb.png