手把手教你用SpringBoot将文件打包成zip存放或导出

我来为您详细讲解一下“手把手教你用SpringBoot将文件打包成zip存放或导出”的完整攻略。

1. 背景信息

在进行Web开发过程中，经常会有需要将多个文件打包成一个压缩包进行存储或导出的需求。在SpringBoot中，我们可以使用Java自带的压缩工具类java.util.zip.ZipOutputStream来实现此功能。

2. 准备工作

首先，我们需要在项目中添加以下Maven依赖：

<dependency>
    <groupId>org.apache.commons</groupId>
    <artifactId>commons-compress</artifactId>
    <version>1.20</version>
</dependency>

这个依赖包含了一些常见的压缩格式的解析和生成工具类，比如zip、gz、tar等。

3. 打包文件

下面是一个示例代码，演示了如何将指定的文件打包成zip格式，并保存到指定的目录下：

import org.apache.commons.compress.archivers.zip.ZipArchiveEntry;
import org.apache.commons.compress.archivers.zip.ZipArchiveOutputStream;

import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;

public class ZipUtils {
    public static void zipFiles(File[] files, String zipFilePath) throws IOException {
        try (FileOutputStream fos = new FileOutputStream(zipFilePath);
             ZipArchiveOutputStream zos = new ZipArchiveOutputStream(fos)) {

            // 设置压缩级别，默认是最高的压缩比
            zos.setLevel(9);

            for (File file : files) {
                // 添加一个zip条目，并将文件内容写入条目
                ZipArchiveEntry zipEntry = new ZipArchiveEntry(file.getName());
                zos.putArchiveEntry(zipEntry);
                try (FileInputStream fis = new FileInputStream(file)) {
                    byte[] buffer = new byte[1024];
                    int len;
                    while ((len = fis.read(buffer)) > 0) {
                        zos.write(buffer, 0, len);
                    }
                }
                zos.closeArchiveEntry();
            }
        }
    }
}

其中，files参数为一个File数组，指定需要打包的文件列表；zipFilePath参数为指定的文件存放路径。

4. 导出文件

下面是另一个示例代码，演示了如何将压缩文件导出到HTTP响应流中，供用户下载：

import javax.servlet.http.HttpServletResponse;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.OutputStream;

public class DownloadController {

    @RequestMapping("/download")
    public void download(HttpServletResponse response) throws IOException {
        // 设置导出的文件名
        response.setHeader("Content-Disposition", "attachment; filename=test.zip");
        // 设置导出内容的类型
        response.setContentType("application/octet-stream");

        // 读取压缩文件内容，并输出到HTTP响应流中
        try (FileInputStream fis = new FileInputStream(new File("/path/to/test.zip"));
             OutputStream out = response.getOutputStream()) {

            byte[] buffer = new byte[1024];
            int len;
            while ((len = fis.read(buffer)) > 0) {
                out.write(buffer, 0, len);
            }
            out.flush();
        }
    }
}

在这个示例代码中，我们使用了HttpServletResponse对象来向浏览器发送HTTP响应。Content-Disposition头告诉浏览器导出的文件名和类型，application/octet-stream表示要导出的是二进制文件，不是普通的HTML页面。

5. 总结

通过使用Java自带的压缩工具类，我们可以非常方便地将多个文件打包成一个压缩文件，并将压缩文件导出到HTTP响应流中供用户下载。希望这个攻略能够帮到你。