使用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就完成了，感兴趣的同学可以将示例代码下载下来试试吧。
参考：
示例代码-
示例代码-
总结
以上所述是小编给大家介绍的使用spring boot上传文件功能，希望对大家有所帮助