精讲RestTemplate第6篇-文件上传下载与大文件流式下载

本文是精讲RestTemplate第6篇，前篇的blog访问地址如下：

• 精讲RestTemplate第1篇-在Spring或非Spring环境下如何使用
• 精讲RestTemplate第2篇-多种底层HTTP客户端类库的切换
• 精讲RestTemplate第3篇-GET请求使用方法详解
• 精讲RestTemplate第4篇-POST请求方法使用详解
• 精讲RestTemplate第5篇-DELETE、PUT等请求方法使用详解

RestTemplate是HTTP客户端库，所以为了使用RestTemplate进行文件上传和下载，需要我们先编写服务端的支持文件上传和下载的程序。请参考我之前写的一篇文章：SpringBoot实现本地存储文件上传及提供HTTP访问服务 。按照此文完成学习之后，可以获得

• 一个以访问服务URI为"/upload”的文件上传服务端点
• 服务端点上传文件成功后会返回一个HTTP连接,可以用来下载文件。

下面我们就开始学习使用RestTemplate是HTTP客户端库，进行文件的上传与下载。

一、文件上传

写一个单元测试类，来完成RestTemplate文件上传功能，具体实现细节参考代码注释

@SpringBootTest
class UpDownLoadTests {

   @Resource
   private RestTemplate restTemplate;

   @Test
   void testUpload()  {
      // 文件上传服务上传接口
      String url = "http://localhost:8888/upload";
      // 待上传的文件（存在客户端本地磁盘）
      String filePath = "D:\\data\\local\\splash.png";

      // 封装请求参数
      FileSystemResource resource = new FileSystemResource(new File(filePath));
      MultiValueMap<String, Object> param = new LinkedMultiValueMap<>();
      param.add("uploadFile", resource);  //服务端MultipartFile uploadFile
      //param.add("param1", "test");   //服务端如果接受额外参数，可以传递


      // 发送请求并输出结果
      System.out.println("--- 开始上传文件 ---");
      String result = restTemplate.postForObject(url, param, String.class);
      System.out.println("--- 访问地址：" + result);
   }

}

输出结果如下：

--- 开始上传文件 ---
--- 访问地址：http://localhost:8888/2020/08/12/028b38f1-3f9b-4088-9bea-1af8c18cd619.png

文件上传之后，可以通过上面的访问地址，在浏览器访问。或者通过RestTemplate客户端进行下载。

二、文件下载

执行下列代码之后，被下载文件url，会被正确的保存到本地磁盘目录targetPath。

@Test
void testDownLoad() throws IOException {
   // 待下载的文件地址
   String url = "http://localhost:8888/2020/08/12/028b38f1-3f9b-4088-9bea-1af8c18cd619.png";
   ResponseEntity<byte[]> rsp = restTemplate.getForEntity(url, byte[].class);
   System.out.println("文件下载请求结果状态码：" + rsp.getStatusCode());

   // 将下载下来的文件内容保存到本地
   String targetPath = "D:\\data\\local\\splash-down.png";
   Files.write(Paths.get(targetPath), Objects.requireNonNull(rsp.getBody(),
               "未获取到下载文件"));
}

这种下载方法实际上是将下载文件一次性加载到客户端本地内存，然后从内存将文件写入磁盘。这种方式对于小文件的下载还比较适合，如果文件比较大或者文件下载并发量比较大，容易造成内存的大量占用，从而降低应用的运行效率。

三、大文件下载

这种下载方式的区别在于

• 设置了请求头APPLICATION_OCTET_STREAM，表示以流的形式进行数据加载
• RequestCallback 结合File.copy保证了接收到一部分文件内容，就向磁盘写入一部分内容。而不是全部加载到内存，最后再写入磁盘文件。

@Test
void testDownLoadBigFile() throws IOException {
   // 待下载的文件地址
   String url = "http://localhost:8888/2020/08/12/028b38f1-3f9b-4088-9bea-1af8c18cd619.png";
   // 文件保存的本地路径
   String targetPath = "D:\\data\\local\\splash-down-big.png";
   //定义请求头的接收类型
   RequestCallback requestCallback = request -> request.getHeaders()
               .setAccept(Arrays.asList(MediaType.APPLICATION_OCTET_STREAM, MediaType.ALL));
   //对响应进行流式处理而不是将其全部加载到内存中
   restTemplate.execute(url, HttpMethod.GET, requestCallback, clientHttpResponse -> {
      Files.copy(clientHttpResponse.getBody(), Paths.get(targetPath));
      return null;
   });
}

欢迎关注我的博客，里面有很多精品合集

• 本文转载注明出处（必须带连接，不能只转文字）：字母哥博客。