精講RestTemplate第6篇-文件上傳下載與大文件流式下載

2020 年 8 月 12 日
筆記

本文是精講RestTemplate第6篇，前篇的blog訪問地址如下：

RestTemplate是HTTP客戶端庫，所以為了使用RestTemplate進行文件上傳和下載，需要我們先編寫服務端的支援文件上傳和下載的程式。請參考我之前寫的一篇文章：SpringBoot實現本地存儲文件上傳及提供HTTP訪問服務。按照此文完成學習之後，可以獲得

一個以訪問服務URI為”/upload」的文件上傳服務端點
服務端點上傳文件成功後會返回一個HTTP連接,可以用來下載文件。

下面我們就開始學習使用RestTemplate是HTTP客戶端庫，進行文件的上傳與下載。

一、文件上傳

寫一個單元測試類，來完成RestTemplate文件上傳功能，具體實現細節參考程式碼注釋

@SpringBootTest
class UpDownLoadTests {

   @Resource
   private RestTemplate restTemplate;

   @Test
   void testUpload()  {
      // 文件上傳服務上傳介面
      String url = "//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);
   }

}

輸出結果如下：

--- 開始上傳文件 ---
--- 訪問地址：//localhost:8888/2020/08/12/028b38f1-3f9b-4088-9bea-1af8c18cd619.png

文件上傳之後，可以通過上面的訪問地址，在瀏覽器訪問。或者通過RestTemplate客戶端進行下載。

二、文件下載

執行下列程式碼之後，被下載文件url，會被正確的保存到本地磁碟目錄targetPath。

@Test
void testDownLoad() throws IOException {
   // 待下載的文件地址
   String url = "//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 = "//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;
   });
}

歡迎關注我的部落格，裡面有很多精品合集

本文轉載註明出處（必須帶連接，不能只轉文字）：字母哥部落格。

覺得對您有幫助的話，幫我點贊、分享！您的支援是我不竭的創作動力！ 。另外，筆者最近一段時間輸出了如下的精品內容，期待您的關注。