如何基于SpringBoot Rest API与Apache CXF实现大Zip文件（1-2GB）下载？

嘿，我看你在尝试用Spring Boot Rest API结合Apache CXF实现1-2GB大小的Zip文件下载时，用OutputStream的方式没成功，代码里用了StreamingResponseBody但好像没达到预期。我之前也碰到过类似的坑，来帮你分析下问题和解决办法：

可能的问题点 #

首先，Apache CXF对Spring的StreamingResponseBody支持可能存在适配问题，默认情况下CXF可能会对响应做缓冲，导致大文件无法流式输出；另外你的代码里也有几个小细节没处理好：比如InputStream没关闭、缓冲区大小太小（1KB对于大文件来说效率太低），还有响应头没正确设置，这些都可能导致下载失败或者异常。

解决方案1：修复StreamingResponseBody的实现 #

先把你的代码补全并优化，同时确保CXF配置支持流式响应：

1.1 完善接口代码 #

用try-with-resources自动关闭InputStream，调整缓冲区大小，添加正确的响应头：

@GetMapping("/download-large-zip")
public ResponseEntity<StreamingResponseBody> downloadLargeZip() throws IOException {
    File zipFile = new File("path/to/your/large/file.zip");
    
    // 设置响应头，告诉浏览器这是zip文件，指定下载文件名
    HttpHeaders headers = new HttpHeaders();
    headers.setContentType(MediaType.APPLICATION_OCTET_STREAM);
    headers.setContentDisposition(ContentDisposition.attachment()
            .filename(zipFile.getName())
            .build());
    // 如果知道文件大小，设置Content-Length，让浏览器显示下载进度
    headers.setContentLength(zipFile.length());

    StreamingResponseBody responseBody = outputStream -> {
        // 用8KB缓冲区，比1KB效率高很多
        byte[] buffer = new byte[8192];
        try (InputStream inputStream = new FileInputStream(zipFile)) {
            int bytesRead;
            while ((bytesRead = inputStream.read(buffer)) != -1) {
                outputStream.write(buffer, 0, bytesRead);
                // 强制刷新输出流，避免缓冲区积压
                outputStream.flush();
            }
        }
    };

    return new ResponseEntity<>(responseBody, headers, HttpStatus.OK);
}

1.2 配置Apache CXF支持流式响应 #

在CXF的配置类里，需要禁用响应缓冲，设置流式传输：

@Configuration
public class CxfConfig {

    @Bean
    public ServletRegistrationBean<CXFServlet> cxfServlet() {
        ServletRegistrationBean<CXFServlet> registration = new ServletRegistrationBean<>(new CXFServlet());
        registration.addUrlMappings("/api/*");
        return registration;
    }

    @Bean(name = Bus.DEFAULT_BUS_ID)
    public SpringBus springBus() {
        SpringBus bus = new SpringBus();
        // 禁用CXF的响应缓冲，确保流式输出生效
        bus.setProperty("org.apache.cxf.transport.http.disable.output.buffer", Boolean.TRUE);
        return bus;
    }
}

解决方案2：使用Apache CXF原生的StreamingOutput #

如果上面的方式还是有问题，推荐用CXF原生的StreamingOutput接口，这是CXF专门为流式响应设计的，兼容性更好：

@GET
@Path("/download-large-zip")
@Produces(MediaType.APPLICATION_OCTET_STREAM)
public Response downloadLargeZip() throws IOException {
    File zipFile = new File("path/to/your/large/file.zip");

    StreamingOutput streamingOutput = outputStream -> {
        byte[] buffer = new byte[8192];
        try (InputStream inputStream = new FileInputStream(zipFile)) {
            int bytesRead;
            while ((bytesRead = inputStream.read(buffer)) != -1) {
                outputStream.write(buffer, 0, bytesRead);
                outputStream.flush();
            }
        }
    };

    return Response.ok(streamingOutput)
            .header(HttpHeaders.CONTENT_DISPOSITION, "attachment; filename=\"" + zipFile.getName() + "\"")
            .header(HttpHeaders.CONTENT_LENGTH, zipFile.length())
            .build();
}

这个方式不需要依赖Spring的StreamingResponseBody，完全用CXF的API实现，更适配CXF的运行环境。

额外注意事项 #

• 确保服务器的连接超时时间设置足够长，因为大文件下载需要时间，避免中途断开。
• 如果部署在Tomcat等容器中，需要调整容器的响应缓冲设置，比如Tomcat的maxSwallowSize参数，避免容器截断大响应。
• 测试的时候可以用curl或者Postman，避免部分浏览器自带的文件大小限制影响测试结果。

内容的提问来源于stack exchange，提问作者karthick tk