1.基于Spring MVC的文件上传流程
在Spring MVC框架中,MultipartResolver 提供了文件上传的相关得到工具。利用 SpringMVC 实现文件上传功能,离不开对 MultipartResolver 的设置。
MultipartResolver 这个类也只会在文件上传中发挥作用,在配置了具体实现类之后,SpringMVC 中的 DispatcherServlet 在处理请求时会调用 MultipartResolver 中的方法判断此请求是不是文件上传请求。如果是的话, DispatcherServlet 将调用 MultipartResolver 的 resolveMultipart(request) 方法对该请求对象进行装饰,并返回一个新的 MultipartHttpServletRequest 供后继处理流程使用。 此时的请求对象会由 HttpServletRequest 类型转换成 MultipartHttpServletRequest 类型,这个类中会包含所上传的文件对象可供后续流程直接使用,而无需自行在代码中实现对文件内容的读取和对象封装的逻辑。
2.Spring Boot实现文件上传
由于 Spring Boot 自动配置机制的存在,我们并不需要进行多余的设置,只要已经在 pom 文件中引入了 web starter 模块即可直接进行文件上传功能。
配置含义注释:
spring.servlet.multipart.enabled
- 是否支持 multipart 上传文件,默认支持
spring.servlet.multipart.fileSizeThreshold
- 文件大小阈值,当大于这个阈值时将写入到磁盘,否则存在内存中,(默认值 0 ,一般情况下不用特意修改)
spring.servlet.multipart.location
- 上传文件的临时目录
spring.servlet.multipart.maxFileSize
- 最大支持文件大小,默认 1 M ,该值可适当的调整
spring.servlet.multipart.maxRequestSize
- 最大支持请求大小,默认 10 M
spring.servlet.multipart.resolveLazily
- 判断是否要延迟解析文件(相当于懒加载,一般情况下不用特意修改),默认 false
2.1 文件上传
新建文件上传页面
在 static 目录中新建 uploadDemo.html,文件上传的请求地址为 /upload,请求方法为 post,需要注意的是在文件上传时要设置 enctype=“multipart/form-data”。
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<title>Spring Boot 文件上传demo</title>
</head>
<body>
<form action="/uploadFile" method="post" enctype="multipart/form-data">
<input type="file" name="file" />
<input type="submit" value="文件上传" />
</form>
</body>
</html>
新建文件上传处理 Controller
在 controller.common包下新建 UploadController 类。由于已经自动配置了 MultipartFile ,因此能够直接在控制器方法中使用 MultipartFile 读取文件信息, @RequestParam 中的文件名称需要与文件上传前端页面设置的 name 属性一致,如果文件为空则返回上传失败,如果不为空则生成一个新的文件名,之后读取文件流并写入到指定的上传路径中,最后返回上传成功。
@Controller
public class UploadController {
@PostMapping({"/uploadFile"})
@ResponseBody
public Result upload(HttpServletRequest httpServletRequest, @RequestParam("file") MultipartFile file) throws URISyntaxException {
String fileName = file.getOriginalFilename();
String suffixName = fileName.substring(fileName.lastIndexOf("."));
// 生成文件名称通用方法
SimpleDateFormat sdf = new SimpleDateFormat("yyyyMMdd_HHmmss");
Random r = new Random();
StringBuilder tempName = new StringBuilder();
tempName.append(sdf.format(new Date())).append(r.nextInt(100)).append(suffixName);
String newFileName = tempName.toString();
File fileDirectory = new File(Constants.FILE_UPLOAD_DIC);
//创建文件
File destFile = new File(Constants.FILE_UPLOAD_DIC + newFileName);
try {
if (!fileDirectory.exists()) {
if (!fileDirectory.mkdir()) {
throw new IOException("文件夹创建失败,路径为:" + fileDirectory);
}
}
file.transferTo(destFile);
Result resultSuccess = ResultGenerator.genSuccessResult();
resultSuccess.setData(SystemUtil.getHost(new URI(httpServletRequest.getRequestURL() + "")) + "/upload/" + newFileName);
return resultSuccess;
} catch (IOException e) {
e.printStackTrace();
return ResultGenerator.genFailResult("文件上传失败");
}
}
}
2.2 测试文件上传功能
可以看到文件上传到了我们指定的文件夹下了,并且回传了文件的路径,那么接下来我们就可以通过该路经回显文件,这也正好符合一个完整的功能逻辑。
3.回显文件
Spring Boot 不像普通的 web 项目可以上传到 webapp 指定目录中,通常的做法是使用自定义静态资源映射目录,以此来实现文件上传整个流程的闭环,比如在文件上传到 upload 目录后,增加一个自定义静态资源映射,使得 upload 下的静态资源可以通过该映射地址被访问到,在SpringBootWebMvcConfigurer 类中增加配置即可。
public void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("/files/**").addResourceLocations("file:/Users/xuzhi/java-projects/bbs-springboot/upload");
}
通过该设置,所有以 /files/ 开头的静态资源请求都会映射到 /Users/xuzhi/java-projects/bbs-springboot/upload目录下。
可以看到通过上面设置的访问路径可以访问该上传的文件。
项目源码下载地址:源码下载