1. 文件上传工作原理
SpringMvc中MultipartResolver 用于处理文件上传：
-
收到请求后，DispatcherServlet的checkMultipart()方法会调用MulitpartResolver的isMultipart（）方法判断请求中时候是否包含文件
-
调用 MultipartResolver 的 isMultipart() 方法判断请求中是否包含文件。如果请求数据中包含文件，则调用 MultipartResolver 的 resolveMultipart() 方法对请求的数据进行解析，然后将文件数据解析成 MultipartFile 并封装在 MultipartHttpServletRequest (继承了 HttpServletRequest) 对象中，最后传递给 Controller
-
MultipartResolver有两个实现类：CommonsMultipartResolver 、StandardServletMultipartResolver 。对比：
- CommonsMultipartResolver ：使用 commons Fileupload 来处理 multipart 请求，所以在使用时，必须要引入相应的 jar 包
- StandardServletMultipartResolver ：基于 Servlet 3.0来处理 multipart 请求的，所以不需要引用其他 jar 包，但是必须使用支持 Servlet 3.0的容器才可以， Tomcat 7.0.x的版本开始就支持 Servlet 3.0。从下图中能看到Springboot1.0版本内置的tomcat为7.0版本，使用任意SpringBoot版本，都可以直接使用StandardServletMultipartResolver 。
2. CommonsMultipartResolver 源码分析
- resolveLazily 是判断是否要延迟解析文件（可配置）
- 当 resolveLazily 为 flase 时，会立即调用 parseRequest() 方法对请求数据进行解析，然后将解析结果封装到 DefaultMultipartHttpServletRequest 中
- 而当 resolveLazily 为 true 时，会在 DefaultMultipartHttpServletRequest 的 initializeMultipart() 方法调用 parseRequest() 方法对请求数据进行解析，而 initializeMultipart() 方法又是被 getMultipartFiles() 方法调用，即当需要获取文件信息时才会去解析请求数据，这种方式用了懒加载的思想。
// CommonsMultipartResolver 实现MultipartResolver 接口，resolveMultipart方法源码
@Override
public MultipartHttpServletRequest resolveMultipart(final HttpServletRequest request) throws MultipartException {
Assert.notNull(request, "Request must not be null");
if (this.resolveLazily) {
//懒加载，当调用DefaultMultipartHttpServletRequest的getMultipartFiles()方法时才解析请求数据
return new DefaultMultipartHttpServletRequest(request) {
@Override //当getMultipartFiles()方法被调用时，如果还未解析请求数据，则调用initializeMultipart()方法进行解析 protected void initializeMultipart() {
MultipartParsingResult parsingResult = parseRequest(request);
setMultipartFiles(parsingResult.getMultipartFiles());
setMultipartParameters(parsingResult.getMultipartParameters());
setMultipartParameterContentTypes(parsingResult.getMultipartParameterContentTypes());
}
};
} else {
//立即解析请求数据，并将解析结果封装到DefaultMultipartHttpServletRequest对象中
MultipartParsingResult parsingResult = parseRequest(request);
return new DefaultMultipartHttpServletRequest(request, parsingResult.getMultipartFiles(),
parsingResult.getMultipartParameters(), parsingResult.getMultipartParameterContentTypes());
}
}
// 解析工作是在 parseRequest() 方法中进行的,parseRequest方法源码
protected MultipartParsingResult parseRequest(HttpServletRequest request) throws MultipartException {
// 获取请求的编码类型
String encoding = determineEncoding(request);
// 根据编码类型确定一个 FileUpload 实例
FileUpload fileUpload = prepareFileUpload(encoding);
try {
// 得到文件信息
List<FileItem> fileItems = ((ServletFileUpload) fileUpload).parseRequest(request);
// 将文件信息解析成 CommonsMultipartFile (实现了 MultipartFile 接口) 并包装在 MultipartParsingResult 对象中。
return parseFileItems(fileItems, encoding);
} catch (...) {}
}
3. StandardServletMultipartResolver源码分析
// StandardServletMultipartResolver同CommonsMultipartResolver使用懒加载
public MultipartHttpServletRequest resolveMultipart(HttpServletRequest request) throws MultipartException {
return new StandardMultipartHttpServletRequest(request, this.resolveLazily);
}
public StandardMultipartHttpServletRequest(HttpServletRequest request, boolean lazyParsing) throws MultipartException {
super(request);
// 判断是否立即解析
if (!lazyParsing) {
parseRequest(request);
}
}
private void parseRequest(HttpServletRequest request) {
try {
//利用了 servlet3.0 的 request.getParts() 方法获取上传文件，并将其封装到 MultipartFile 对象中
Collection<Part> parts = request.getParts();
this.multipartParameterNames = new LinkedHashSet<String>(parts.size());
MultiValueMap<String, MultipartFile> files = new LinkedMultiValueMap<String, MultipartFile>(parts.size());
for (Part part : parts) {
String disposition = part.getHeader(CONTENT_DISPOSITION);
String filename = extractFilename(disposition);
if (filename == null) {
filename = extractFilenameWithCharset(disposition);
}
if (filename != null) {
files.add(part.getName(), new StandardMultipartFile(part, filename));
} else {
this.multipartParameterNames.add(part.getName());
}
}
setMultipartFiles(files);
} catch (Throwable ex) {}
}
4. 文件上传小demo
不引入common-fileUpload使用的是StandardServletMultipartResolver
@RequestMapping("/file-upload")
public ModelAndView upload(@RequestParam(value = "file", required = false) MultipartFile file,
HttpServletRequest request, HttpSession session) {
// 文件不为空
if(!file.isEmpty()) {
// 文件存放路径
String path = request.getServletContext().getRealPath("/");
// 文件名称
String name = String.valueOf(new Date().getTime()+"_"+file.getOriginalFilename());
File destFile = new File(path,name);
// 转存文件
try {
file.transferTo(destFile);
} catch (IllegalStateException | IOException e) {
e.printStackTrace();
}
// 访问的url
String url = request.getScheme() + "://" + request.getServerName() + ":" + request.getServerPort()
+ request.getContextPath() + "/" + name;
}
ModelAndView mv = new ModelAndView();
mv.setViewName("other/home");
return mv;
}
<html>
<body>
<h1>Spring Boot file upload </h1>
<form method="POST" action="/file-upload" enctype="multipart/form-data">
<input type="file" name="file" /><br/><br/>
<input type="submit" value="Submit" />
</form>
</body>
</html>
# SpringBoot2.0配置
spring:
servlet:
multipart:
# 是否启用multipart上传支持
enabled: false
# 支持文件写入磁盘
file-size-threshold: 0
# 最大文件大小
max-file-size: 1
# 最大请求大小
max-request-size: 10
# 上传文件的临时目录
location:
# 是否支持 multipart 上传文件时懒加载
resolve-lazily: false
注意：SpringBoot1.5 和 2.0配置的不同
# SpringBoot1.5配置
spring:
http:
multipart:
# 是否启用multipart上传支持
enabled: false
# 支持文件写入磁盘
file-size-threshold: 0
# 最大文件大小
max-file-size: 1
# 最大请求大小
max-request-size: 10
# 上传文件的临时目录
location:
# 是否支持 multipart 上传文件时懒加载
resolve-lazily: false
源码内容解析均来源于:https://www.cnblogs.com/tengyunhao/p/7670293.html
本系列仅文章为博主学习记录内容，如有侵权可联系删除