SpringBoot应用中下载文件的3种实现方式
1、背景
用户需要从第三方文件服务系统下载文件，后端代理提供一个三方文件服务系统的下载接口。在使用SpringBoot开发的应用中，一般会使用RestTemplate客户端请求第三方的下载文件接口，将文件返回给前端用户。
2、什么是RestTemplate
RestTemplate是Spring框架中提供的一个用于发送HTTP请求的类，它简化了与RESTful Web服务的交互。使用RestTemplate，可以发送GET、POST、PUT、DELETE等HTTP请求，并获取HTTP响应。它可以处理请求和响应中的JSON、XML等数据格式，并支持数据类型转换和错误处理。
RestTemplate的主要作用是封装HTTP通信的细节，开发人员只需要关注业务逻辑即可。
3、使用RestTemplate下载文件
下面的3种实现方式，不同的方式各有优缺点。
3.1、方式1：内存中转下载
这种方式只适合小文件和并发量小的场景，如果文件较大，可能导致内存消耗较大，因为接口会先把文件从第三方完整下载到SpringBoot微服务的内存，再写出到客户端的响应输出流中。
import java.io.IOException;
/**
* 文件下载示例:使用restTemplate请求第三方文件服务下载文件
*
* @author Bruce.CH
* @since 2023年9月2日
*/
@RestController
public class FileController {
private static final Logger LOGGER = LoggerFactory.getLogger(FileController.class);
/**
* 第三方文件服务下载接口
*/
private static final String DOWNLOAD_URL = "http://127.0.0.1:8080/v1/file/server/download/{fileId}";
/**
* 注入restTemplate对象
*/
@Resource
private RestTemplate restTemplate;
/**
* 【方式1】
* 请求第三方文件服务下载接口下载文件id指定的文件：字节流先保存到本地的字节数组中，再写入到响应的输出流
*
* @param fileId 第三方文件id
* @param response 客户端响应
* @throws IOException IO异常
*/
@GetMapping("/v1/file/download/{fileId}")
public void download(@PathVariable("fileId") String fileId, HttpServletResponse response) throws IOException {
LOGGER.info("download file:{}", fileId);
Map<String, String> uriVariables = new HashMap<>();
uriVariables.put("fileId", fileId);
// 响应类型不支持InputStream类型，使用Resource或byte[]接收三方文件服务返回的文件字节流
ResponseEntity<byte[]> responseEntity = restTemplate.exchange(DOWNLOAD_URL, HttpMethod.GET, null,
byte[].class, uriVariables);
// 设置请求头，直接用第三方文件服务的响应头
HttpHeaders headers = responseEntity.getHeaders();
headers.forEach((key, value) -> response.setHeader(key, value.get(0)));
// 获取整个文件内容的字节数组后拷贝写入到输出流: inputStream -> byte[] -> outputStream
StreamUtils.copy(responseEntity.getBody(), response.getOutputStream());
LOGGER.info("download file success");
}
}
3.2、方式2：临时文件中转下载
这种方式，如果文件较大，响应时间会比较满，但可以减少内存的消耗，因为接口会先把文件从第三方完整下载保存到本地临时文件，然后再从临时文件读取内容写出到客户端的响应输出流中。对响应时间要求不严格的，可以使用这种方式。
/**
* 文件下载示例:使用restTemplate请求第三方文件服务下载文件
*
* @author Bruce.CH
* @since 2023年9月2日
*/
@RestController
public class FileController {
private static final Logger LOGGER = LoggerFactory.getLogger(FileController.class);
/**
* 第三方文件服务下载接口
*/
private static final String DOWNLOAD_URL = "http://127.0.0.1:8080/v1/file/server/download/{fileId}";
/**
* 注入restTemplate对象
*/
@Resource
private RestTemplate restTemplate;
/**
* 【方式2】
* 请求第三方文件服务下载接口下载文件id指定的文件：收到响应即时保存到临时文件，然后再读取临时文件内容写出到客户端的响应输出流中
*
* @param fileId 第三方文件id
* @param response 客户端响应
*/
@GetMapping("/v1/file/download2/{fileId}")
public void download2(@PathVariable("fileId") String fileId, HttpServletResponse response) {
LOGGER.info("download file:{}", fileId);
Map<String, String> uriVariables = new HashMap<>();
uriVariables.put("fileId", fileId);
ResponseExtractor<Boolean> responseExtractor = clientHttpResponse -> {
// 获取文件名称
HttpHeaders headers = clientHttpResponse.getHeaders();
ContentDisposition contentDisposition = headers.getContentDisposition();
String filename = contentDisposition.getFilename();
File tmpFile = new File("D:\\temp\\download\\tmp\\" + UUID.randomUUID() + "\\" + filename);
try {
// 1、先保存到临时文件
boolean mkdirs = tmpFile.getParentFile().mkdirs();
LOGGER.info("mk tmp file dirs? {}", mkdirs);
StreamUtils.copy(clientHttpResponse.getBody(), new FileOutputStream(tmpFile));
// 直接用第三方文件服务的响应头
headers.forEach((key, value) -> response.setHeader(key, value.get(0)));
// 2、读取临时文件内容写出到响应输出流中: inputStream -> tmpFile -> outputStream
StreamUtils.copy(new FileInputStream(tmpFile), response.getOutputStream());
} finally {
// 3、清理临时文件和UUID目录
if (tmpFile.exists()) {
boolean delete = tmpFile.delete();
boolean deleteDir = tmpFile.getParentFile().delete();
LOGGER.info("tmp file delete ? {}", delete && deleteDir);
}
}
return true;
};
Boolean execute = restTemplate.execute(DOWNLOAD_URL, HttpMethod.GET, null, responseExtractor, uriVariables);
LOGGER.info("download file success?{}", execute);
}
}
3.3、方式3：缓冲区中转下载
对比前面的两种方式，方式3整体性能较好，因为接口会从第三方文件服务的响应后，立即读取输入流，将输入流中的文件内容直接写出到客户端的响应输出流中。
/**
* 文件下载示例:使用restTemplate请求第三方文件服务下载文件
*
* @author Bruce.CH
* @since 2023年9月2日
*/
@RestController
public class FileController {
private static final Logger LOGGER = LoggerFactory.getLogger(FileController.class);
/**
* 第三方文件服务下载接口
*/
private static final String DOWNLOAD_URL = "http://127.0.0.1:8080/v1/file/server/download/{fileId}";
/**
* 注入restTemplate对象
*/
@Resource
private RestTemplate restTemplate;
/**
* 【方式3】
* 请求第三方文件服务下载接口下载文件id指定的文件：字节流直接绑定到响应的输出流中
*
* @param fileId 第三方文件id
* @param response 客户端响应
*/
@GetMapping("/v1/file/download3/{fileId}")
public void download3(@PathVariable("fileId") String fileId, HttpServletResponse response) {
LOGGER.info("download file:{}", fileId);
Map<String, String> uriVariables = new HashMap<>();
uriVariables.put("fileId", fileId);
ResponseExtractor<Boolean> responseExtractor = clientHttpResponse -> {
// 设置响应头，直接用第三方文件服务的响应头
HttpHeaders headers = clientHttpResponse.getHeaders();
headers.forEach((key, value) -> response.setHeader(key, value.get(0)));
// 收到响应输入流即时拷贝写出到响应输出流中: inputStream -> outputStream
StreamUtils.copy(clientHttpResponse.getBody(), response.getOutputStream());
return true;
};
Boolean execute = restTemplate.execute(DOWNLOAD_URL, HttpMethod.GET, null, responseExtractor, uriVariables);
LOGGER.info("download file success?{}", execute);
}
}
4、小结
以上3种SpringBoot应用中使用RestTemplate下载文件的方式中，各有优缺点，推荐方式优先顺序为：方式3 > 方式2 > 方式1。