数据导出为Excel接口报错：java.io.IOException: UT010029: Stream is closed
在Spring框架中，开发过程中经常需要实现数据的导出功能，尤其是将数据导出为Excel文件。然而，在实现这样的功能时，可能会遇到一些意料之外的错误，比如java.io.IOException: UT010029: Stream is closed。本文将基于一个实际案例，分析这一错误的原因及解决方案。
问题分析
错误信息
java.io.IOException: UT010029: Stream is closed
at io.undertow.servlet.spec.ServletOutputStreamImpl.write(ServletOutputStreamImpl.java:138)
...
这个错误表明，在尝试向ServletOutputStream写入数据时，流已经被关闭了。通常，这种情况会在以下几种情况下发生：
- 手动关闭了流：在代码中显式调用了
ServletOutputStream.close()。 - 自动关闭：某些框架或组件在处理完请求后会自动关闭流。
实际原因
在Spring MVC中，当一个请求处理器（Controller方法）返回一个值时，Spring MVC会尝试将这个值作为响应体发送。然而，在文件下载的接口中，响应体通常是通过直接写入HttpServletResponse来发送的，而不是通过返回值。如果在这样的接口中添加了返回值，Spring MVC会在响应写入完成后自动关闭流，而由于我们已经通过HttpServletResponse写入了数据，这会导致流的二次关闭，从而引发Stream is closed的错误。
解决方案
修改Controller方法
原来的Controller方法如下：
@GetMapping("/exportExcel")
public R exportExcel(@RequestParam Long formId, @RequestParam String ids, HttpServletResponse response) {// 数据处理和Excel导出逻辑ExportUtil.writeExcel(response, recordsWrapper, ...);return R.success("下载成功！");
}
修改后的Controller方法应该去除返回值，直接通过HttpServletResponse发送响应：
@GetMapping("/exportExcel")
public void exportExcel(@RequestParam Long formId, @RequestParam String ids, HttpServletResponse response) {List<Map<String, Object>> data;List<Long> longIds = Func.toLongList(ids);// 获取表单配置FormEntity formEntity = formService.getById(formId);if (null == formEntity) {throw new ServiceException("未查询到表单");}// 数据处理和Excel导出逻辑try {// ... (省略数据处理代码)ExportUtil.writeExcel(response, recordsWrapper, ...);} catch (IOException e) {log.error(e.toString());}// 注意：没有返回值
}
注意事项
- 去除返回值：确保文件下载接口不返回任何值。
- 异常处理：虽然文件写入过程中可能抛出
IOException，但在实际的生产环境中，通常不应该将异常信息直接返回给用户，而是通过日志记录下来。 - 流的使用：在使用
ServletOutputStream或PrintWriter时，注意不要在代码中显式关闭它们。
结论
在Spring MVC中实现文件下载功能时，需要特别注意流的关闭时机。确保不要在Controller方法中返回任何值，而是通过HttpServletResponse直接发送响应。这样可以避免框架自动关闭流，从而引发Stream is closed的错误。希望这篇文章能够帮助你更好地理解和解决类似的问题。