SpringBoot文件下载Controller方法的几种返回值的写法与优劣

1. void 方法，使用 HttpServletResponse 进行文件下载：

@PostMapping("/downloadFile")
public void downloadFile(HttpServletResponse response) {// 实现文件下载逻辑byte[] fileData = /* 从某处获取文件数据 */;try (OutputStream outputStream = response.getOutputStream()) {// 将文件数据通过输出流写入响应outputStream.write(fileData);outputStream.flush();} catch (IOException e) {// 处理异常}
}

优点：
简单直接：实现起来简单，不需要额外的封装和返回对象。流式传输：可以直接将文件内容流式传输到响应中，适合大文件下载。
缺点：
控制有限：对HTTP响应的控制有限，例如，可能更难以设置特定的HTTP头部或以标准化的方式处理错误。
单元测试难度较大：直接与HttpServletResponse交互可能使单元测试难度较大。
适用场景：简单的文件下载场景，不需要复杂的控制和处理。

2. ResponseEntity 方法

@GetMapping("/downloadFile")public ResponseEntity<org.springframework.core.io.Resource> downloadFile() {byte[] fileData = /* 从某处获取文件数据 */;InputStreamResource inputStreamResource = new InputStreamResource(new ByteArrayInputStream(fileData));HttpHeaders headers = new HttpHeaders();// 设置响应头HttpStatus statusCode = /* 设置状态码 */;return new ResponseEntity<>(inputStreamResource, headers, statusCode);}

优点：
更灵活：可以更好地控制HTTP响应，设置头部、状态码，并以标准化的方式处理错误。
可测试性：更易于进行单元测试，因为它返回标准的响应实体。
缺点：
相对复杂：代码可能相对复杂，需要创建Resource并设置额外的头部。
适用场景：
需要更多对HTTP响应的控制、标准化的错误处理和更好的可测试性。

3. StreamingResponseBody 方法：

 @GetMapping("/downloadFile")public StreamingResponseBody downloadFile() {return outputStream -> {byte[] fileData = /* 从某处获取文件数据 */;InputStream inputStream = new ByteArrayInputStream(fileData);byte[] buffer = new byte[4096];int bytesRead;while ((bytesRead = inputStream.read(buffer)) != -1) {outputStream.write(buffer, 0, bytesRead);}inputStream.close();};}