使用Spring Boot上传文件功能

 更新时间:2018年01月12日 10:25:14   作者:纯洁的微笑  
上传文件是互联网中常应用的场景之一,最典型的情况就是上传头像等,今天就带着大家做一个Spring Boot上传文件的小案例,感兴趣的朋友跟随脚本之家小编一起学习吧

上传文件是互联网中常常应用的场景之一,最典型的情况就是上传头像等,今天就带着带着大家做一个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 做页面模板引擎,写一些简单的上传示例。

2、启动类设置

@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出现连接重置的问题。此异常内容GlobalException也捕获不到。

 

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

3、编写前端页面

上传页面

<!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>

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

 

上传结果展示页面:

<!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、编写上传控制类

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

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

上传业务处理

@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";
}

上面代码的意思就是,通过 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、异常处理

@ControllerAdvice
public class GlobalExceptionHandler {

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


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

6、总结

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

参考:

示例代码-github

示例代码-码云

总结

以上所述是小编给大家介绍的使用Spring Boot上传文件功能,希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。在此也非常感谢大家对脚本之家网站的支持!

相关文章

  • java中变量和常量详解

    java中变量和常量详解

    这篇文章主要介绍了Java中变量和常量详解,具有一定参考价值,需要的朋友可以了解下。
    2017-11-11
  • 彻底解决java.lang.ClassNotFoundException: com.mysql.jdbc.Driver问题

    彻底解决java.lang.ClassNotFoundException: com.mysql.jdbc.Dr

    这篇文章给大家介绍了如如何彻底解决java.lang.ClassNotFoundException: com.mysql.jdbc.Driver问题,文中有详细的解决思路以及解决方法,需要的朋友可以参考下
    2023-11-11
  • 关于idea的gitignore文件编写及解决ignore文件不生效问题

    关于idea的gitignore文件编写及解决ignore文件不生效问题

    这篇文章主要介绍了idea的gitignore文件编写及解决ignore文件不生效问题,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2021-03-03
  • 详解Java实现简单SPI流程

    详解Java实现简单SPI流程

    这篇文章主要介绍了Java实现简单SPI流程,SPI英文全称为Service Provider Interface,顾名思义,服务提供者接口,它是jdk提供给“服务提供厂商”或者“插件开发者”使用的接口
    2023-03-03
  • Java使用Kaptcha实现简单的验证码生成器

    Java使用Kaptcha实现简单的验证码生成器

    这篇文章主要为大家详细介绍了Java如何使用Kaptcha实现简单的验证码生成器,文中的示例代码讲解详细,具有一定的借鉴价值,有需要的小伙伴可以参考下
    2024-02-02
  • SpringBoot项目调优及垃圾回收器的比较详解

    SpringBoot项目调优及垃圾回收器的比较详解

    这篇文章主要介绍了SpringBoot项目调优及垃圾回收器的比较详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-04-04
  • 成功解决IDEA2020 Plugins 连不上、打不开的方法

    成功解决IDEA2020 Plugins 连不上、打不开的方法

    这篇文章主要介绍了成功解决IDEA2020 Plugins 连不上、打不开的方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-06-06
  • 关于ReentrantLock的实现原理解读

    关于ReentrantLock的实现原理解读

    这篇文章主要介绍了关于ReentrantLock的实现原理,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-06-06
  • Lombok中@EqualsAndHashCode注解的使用及说明

    Lombok中@EqualsAndHashCode注解的使用及说明

    这篇文章主要介绍了Lombok中@EqualsAndHashCode注解的使用及说明,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-03-03
  • Java基础之命名规范的详解

    Java基础之命名规范的详解

    这篇文章主要介绍了Java基础之命名规范的详解,文中有非常详细的代码示例,对正在学习Java基础的小伙伴们有很好地帮助,需要的朋友可以参考下
    2021-05-05

最新评论