Spring Boot中如何流式输出SXSSFWorkbook避免大文件内存占用？

我明白你现在的痛点：用SXSSF生成百万行Excel时，先转成字节数组会占大量内存，而直接写response输出流又导致文件损坏。下面我来一步步帮你搞定这个问题。

为什么直接写response流会损坏文件？ #

通常出现这种情况的原因有几个：

• 没有正确flush并关闭输出流，导致部分内容没写入客户端
• Spring的ResponseEntity机制和直接操作HttpServletResponse逻辑冲突
• 响应头设置不完整或编码问题，比如文件名包含特殊字符时没转码
• 没有调用SXSSFWorkbook.dispose()清理临时文件，导致输出内容不完整

正确的流式输出实现方案 #

我们需要直接在控制器方法中操作HttpServletResponse的输出流，完全绕过ResponseEntity（因为它会把所有内容加载到内存再返回），同时正确处理资源释放和流操作。

完整代码示例 #

@RequestMapping(path = "/download/xls", method = RequestMethod.GET)
public void downloadXls(HttpServletResponse response, XlsRequest request) throws IOException {
    // 1. 设置响应头，处理文件名编码避免乱码
    response.setContentType("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet");
    String fileName = URLEncoder.encode("justAFile.xlsx", StandardCharsets.UTF_8.toString());
    response.setHeader("Content-Disposition", String.format("attachment; filename=\"%s\"; filename*=UTF-8''%s", fileName, fileName));
    response.setHeader("Content-Transfer-Encoding", "binary");
    
    SXSSFWorkbook workbook = null;
    OutputStream outputStream = null;
    try {
        // 2. 创建SXSSF工作簿，设置内存保留行数（超出部分写入临时文件）
        workbook = createExcel(request);
        outputStream = response.getOutputStream();
        
        // 3. 直接将工作簿写入输出流
        workbook.write(outputStream);
        // 强制刷新输出流，确保所有内容发送到客户端
        outputStream.flush();
    } catch (Exception e) {
        throw new InternalServerErrorException("IO exception while downloading XLS file", e);
    } finally {
        // 4. 必须清理SXSSF临时文件，释放资源
        if (workbook != null) {
            workbook.dispose();
            workbook.close();
        }
        if (outputStream != null) {
            outputStream.close();
        }
    }
}

// 修改createExcel方法，仅负责构建工作簿，无需传入response
private SXSSFWorkbook createExcel(XlsRequest request) {
    // 设置内存窗口大小，按需调整，这里保留1000行在内存
    SXSSFWorkbook workbook = new SXSSFWorkbook(1000);
    SXSSFSheet sheet = workbook.createSheet("Data");
    
    // 写入表头
    Row headerRow = sheet.createRow(0);
    headerRow.createCell(0).setCellValue("ID");
    headerRow.createCell(1).setCellValue("Name");
    
    // 模拟写入百万行数据（替换成你的业务逻辑）
    for (int i = 1; i <= 1000000; i++) {
        Row row = sheet.createRow(i);
        row.createCell(0).setCellValue(i);
        row.createCell(1).setCellValue("Item " + i);
    }
    return workbook;
}

关键注意点 #

• 放弃ResponseEntity：它会强制把所有内容加载到内存，完全违背SXSSF流式输出的初衷
• 处理文件名编码：用URLEncoder编码文件名，避免中文或特殊字符导致的下载异常
• 必须调用workbook.dispose()：SXSSF会把超出内存窗口的行写入临时文件，调用该方法才能删除这些临时文件，避免磁盘空间泄漏
• 强制flush输出流：确保所有内容都发送到客户端，避免文件末尾缺失导致损坏
• 调整SXSSF窗口大小：new SXSSFWorkbook(1000)表示内存保留1000行，可根据服务器内存情况灵活调整

原代码问题分析 #

你之前尝试直接写response流的代码，大概率存在这些问题：

1. 没有强制flush输出流，部分内容留在缓冲区未发送
2. createExcel方法中可能误操作了response，导致输出内容混乱
3. 异常情况下未正确释放资源，比如工作簿未关闭、临时文件未清理

这样调整后，就能实现真正的流式输出，内存占用会非常低（仅保留设置的窗口行数），同时生成的Excel文件不会损坏。

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