使用Spring Boot上傳文件功能

更新時(shí)間：2018年01月12日 10:25:14 作者：純潔的微笑

上傳文件是互聯(lián)網(wǎng)中常應(yīng)用的場(chǎng)景之一，最典型的情況就是上傳頭像等，今天就帶著大家做一個(gè)Spring Boot上傳文件的小案例，感興趣的朋友跟隨腳本之家小編一起學(xué)習(xí)吧

上傳文件是互聯(lián)網(wǎng)中常常應(yīng)用的場(chǎng)景之一，最典型的情況就是上傳頭像等，今天就帶著帶著大家做一個(gè)Spring Boot上傳文件的小案例。

1、pom包配置

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

<parent>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-starter-parent</artifactId>
 <version>1.5.9.RELEASE</version>
</parent>
<properties>
 <java.version>1.8</java.version>
</properties>
<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-devtools</artifactId>
 <optional>true</optional>
 </dependency>
</dependencies>

引入了 spring-boot-starter-thymeleaf 做頁(yè)面模板引擎，寫(xiě)一些簡(jiǎn)單的上傳示例。

2、啟動(dòng)類設(shè)置

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

tomcatEmbedded這段代碼是為了解決，上傳文件大于10M出現(xiàn)連接重置的問(wèn)題。此異常內(nèi)容GlobalException也捕獲不到。

詳細(xì)內(nèi)容參考： Tomcat large file upload connection reset

3、編寫(xiě)前端頁(yè)面

上傳頁(yè)面

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

非常簡(jiǎn)單的一個(gè)Post請(qǐng)求，一個(gè)選擇框選擇文件，一個(gè)提交按鈕，效果如下：

上傳結(jié)果展示頁(yè)面：

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

效果圖如下：

4、編寫(xiě)上傳控制類

訪問(wèn)localhost自動(dòng)跳轉(zhuǎn)到上傳頁(yè)面：

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

上傳業(yè)務(wù)處理

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

上面代碼的意思就是，通過(guò) MultipartFile 讀取文件信息，如果文件為空跳轉(zhuǎn)到結(jié)果頁(yè)并給出提示；如果不為空讀取文件流并寫(xiě)入到指定目錄，最后將結(jié)果展示到頁(yè)面。

MultipartFile 是Spring上傳文件的封裝類，包含了文件的二進(jìn)制流和文件屬性等信息，在配置文件中也可對(duì)相關(guān)屬性進(jìn)行配置，基本的配置信息如下：

spring.http.multipart.enabled=true #默認(rèn)支持文件上傳.
spring.http.multipart.file-size-threshold=0 #支持文件寫(xiě)入磁盤(pán).
spring.http.multipart.location= # 上傳文件的臨時(shí)目錄
spring.http.multipart.max-file-size=1Mb # 最大支持文件大小
spring.http.multipart.max-request-size=10Mb # 最大支持請(qǐng)求大小

最常用的是最后兩個(gè)配置內(nèi)容，限制文件上傳大小，上傳時(shí)超過(guò)大小會(huì)拋出異常：

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

5、異常處理

@ControllerAdvice
public class GlobalExceptionHandler {

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

設(shè)置一個(gè) @ControllerAdvice 用來(lái)監(jiān)控 Multipart 上傳的文件大小是否受限，當(dāng)出現(xiàn)此異常時(shí)在前端頁(yè)面給出提示。利用 @ControllerAdvice 可以做很多東西，比如全局的統(tǒng)一異常處理等，感興趣的同學(xué)可以下來(lái)了解。

6、總結(jié)

這樣一個(gè)使用Spring Boot上傳文件的簡(jiǎn)單Demo就完成了，感興趣的同學(xué)可以將示例代碼下載下來(lái)試試吧。

參考：

示例代碼-github

示例代碼-碼云

總結(jié)

以上所述是小編給大家介紹的使用Spring Boot上傳文件功能，希望對(duì)大家有所幫助，如果大家有任何疑問(wèn)請(qǐng)給我留言，小編會(huì)及時(shí)回復(fù)大家的。在此也非常感謝大家對(duì)腳本之家網(wǎng)站的支持！

您可能感興趣的文章: