7、springBoot 簡單優雅是實現文件上傳和下載

前言

很久沒有更新spring Boot 這個項目了。最近看了一下docker 的知識，後期打算將spring boot 和docker 結合起來。恰好最近有一個上傳文件的工做呢，恰好就想起這個腳手架，將文件上傳和下載整理進來。

配置

在application.properties 中增長上傳文件存放的路徑配置

#文件上傳目錄
file.upload.url=E:/test

controller 層

上傳文件和下載文件都比較簡單，咱們就直接在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/...

後續加油♡

歡迎你們關注我的公衆號 "程序員愛酸奶"

分享各類學習資料，包含java，linux，大數據等。資料包含視頻文檔以及源碼，同時分享本人及投遞的優質技術博文。

若是你們喜歡記得關注和分享喲❤