Springboot導出文件,前端下載文件方式
Springboot導出文件,前端下載文件
後端代碼
可以把請求設置為post,我這裡是Get
@RequestMapping(value = "/download", method = RequestMethod.POST) public void download(HttpServletRequest request, HttpServletResponse res) throws Exception { File excelFile = new File("/Users/i501695/GitHUbProject/EN_ProductIntergration/databaseclient/src/main/resources/Files/ProductTemplateCopy.xlsx"); res.setCharacterEncoding("UTF-8"); String realFileName = excelFile.getName(); res.setHeader("content-type", "application/octet-stream;charset=UTF-8"); res.setContentType("application/octet-stream;charset=UTF-8"); //加上設置大小下載下來的.xlsx文件打開時才不會報“Excel 已完成文件級驗證和修復。此工作簿的某些部分可能已被修復或丟棄” res.addHeader("Content-Length", String.valueOf(excelFile.length())); try { res.setHeader("Content-Disposition", "attachment;filename=" + java.net.URLEncoder.encode(realFileName.trim(), "UTF-8")); } catch (UnsupportedEncodingException e1) { e1.printStackTrace(); } byte[] buff = new byte[1024]; BufferedInputStream bis = null; OutputStream os = null; try { os = res.getOutputStream(); bis = new BufferedInputStream(new FileInputStream(excelFile)); int i = bis.read(buff); while (i != -1) { os.write(buff, 0, buff.length); os.flush(); i = bis.read(buff); } }catch (Exception e){ e.printStackTrace(); }finally { if (bis != null) { try { bis.close(); } catch (IOException e) { e.printStackTrace(); } } } }
前端偽代碼結合Axios(核心代碼一樣,隻是結合瞭Axios)
Axios({ // 用axios發送post請求 method: 'post', url: 'http://127.0.0.1:8762/dataService/download', // 請求地址 data: formData, // 參數 responseType: 'blob' // 表明返回服務器返回的數據類型 }) .then((res) => { // 處理返回的文件流 let blob = new Blob([res.data], {type: res.data.type}) const fileName = 'ProductTemplateCopy.xlsx'; let downloadElement = document.createElement('a') let href = window.URL.createObjectURL(blob); //創建下載的鏈接 downloadElement.href = href; downloadElement.download = fileName; //下載後文件名 document.body.appendChild(downloadElement); downloadElement.click(); //點擊下載 document.body.removeChild(downloadElement); //下載完成移除元素 window.URL.revokeObjectURL(href); //釋放blob message.success('upload successfully.'); }) .catch(function (error) { console.log(error); });
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流有待學習
1:read() :
從輸入流中讀取數據的下一個字節,返回0到255范圍內的int字節值。如果因為已經到達流末尾而沒有可用的字節,則返回-1。在輸入數據可用、檢測到流末尾或者拋出異常前,此方法一直阻塞。
2:read(byte[] b) :
從輸入流中讀取一定數量的字節,並將其存儲在緩沖區數組 b 中。以整數形式返回實際讀取的字節數。在輸入數據可用、檢測到文件末尾或者拋出異常前,此方法一直阻塞。如果 b 的長度為 0,則不讀取任何字節並返回 0;否則,嘗試讀取至少一個字節。如果因為流位於文件末尾而沒有可用的字節,則返回值 -1
以上為個人經驗,希望能給大傢一個參考,也希望大傢多多支持WalkonNet。
推薦閱讀:
- Springboot與vue實現數據導出方法具體介紹
- 如何解決springmvc文件下載,內容損壞的問題
- springboot中Excel文件下載踩坑大全
- Java下載文件的四種方式詳細代碼
- Vue通過阿裡雲oss的url連接直接下載文件並修改文件名的方法