一起來學 SpringBoot 2.x | 第十七篇：輕鬆搞定文件上傳

  • 2019 年 10 月 29 日
  • 筆記

來源：http://t.cn/EwMgr3F

  • 文件上傳
  • 導入依賴
  • 配置文件
  • 禁用 thymeleaf 緩存
  • 具體代碼
    • 上傳頁面
    • 控制層
    • 主函數
    • 測試
  • 總結
  • 說點什麼

SpringBoot 是為了簡化 Spring 應用的創建、運行、調試、部署等一系列問題而誕生的產物，自動裝配的特性讓我們可以更好的關注業務本身而不是外部的XML配置，我們只需遵循規範，引入相關的依賴就可以輕易的搭建出一個 WEB 工程

文件上傳和下載是JAVA WEB中常見的一種操作，文件上傳主要是將文件通過IO流傳輸到服務器的某一個特定的文件夾下；剛開始工作那會一個上傳文件常常花費小半天的時間，繁瑣的代碼量以及XML配置讓我是痛不欲生；值得慶幸的是有了Spring Boot短短的幾句代碼就能實現文件上傳與本地寫入操作….

文件上傳

文件上傳和下載是JAVA WEB中常見的一種操作，文件上傳主要是將文件通過IO流傳輸到服務器的某一個特定的文件夾下；剛開始工作那會一個上傳文件常常花費小半天的時間，繁瑣的代碼量以及XML配置讓我是痛不欲生；值得慶幸的是有了Spring Boot短短的幾句代碼就能實現文件上傳與本地寫入操作….

導入依賴

在 pom.xml 中添加上 spring-boot-starter-web 和 spring-boot-starter-thymeleaf 的依賴

<dependencies>      <dependency>          <groupId>org.springframework.boot</groupId>          <artifactId>spring-boot-starter-web</artifactId>      </dependency>      <dependency>          <groupId>org.springframework.boot</groupId>          <artifactId>spring-boot-starter-thymeleaf</artifactId>      </dependency>      <dependency>          <groupId>org.springframework.boot</groupId>          <artifactId>spring-boot-starter-test</artifactId>          <scope>test</scope>      </dependency>  </dependencies>

配置文件

默認情況下 Spring Boot 無需做任何配置也能實現文件上傳的功能，但有可能因默認配置不符而導致文件上傳失敗問題，所以了解相關配置信息更有助於我們對問題的定位和修復；

# 禁用 thymeleaf 緩存  spring.thymeleaf.cache=false  # 是否支持批量上傳   (默認值 true)  spring.servlet.multipart.enabled=true  # 上傳文件的臨時目錄 （一般情況下不用特意修改）  spring.servlet.multipart.location=  # 上傳文件最大為 1M （默認值 1M 根據自身業務自行控制即可）  spring.servlet.multipart.max-file-size=1048576  # 上傳請求最大為 10M（默認值10M 根據自身業務自行控制即可）  spring.servlet.multipart.max-request-size=10485760  # 文件大小閾值，當大於這個閾值時將寫入到磁盤，否則存在內存中，（默認值0 一般情況下不用特意修改）  spring.servlet.multipart.file-size-threshold=0  # 判斷是否要延遲解析文件（相當於懶加載，一般情況下不用特意修改）  spring.servlet.multipart.resolve-lazily=false

如默認只允許1M以下的文件，當超出該範圍則會拋出下述錯誤

org.apache.tomcat.util.http.fileupload.FileUploadBase$SizeLimitExceededException:  the request was rejected because its size (20738021) exceeds the configured maximum (10485760)

具體代碼

上傳頁面

在 src/main/resources 目錄下新建 static 目錄和 templates 目錄。在 templates 中新建一個 index.html 的模板文件；此處實現 單文件上傳、多文件上傳、BASE64編碼 三種上傳方式，其中 BASE64 的方式在對Android/IOS/H5等方面還是不錯的…

<!DOCTYPE html>  <html xmlns="http://www.w3.org/1999/xhtml"        xmlns:th="http://www.thymeleaf.org">  <head>      <meta charset="UTF-8">      <title>文件上傳</title>  </head>  <body>    <h2>單一文件上傳示例</h2>  <div>      <form method="POST" enctype="multipart/form-data" action="/uploads/upload1">          <p>              文件1：<input type="file" name="file"/>              <input type="submit" value="上傳"/>          </p>      </form>  </div>    <hr/>  <h2>批量文件上傳示例</h2>    <div>      <form method="POST" enctype="multipart/form-data"            action="/uploads/upload2">          <p>              文件1：<input type="file" name="file"/>          </p>          <p>              文件2：<input type="file" name="file"/>          </p>          <p>              <input type="submit" value="上傳"/>          </p>      </form>  </div>    <hr/>  <h2>Base64文件上傳</h2>  <div>      <form method="POST" action="/uploads/upload3">          <p>              BASE64編碼：<textarea name="base64" rows="10" cols="80"></textarea>              <input type="submit" value="上傳"/>          </p>      </form>  </div>    </body>  </html>

