springboot(十七)：使用Spring Boot上傳文件

02-02

上傳文件是互聯網中常常應用的場景之一，最典型的情況就是上傳頭像等，今天就帶著帶著大家做一個Spring Boot上傳文件的小案例。

1、pom包配置

我們使用Spring Boot最新版本1.5.9、jdk使用1.8、tomcat8.0。

<parent>n <groupId>org.springframework.boot</groupId>n <artifactId>spring-boot-starter-parent</artifactId>n <version>1.5.9.RELEASE</version>n</parent>nn<properties>n <java.version>1.8</java.version>n</properties>nn<dependencies>n <dependency>n <groupId>org.springframework.boot</groupId>n <artifactId>spring-boot-starter-web</artifactId>n </dependency>n <dependency>n <groupId>org.springframework.boot</groupId>n <artifactId>spring-boot-starter-thymeleaf</artifactId>n </dependency>n <dependency>n <groupId>org.springframework.boot</groupId>n <artifactId>spring-boot-devtools</artifactId>n <optional>true</optional>n </dependency>n</dependencies>n

引入了spring-boot-starter-thymeleaf做頁面模板引擎，寫一些簡單的上傳示例。

2、啟動類設置

@SpringBootApplicationnpublic class FileUploadWebApplication {nn public static void main(String[] args) throws Exception {n SpringApplication.run(FileUploadWebApplication.class, args);n }nn //Tomcat large file upload connection resetn @Beann public TomcatEmbeddedServletContainerFactory tomcatEmbedded() {n TomcatEmbeddedServletContainerFactory tomcat = new TomcatEmbeddedServletContainerFactory();n tomcat.addConnectorCustomizers((TomcatConnectorCustomizer) connector -> {n if ((connector.getProtocolHandler() instanceof AbstractHttp11Protocol<?>)) {n //-1 means unlimitedn ((AbstractHttp11Protocol<?>) connector.getProtocolHandler()).setMaxSwallowSize(-1);n }n });n return tomcat;n }nn}n

tomcatEmbedded這段代碼是為了解決，上傳文件大於10M出現連接重置的問題。此異常內容GlobalException也捕獲不到。

詳細內容參考：Tomcat large file upload connection reset

3、編寫前端頁面

上傳頁面

<!DOCTYPE html>n<html xmlns:th="http://www.thymeleaf.org">n<body>n<h1>Spring Boot file upload example</h1>n<form method="POST" action="/upload" enctype="multipart/form-data">n <input type="file" name="file" /><br/><br/>n <input type="submit" value="Submit" />n</form>n</body>n</html>n

非常簡單的一個Post請求，一個選擇框選擇文件，一個提交按鈕，效果如下：

上傳結果展示頁面：

<!DOCTYPE html>n<html lang="en" xmlns:th="http://www.thymeleaf.org">n<body>n<h1>Spring Boot - Upload Status</h1>n<div th:if="${message}">n <h2 th:text="${message}"/>n</div>n</body>n</html>n

效果圖如下：

4、編寫上傳控制類

訪問localhost自動跳轉到上傳頁面：

@GetMapping("/")npublic String index() {n return "upload";n}n

上傳業務處理

@PostMapping("/upload") npublic String singleFileUpload(@RequestParam("file") MultipartFile file,n RedirectAttributes redirectAttributes) {n if (file.isEmpty()) {n redirectAttributes.addFlashAttribute("message", "Please select a file to upload");n return "redirect:uploadStatus";n }nn try {n // Get the file and save it somewheren byte[] bytes = file.getBytes();n Path path = Paths.get(UPLOADED_FOLDER + file.getOriginalFilename());n Files.write(path, bytes);nn redirectAttributes.addFlashAttribute("message",n "You successfully uploaded " + file.getOriginalFilename() + "");nn } catch (IOException e) {n e.printStackTrace();n }nn return "redirect:/uploadStatus";n}n

上面代碼的意思就是，通過MultipartFile讀取文件信息，如果文件為空跳轉到結果頁並給出提示；如果不為空讀取文件流並寫入到指定目錄，最後將結果展示到頁面。

MultipartFile是Spring上傳文件的封裝類，包含了文件的二進位流和文件屬性等信息，在配置文件中也可對相關屬性進行配置，基本的配置信息如下：

spring.http.multipart.enabled=true #默認支持文件上傳.
spring.http.multipart.file-size-threshold=0 #支持文件寫入磁碟.
spring.http.multipart.location= # 上傳文件的臨時目錄
spring.http.multipart.max-file-size=1Mb # 最大支持文件大小
spring.http.multipart.max-request-size=10Mb # 最大支持請求大小

最常用的是最後兩個配置內容，限制文件上傳大小，上傳時超過大小會拋出異常：

更多配置信息參考這裡：Common application properties

5、異常處理

@ControllerAdvicenpublic class GlobalExceptionHandler {nn @ExceptionHandler(MultipartException.class)n public String handleError1(MultipartException e, RedirectAttributes redirectAttributes) {n redirectAttributes.addFlashAttribute("message", e.getCause().getMessage());n return "redirect:/uploadStatus";n }n}n

設置一個@ControllerAdvice用來監控Multipart上傳的文件大小是否受限，當出現此異常時在前端頁面給出提示。利用@ControllerAdvice可以做很多東西，比如全局的統一異常處理等，感興趣的同學可以下來了解。

6、總結

這樣一個使用Spring Boot上傳文件的簡單Demo就完成了，感興趣的同學可以將示例代碼下載下來試試吧。

參考：

示例代碼-github

示例代碼-碼雲

http://weixin.qq.com/r/xjizqxLER084rVbI923U (二維碼自動識別)

作者：純潔的微笑
鏈接：springboot(十七)：使用Spring Boot上傳文件
聲明：轉載請註明作者與出處，謝謝！