上传文件是互联网中常常应用的场景之一，最典型的情况就是上传头像等，今天就带着带着大家做一个Spring Boot上传文件的小案例。

1、pom包配置

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

  1. <parent>
  2.     <groupId>org.springframework.boot</groupId>
  3.     <artifactId>spring-boot-starter-parent</artifactId>
  4.     <version>1.5.9.RELEASE</version>
  5. </parent>
  7. <properties>
  8.     <java.version>1.8</java.version>
  9. </properties>
  11. <dependencies>
  12.     <dependency>
  13.         <groupId>org.springframework.boot</groupId>
  14.         <artifactId>spring-boot-starter-web</artifactId>
  15.     </dependency>
  16.     <dependency>
  17.         <groupId>org.springframework.boot</groupId>
  18.         <artifactId>spring-boot-starter-thymeleaf</artifactId>
  19.     </dependency>
  20.     <dependency>
  21.         <groupId>org.springframework.boot</groupId>
  22.         <artifactId>spring-boot-devtools</artifactId>
  23.         <optional>true</optional>
  24.     </dependency>
  25. </dependencies>

引入了spring-boot-starter-thymeleaf做页面模板引擎，写一些简单的上传示例。

2、启动类设置

  1. @SpringBootApplication
  2. public class FileUploadWebApplication {
  4.     public static void main(String[] args) throws Exception {
  5.         SpringApplication.run(FileUploadWebApplication.class, args);
  6.     }
  8.     //Tomcat large file upload connection reset
  9.     @Bean
  10.     public TomcatEmbeddedServletContainerFactory tomcatEmbedded() {
  11.         TomcatEmbeddedServletContainerFactory tomcat = new TomcatEmbeddedServletContainerFactory();
  12.         tomcat.addConnectorCustomizers((TomcatConnectorCustomizer) connector -> {
  13.             if ((connector.getProtocolHandler() instanceof AbstractHttp11Protocol<?>)) {
  14.                 //-1 means unlimited
  15.                 ((AbstractHttp11Protocol<?>) connector.getProtocolHandler()).setMaxSwallowSize(-1);
  16.             }
  17.         });
  18.         return tomcat;
  19.     }
  21. }

tomcatEmbedded这段代码是为了解决，上传文件大于10M出现连接重置的问题。此异常内容GlobalException也捕获不到。

Spring Boot 上传文件 - 图1

详细内容参考：Tomcat large file upload connection reset

3、编写前端页面

上传页面

  1. <!DOCTYPE html>
  2. <html xmlns:th="http://www.thymeleaf.org">
  3. <body>
  4. <h1>Spring Boot file upload example</h1>
  5. <form method="POST" action="/upload" enctype="multipart/form-data">
  6.     <input type="file" name="file" /><br/><br/>
  7.     <input type="submit" value="Submit" />
  8. </form>
  9. </body>
  10. </html>

非常简单的一个Post请求，一个选择框选择文件，一个提交按钮，效果如下：

Spring Boot 上传文件 - 图2

上传结果展示页面：

  1. <!DOCTYPE html>
  2. <html lang="en" xmlns:th="http://www.thymeleaf.org">
  3. <body>
  4. <h1>Spring Boot - Upload Status</h1>
  5. <div th:if="${message}">
  6.     <h2 th:text="${message}"/>
  7. </div>
  8. </body>
  9. </html>

效果图如下：

Spring Boot 上传文件 - 图3

4、编写上传控制类

访问localhost自动跳转到上传页面：

  1. @GetMapping("/")
  2. public String index() {
  3.     return "upload";
  4. }

上传业务处理

  1. @PostMapping("/upload") 
  2. public String singleFileUpload(@RequestParam("file") MultipartFile file,
  3.                                RedirectAttributes redirectAttributes) {
  4.     if (file.isEmpty()) {
  5.         redirectAttributes.addFlashAttribute("message", "Please select a file to upload");
  6.         return "redirect:uploadStatus";
  7.     }
  9.     try {
  10.         // Get the file and save it somewhere
  11.         byte[] bytes = file.getBytes();
  12.         Path path = Paths.get(UPLOADED_FOLDER + file.getOriginalFilename());
  13.         Files.write(path, bytes);
  15.         redirectAttributes.addFlashAttribute("message",
  16.                 "You successfully uploaded '" + file.getOriginalFilename() + "'");
  18.     } catch (IOException e) {
  19.         e.printStackTrace();
  20.     }
  22.     return "redirect:/uploadStatus";
  23. }

上面代码的意思就是，通过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 # 最大支持请求大小

最常用的是最后两个配置内容，限制文件上传大小，上传时超过大小会抛出异常：

Spring Boot 上传文件 - 图4

更多配置信息参考这里：Common application properties

5、异常处理

  1. @ControllerAdvice
  2. public class GlobalExceptionHandler {
  4.     @ExceptionHandler(MultipartException.class)
  5.     public String handleError1(MultipartException e, RedirectAttributes redirectAttributes) {
  6.         redirectAttributes.addFlashAttribute("message", e.getCause().getMessage());
  7.         return "redirect:/uploadStatus";
  8.     }
  9. }

设置一个@ControllerAdvice用来监控Multipart上传的文件大小是否受限，当出现此异常时在前端页面给出提示。利用@ControllerAdvice可以做很多东西，比如全局的统一异常处理等，感兴趣的同学可以下来了解。

6、总结

这样一个使用Spring Boot上传文件的简单Demo就完成了，感兴趣的同学可以将示例代码下载下来试试吧。