控制層

創建一個FileUploadController，其中@GetMapping的方法用來跳轉index.html頁面，而@PostMapping相關方法則是對應的 單文件上傳、多文件上傳、BASE64編碼 三種處理方式。

@RequestParam("file") 此處的"file"對應的就是html 中 name="file" 的 input 標籤，而將文件真正寫入的還是藉助的commons-io中的FileUtils.copyInputStreamToFile(inputStream,file)

package com.battcn.controller;    import org.slf4j.Logger;  import org.slf4j.LoggerFactory;  import org.springframework.stereotype.Controller;  import org.springframework.util.Base64Utils;  import org.springframework.util.FileCopyUtils;  import org.springframework.web.bind.annotation.*;  import org.springframework.web.multipart.MultipartFile;    import java.io.File;  import java.io.IOException;  import java.util.ArrayList;  import java.util.HashMap;  import java.util.List;  import java.util.Map;    /**   * 圖片上傳的幾種方式   *   * @author Levin   * @since 2018/5/31 0031   */  @Controller  @RequestMapping("/uploads")  public class FileUploadController {        private static final Logger log = LoggerFactory.getLogger(FileUploadController.class);        @GetMapping      public String index() {          return "index";      }          @PostMapping("/upload1")      @ResponseBody      public Map<String, String> upload1(@RequestParam("file") MultipartFile file) throws IOException {          log.info("[文件類型] - [{}]", file.getContentType());          log.info("[文件名稱] - [{}]", file.getOriginalFilename());          log.info("[文件大小] - [{}]", file.getSize());          // TODO 將文件寫入到指定目錄（具體開發中有可能是將文件寫入到雲存儲/或者指定目錄通過 Nginx 進行 gzip 壓縮和反向代理，此處只是為了演示故將地址寫成本地電腦指定目錄）          file.transferTo(new File("F:\app\chapter16\" + file.getOriginalFilename()));          Map<String, String> result = new HashMap<>(16);          result.put("contentType", file.getContentType());          result.put("fileName", file.getOriginalFilename());          result.put("fileSize", file.getSize() + "");          return result;      }        @PostMapping("/upload2")      @ResponseBody      public List<Map<String, String>> upload2(@RequestParam("file") MultipartFile[] files) throws IOException {          if (files == null || files.length == 0) {              return null;          }          List<Map<String, String>> results = new ArrayList<>();          for (MultipartFile file : files) {              // TODO Spring Mvc 提供的寫入方式              file.transferTo(new File("F:\app\chapter16\" + file.getOriginalFilename()));              Map<String, String> map = new HashMap<>(16);              map.put("contentType", file.getContentType());              map.put("fileName", file.getOriginalFilename());              map.put("fileSize", file.getSize() + "");              results.add(map);          }          return results;      }        @PostMapping("/upload3")      @ResponseBody      public void upload2(String base64) throws IOException {          // TODO BASE64 方式的 格式和名字需要自己控制（如 png 圖片編碼後前綴就會是 data:image/png;base64,）          final File tempFile = new File("F:\app\chapter16\test.jpg");          // TODO 防止有的傳了 data:image/png;base64, 有的沒傳的情況          String[] d = base64.split("base64,");          final byte[] bytes = Base64Utils.decodeFromString(d.length > 1 ? d[1] : d[0]);          FileCopyUtils.copy(bytes, tempFile);        }  }

主函數

package com.battcn;    import org.springframework.boot.SpringApplication;  import org.springframework.boot.autoconfigure.SpringBootApplication;      /**   * @author Levin   */  @SpringBootApplication  public class Chapter16Application {        public static void main(String[] args) {          SpringApplication.run(Chapter16Application.class, args);      }    }

測試

完成準備事項後，啟動Chapter16Application，訪問 http://localhost:8080/uploads 進入到文件上傳頁面。單文件上傳、多文件上傳 都是及其簡單的就不做演示了，相信各位自己也是可以完成的。

文件上傳頁

BASE64 測試方法

打開瀏覽器訪問 http://base64.xpcha.com/pic.html 選擇一張圖片將其轉換為base64編碼的，隨後將轉換後的base64字符串內容 複製到下圖中的文本框中，點擊上傳即可，隨後到指定目錄下就可以看到我們上傳的文件了

BASE64上傳

總結

目前很多大佬都寫過關於 SpringBoot 的教程了，如有雷同，請多多包涵，本教程基於最新的 spring-boot-starter-parent：2.0.2.RELEASE編寫，包括新版本的特性都會一起介紹…

說點什麼

全文代碼：https://github.com/battcn/spring-boot2-learning/tree/master/chapter16

VirMach 便宜 VPS

QNews

QNews