七、springBoot 簡單優雅是實現文件上傳和下載
- 2019 年 10 月 28 日
- 筆記
前言
好久沒有更新spring Boot 這個項目了。最近看了一下docker 的知識，後期打算將spring boot 和docker 結合起來。剛好最近有一個上傳文件的工作呢，剛好就想起這個腳手架，將文件上傳和下載整理進來。
配置
在application.properties 中增加上傳文件存放的路徑配置
#文件上傳目錄 file.upload.url=E:/testcontroller 層
上傳文件和下載文件都比較簡單，我們就直接在controller層來編寫。也不用在pom.xml 中增加什麼依賴。所以直接上程式碼。
在controller 包下創建一個file包，在file 包下創建一個FileController 類。
@RestController @RequestMapping("file") @Slf4j public class FileController { @Value("${file.upload.url}") private String uploadFilePath; @RequestMapping("/upload") public String httpUpload(@RequestParam("files") MultipartFile files[]){ JSONObject object=new JSONObject(); for(int i=0;i<files.length;i++){ String fileName = files[i].getOriginalFilename(); // 文件名 File dest = new File(uploadFilePath +'/'+ fileName); if (!dest.getParentFile().exists()) { dest.getParentFile().mkdirs(); } try { files[i].transferTo(dest); } catch (Exception e) { log.error("{}",e); object.put("success",2); object.put("result","程式錯誤，請重新上傳"); return object.toString(); } } object.put("success",1); object.put("result","文件上傳成功"); return object.toString(); } }上面的程式碼看起來有點多，其實就是一個上傳的方法，首先通過 MultipartFile 接收文件。這裡我用的是file[] 數組接收文件，這是為了兼容多文件上傳的情況，如果只用file 接收，然後在介面上傳多個文件的話，只會接收最後一個文件。這裡大家注意一下。看自己的需求，我這裡兼容多文件所以用數組接收。
然後遍歷files 獲取文件，下面這段程式碼是判斷文件在所在目錄是否存在，如果不存在就創建對應的目錄。
File dest = new File(uploadFilePath +'/'+ fileName); if (!dest.getParentFile().exists()) { dest.getParentFile().mkdirs(); } files[i].transferTo(dest);就是將文件存放到對應的伺服器，這裡有一點需要說明一下，如果我們上傳重複的文件會怎麼樣么？上傳重複的文件不會報錯，後上傳的文件會直接覆蓋已經上傳的文件。
整體程式碼就是這樣。現在就可以實現文件的上傳操作。
測試
我們寫好之後，基本上傳功能就已經實現了，我們現在來測試一下。啟動項目後我們用postman 請求，因為我們需要上傳文件，用get 方式請求不了。
可以看到文件上傳成功了，由此可見，springboot文件上傳一個方法就搞定了。
文件下載
其實文件下載，不太建議用介面做，因為文件下載一般都是下載一些靜態文件，我們可以先將文件處理好，然後通過Nginx 服務下載靜態文件，這樣速度會快很多。但是這裡我們還是寫一下。程式碼也很簡單，就一個方法，也寫在fileController 類中
@RequestMapping("/download") public String fileDownLoad(HttpServletResponse response, @RequestParam("fileName") String fileName){ File file = new File(downloadFilePath +'/'+ fileName); if(!file.exists()){ return "下載文件不存在"; } response.reset(); response.setContentType("application/octet-stream"); response.setCharacterEncoding("utf-8"); response.setContentLength((int) file.length()); response.setHeader("Content-Disposition", "attachment;filename=" + fileName ); try(BufferedInputStream bis = new BufferedInputStream(new FileInputStream(file));) { byte[] buff = new byte[1024]; OutputStream os = response.getOutputStream(); int i = 0; while ((i = bis.read(buff)) != -1) { os.write(buff, 0, i); os.flush(); } } catch (IOException e) { log.error("{}",e); return "下載失敗"; } return "下載成功"; } 程式碼也很簡單，就是根據文件名判斷是否存在文件，不存在就提示沒有文件，存在就將文件下載下來。response設置返迴文件的格式，以文件流的方式返回，採用utf-8 字符集，設置下載後的文件名。然後就是以文件流的方式下載文件了。
測試的話也簡單，我們啟動項目，訪問介面
http://localhost:9090/zlflovemm/file/download?fileName=11 http://localhost:9090/zlflovemm/file/download?fileName=1.rar
可以看到如果文件存在，會直接下載，不會提示下載成功或者失敗。
# 刪除文件
刪除文件是很簡單的，我這裡講一下刪除文件下所有文件夾和文件。並做一個定時任務，每天清理一次。
“`
@Scheduled(cron="0 0 3 * * ?") private void deleteFiles(){ deleteFile(new File(deleteFilePath)); } public void deleteFile(File file){ //判斷文件不為null或文件目錄存在 if (file == null || !file.exists()){ log.info("暫無文件"); return; } //取得這個目錄下的所有子文件對象 File[] files = file.listFiles(); //遍歷該目錄下的文件對象 for (File f: files){ //列印文件名 String name = f.getName(); log.info(name); //判斷子目錄是否存在子目錄,如果是文件則刪除 if (f.isDirectory()){ deleteFile(f); }else { f.delete(); } } //刪除空文件夾 for循環已經把上一層節點的目錄清空。 file.delete(); }“`
# 番外
到此為止，我們常用的鏡像和容器的操作就會使用啦。都是一些命令。忘記的可以–help 查看一下。
好了，就說這麼多啦
程式碼上傳到github：
https://github.com/QuellanAn/zlflovemm
後續加油♡
歡迎大家關注個人公眾號 "程式設計師愛酸奶"
分享各種學習資料，包含java，linux，大數據等。資料包含影片文檔以及源碼，同時分享本人及投遞的優質技術博文。
如果大家喜歡記得關注和分享喲❤
