上传文件是互联网中常常应用的场景之一，最典型的情况就是上传头像等，今天就带着带着大家做一个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>
  6. <properties>
  7.     <java.version>1.8</java.version>
  8. </properties>
  9. <dependencies>
  10.     <dependency>
  11.         <groupId>org.springframework.boot</groupId>
  12.         <artifactId>spring-boot-starter-web</artifactId>
  13.     </dependency>
  14.     <dependency>
  15.         <groupId>org.springframework.boot</groupId>
  16.         <artifactId>spring-boot-starter-thymeleaf</artifactId>
  17.     </dependency>
  18.     <dependency>
  19.         <groupId>org.springframework.boot</groupId>
  20.         <artifactId>spring-boot-devtools</artifactId>
  21.         <optional>true</optional>
  22.     </dependency>
  23. </dependencies>

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

2、启动类设置

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

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

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请求，一个选择框选择文件，一个提交按钮，效果如下：
【20200125】SpringBoot 文件上传 - 图2
上传结果展示页面：

效果图如下：
【20200125】SpringBoot 文件上传 - 图3

4、编写上传控制类

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

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

上传业务处理

  1. @Controller
  2. @RequestMapping(value="/")
  3. public class UploadsController {
  4.     @GetMapping("/mupload")
  5.     public String index() {
  6.         return "upload";
  7.     }
  8.     @PostMapping("/upload")
  9.     public String singleFileUpload(@RequestParam("file") MultipartFile file,
  10.                                    RedirectAttributes redirectAttributes) {
  11.         if (file.isEmpty()) {
  12.             redirectAttributes.addFlashAttribute("message", "Please select a file to upload");
  13.             return "redirect:/uploadStatus";
  14.         }
  16.         try {
  17.             // Get the file and save it somewhere
  18.             byte[] bytes = file.getBytes();
  19.             Path path = Paths.get("{存储地址}" + file.getOriginalFilename());
  20.             Files.write(path, bytes);
  22.             redirectAttributes.addFlashAttribute("message",
  23.                     "You successfully uploaded '" + file.getOriginalFilename() + "'");
  25.         } catch (IOException e) {
  26.             e.printStackTrace();
  27.         }
  28.         return "redirect:/uploadStatus";
  29.     }
  31. }

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

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

5、异常处理

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

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

6、总结

这样一个使用Spring Boot上传文件的简单Demo就完成了，感兴趣的同学可以将示例代码下载下来试试吧。
示例代码：https://github.com/ityouknow/spring-boot-examples