SpringBoot如何實作檔案下載功能

1. 將檔案以流的形式一次讀取到內存，透過響應輸出流輸出到前端

/**
 * @param path     想要下载的文件的路径
 * @param response
 * @功能描述 下载文件:
 */
@RequestMapping("/download")
public void download(String path, HttpServletResponse response) {
    try {
        // path是指想要下载的文件的路径
        File file = new File(path);
        log.info(file.getPath());
        // 获取文件名
        String filename = file.getName();
        // 获取文件后缀名
        String ext = filename.substring(filename.lastIndexOf(".") + 1).toLowerCase();
        log.info("文件后缀名：" + ext);

        // 将文件写入输入流
        FileInputStream fileInputStream = new FileInputStream(file);
        InputStream fis = new BufferedInputStream(fileInputStream);
        byte[] buffer = new byte[fis.available()];
        fis.read(buffer);
        fis.close();

        // 清空response
        response.reset();
        // 设置response的Header
        response.setCharacterEncoding("UTF-8");
        //Content-Disposition的作用：告知浏览器以何种方式显示响应返回的文件，用浏览器打开还是以附件的形式下载到本地保存
        //attachment表示以附件方式下载   inline表示在线打开   "Content-Disposition: inline; filename=文件名.mp3"
        // filename表示文件的默认名称，因为网络传输只支持URL编码的相关支付，因此需要将文件名URL编码后进行传输,前端收到后需要反编码才能获取到真正的名称
        response.addHeader("Content-Disposition", "attachment;filename=" + URLEncoder.encode(filename, "UTF-8"));
        // 告知浏览器文件的大小
        response.addHeader("Content-Length", "" + file.length());
        OutputStream outputStream = new BufferedOutputStream(response.getOutputStream());
        response.setContentType("application/octet-stream");
        outputStream.write(buffer);
        outputStream.flush();
    } catch (IOException ex) {
        ex.printStackTrace();
    }
}

2. 將輸入流中的資料循環寫入到響應輸出流中，而不是一次讀取到內存，透過響應輸出流輸出到前端

/**
* @param path     指想要下载的文件的路径
* @param response
* @功能描述 下载文件:将输入流中的数据循环写入到响应输出流中，而不是一次性读取到内存
*/
@RequestMapping("/downloadLocal")
public void downloadLocal(String path, HttpServletResponse response) throws IOException {
   // 读到流中
   InputStream inputStream = new FileInputStream(path);// 文件的存放路径
   response.reset();
   response.setContentType("application/octet-stream");
   String filename = new File(path).getName();
   response.addHeader("Content-Disposition", "attachment; filename=" + URLEncoder.encode(filename, "UTF-8"));
   ServletOutputStream outputStream = response.getOutputStream();
   byte[] b = new byte[1024];
   int len;
   //从输入流中读取一定数量的字节，并将其存储在缓冲区字节数组中，读到末尾返回-1
   while ((len = inputStream.read(b)) > 0) {
       outputStream.write(b, 0, len);
   }
   inputStream.close();
}

3. 下載網路檔案到本地

/**
* @param path       下载后的文件路径和名称
* @param netAddress 文件所在网络地址
* @功能描述 网络文件下载到服务器本地
*/
@RequestMapping("/netDownloadLocal")
public void downloadNet(String netAddress, String path) throws IOException {
	  URL url = new URL(netAddress);
	  URLConnection conn = url.openConnection();
	  InputStream inputStream = conn.getInputStream();
	  FileOutputStream fileOutputStream = new FileOutputStream(path);
	
	  int bytesum = 0;
	  int byteread;
	  byte[] buffer = new byte[1024];
	  while ((byteread = inputStream.read(buffer)) != -1) {
	      bytesum += byteread;
	      System.out.println(bytesum);
	      fileOutputStream.write(buffer, 0, byteread);
	  }
	  fileOutputStream.close();
}

4. 網路檔案取得到伺服器後，經過伺服器處理後回應給前端

/**
 * @param netAddress
 * @param filename
 * @param isOnLine
 * @param response
 * @功能描述 网络文件获取到服务器后，经服务器处理后响应给前端
 */
@RequestMapping("/netDownLoadNet")
public void netDownLoadNet(String netAddress, String filename, boolean isOnLine, HttpServletResponse response) throws Exception {

    URL url = new URL(netAddress);
    URLConnection conn = url.openConnection();
    InputStream inputStream = conn.getInputStream();

    response.reset();
    response.setContentType(conn.getContentType());
    if (isOnLine) {
        // 在线打开方式 文件名应该编码成UTF-8
        response.setHeader("Content-Disposition", "inline; filename=" + URLEncoder.encode(filename, "UTF-8"));
    } else {
        //纯下载方式 文件名应该编码成UTF-8
        response.setHeader("Content-Disposition", "attachment; filename=" + URLEncoder.encode(filename, "UTF-8"));
    }

    byte[] buffer = new byte[1024];
    int len;
    OutputStream outputStream = response.getOutputStream();
    while ((len = inputStream.read(buffer)) > 0) {
        outputStream.write(buffer, 0, len);
    }
    inputStream.close();
}

5. 常見例外與問題

#（1）回應物件無需透過return回傳

原因：  回應物件是可以不用作為方法傳回值傳回的，其在方法執行時已經開始輸出，且無法與 @RestController配合，以JSON格式傳回前端

解決方案：刪除return語句

（2）返回前端的檔案名稱必須進行URL編碼

原因： 網路傳輸只能傳輸特定的幾十個字符，需要將漢字、特殊字符等經過Base64等編碼來轉化為特定字符，從而進行傳輸，而不會亂碼

URLEncoder.encode(fileName, "UTF-8")

（3）IO流有待學習

下面是重寫後的句子： 函數read()用於從輸入流讀取資料的下一個字節，並傳回該位元組的整數值，值的範圍在0到255之間。如果因為已經到達流末尾而沒有可用的字節，則傳回-1。在輸入資料可用、偵測到流末尾或拋出異常前，此方法一直阻塞。

2：read(byte[] b) : 從輸入流中讀取一定數量的位元組，並將其儲存在緩衝區數組 b 中。以整數形式傳回實際讀取的位元組數。此方法會一直阻塞直到輸入資料可用、偵測到檔案末端或拋出異常。如果 b 的長度為 0，則不讀取任何位元組並返回 0；否則，請嘗試讀取至少一個位元組。如果因為流位於檔案末尾而沒有可用的字節，則傳回值 -1

以上是SpringBoot如何實作檔案下載功能的詳細內容。更多資訊請關注PHP中文網其他相關文章！