SpringBoot文件上传的原理解析
更新时间：2023年10月10日 10:27:42 作者：刘婉晴
这篇文章主要介绍了SpringBoot文件上传的原理解析,SpringBoot 文件上传是一种方便快捷的方式,可以将文件上传到服务器,通过使用SpringBoot的文件上传功能,可以轻松地实现文件上传功能,需要的朋友可以参考下
一、请求进入,使用文件上传解析器判断并封装
文件上传解析器：只能接收标准的 Servlet 方式上传的文件
@ConditionalOnMissingBean({MultipartResolver.class}) 判断容器中无文件上传解析器，若无自动创建
@ConditionalOnMissingBean({MultipartResolver.class}) // 判断注解
public StandardServletMultipartResolver multipartResolver() {
StandardServletMultipartResolver multipartResolver = new StandardServletMultipartResolver();
multipartResolver.setResolveLazily(this.multipartProperties.isResolveLazily());
return multipartResolver;
}DispatcherServlet.class —— doDispatch（）方法
与文件上传相关功能有关的语句，请见下面的注释：
protected void doDispatch(HttpServletRequest request, HttpServletResponse response) throws Exception {
HttpServletRequest processedRequest = request;
HandlerExecutionChain mappedHandler = null;
boolean multipartRequestParsed = false;
WebAsyncManager asyncManager = WebAsyncUtils.getAsyncManager(request);
try {
try {
ModelAndView mv = null;
Exception dispatchException = null;
try {
processedRequest = this.checkMultipart(request);
multipartRequestParsed = processedRequest != request; // 判断是否是文件上传请求（封装好的文件上传请求与原请求不相等，则判断是文件上传请求）
mappedHandler = this.getHandler(processedRequest); // 找谁能处理文件上传请求
if (mappedHandler == null) {
this.noHandlerFound(processedRequest, response);
return;
}
HandlerAdapter ha = this.getHandlerAdapter(mappedHandler.getHandler());
String method = request.getMethod();
boolean isGet = "GET".equals(method);
if (isGet || "HEAD".equals(method)) {
long lastModified = ha.getLastModified(request, mappedHandler.getHandler());
if ((new ServletWebRequest(request, response)).checkNotModified(lastModified) && isGet) {
return;
}
}
if (!mappedHandler.applyPreHandle(processedRequest, response)) {
return;
}
mv = ha.handle(processedRequest, response, mappedHandler.getHandler());
if (asyncManager.isConcurrentHandlingStarted()) {
return;
}
this.applyDefaultViewName(processedRequest, mv);
mappedHandler.applyPostHandle(processedRequest, response, mv);
} catch (Exception var20) {
dispatchException = var20;
} catch (Throwable var21) {
dispatchException = new NestedServletException("Handler dispatch failed", var21);
}
this.processDispatchResult(processedRequest, response, mappedHandler, mv, (Exception)dispatchException);
} catch (Exception var22) {
this.triggerAfterCompletion(processedRequest, response, mappedHandler, var22);
} catch (Throwable var23) {
this.triggerAfterCompletion(processedRequest, response, mappedHandler, new NestedServletException("Handler processing failed", var23));
}
} finally {
if (asyncManager.isConcurrentHandlingStarted()) {
if (mappedHandler != null) {
mappedHandler.applyAfterConcurrentHandlingStarted(processedRequest, response);
}
} else if (multipartRequestParsed) {
this.cleanupMultipart(processedRequest);
}
}
}（1） processedRequest = this.checkMultipart(request) —— 用于判断是否是文件上传请求
Step Into 查看：发现使用 multipartResolver 判断是否是文件上传请求
protected HttpServletRequest checkMultipart(HttpServletRequest request) throws MultipartException {
if (this.multipartResolver != null && this.multipartResolver.isMultipart(request)) { // 判断是否是文件上传请求
if (WebUtils.getNativeRequest(request, MultipartHttpServletRequest.class) != null) {
if (request.getDispatcherType().equals(DispatcherType.REQUEST)) {
this.logger.trace("Request already resolved to MultipartHttpServletRequest, e.g. by MultipartFilter");
}
} else if (this.hasMultipartException(request)) {
this.logger.debug("Multipart resolution previously failed for current request - skipping re-resolution for undisturbed error rendering");
} else {
try {
return this.multipartResolver.resolveMultipart(request); // 解析文件上传请求
} catch (MultipartException var3) {
if (request.getAttribute("javax.servlet.error.exception") == null) {
throw var3;
}
}
this.logger.debug("Multipart resolution failed for error dispatch", var3);
}
}
return request;
}StepInto—— multipartResolver 判断是否是文件上传请求方式
用 String 工具类判断是否以 multipart/ 开头（这也解释了为什么我们在写前端表单接收文件时，必须使用multipart）
public boolean isMultipart(HttpServletRequest request) {
return StringUtils.startsWithIgnoreCase(request.getContentType(), "multipart/");
}（2） this.multipartResolver.resolveMultipart(request) 解析文件上传请求
其将文件上传请求封装为 MultipartHttpServletRequest 类返回
public MultipartHttpServletRequest resolveMultipart(HttpServletRequest request) throws MultipartException {
return new StandardMultipartHttpServletRequest(request, this.resolveLazily);
}二、参数解析器解析请求中的文件内容封装成 MultipartFile
文件请求参数解析器：
(1) InvocableHandlerMethod.class 找到参数解析器，执行文件上传代理
public Object resolveArgument(MethodParameter parameter, @Nullable ModelAndViewContainer mavContainer, NativeWebRequest request, @Nullable WebDataBinderFactory binderFactory) throws Exception {
HttpServletRequest servletRequest = (HttpServletRequest)request.getNativeRequest(HttpServletRequest.class);
Assert.state(servletRequest != null, "No HttpServletRequest");
RequestPart requestPart = (RequestPart)parameter.getParameterAnnotation(RequestPart.class);
boolean isRequired = (requestPart == null || requestPart.required()) && !parameter.isOptional();
String name = this.getPartName(parameter, requestPart);
parameter = parameter.nestedIfOptional();
Object arg = null;
Object mpArg = MultipartResolutionDelegate.resolveMultipartArgument(name, parameter, servletRequest); // 文件上传代理
if (mpArg != MultipartResolutionDelegate.UNRESOLVABLE) {
arg = mpArg;
} else {
try {
HttpInputMessage inputMessage = new RequestPartServletServerHttpRequest(servletRequest, name);
arg = this.readWithMessageConverters(inputMessage, parameter, parameter.getNestedGenericParameterType());
if (binderFactory != null) {
WebDataBinder binder = binderFactory.createBinder(request, arg, name);
if (arg != null) {
this.validateIfApplicable(binder, parameter);
if (binder.getBindingResult().hasErrors() && this.isBindExceptionRequired(binder, parameter)) {
throw new MethodArgumentNotValidException(parameter, binder.getBindingResult());
}
}
if (mavContainer != null) {
mavContainer.addAttribute(BindingResult.MODEL_KEY_PREFIX + name, binder.getBindingResult());
}
}
} catch (MultipartException | MissingServletRequestPartException var13) {
if (isRequired) {
throw var13;
}
}
}
}（2）确定每个参数的值
Object[] args = this.getMethodArgumentValues(request, mavContainer, providedArgs);
（3）解析所有参数
for(int i = 0; i < parameters.length; ++i) {
MethodParameter parameter = parameters[i];
parameter.initParameterNameDiscovery(this.parameterNameDiscoverer);
args[i] = findProvidedArgument(parameter, providedArgs);
if (args[i] == null) {
if (!this.resolvers.supportsParameter(parameter)) {
throw new IllegalStateException(formatArgumentError(parameter, "No suitable resolver"));
}
try {
args[i] = this.resolvers.resolveArgument(parameter, mavContainer, request, this.dataBinderFactory);
} catch (Exception var10) {
if (logger.isDebugEnabled()) {
String exMsg = var10.getMessage();
if (exMsg != null && !exMsg.contains(parameter.getExecutable().toGenericString())) {
logger.debug(formatArgumentError(parameter, exMsg));
}
}
throw var10;
}
}
}三、将 request 文件封装为一个 Map (Map<String, MultipartFile>)
AbstractMultipartHttpServletRequest.class
public List<MultipartFile> getFiles(String name) {
List<MultipartFile> multipartFiles = (List)this.getMultipartFiles().get(name);
return multipartFiles != null ? multipartFiles : Collections.emptyList();
}public Map<String, MultipartFile> getFileMap() {
return this.getMultipartFiles().toSingleValueMap();
}总结：
- 请求进入，使用文件上传解析器判断（isMultipart）并封装（resolveMultipart，返回MultipartHttpServletRequest）文件上传请求
- 参数解析器解析请求中的文件内容封装成 MultipartFile
- 将 request 文件封装为一个 Map (Map<String, MultipartFile>)
通过观察源码，可以得到许多 SpringBoot 为我们封装好的文件工具类，如 FileCopyUtils 实现文件流的拷贝
到此这篇关于SpringBoot文件上传的原理解析的文章就介绍到这了,更多相关SpringBoot文件上传内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！
相关文章
Springboot @Validated和@Valid的区别及使用详解
这篇文章主要介绍了Springboot @Validated和@Valid的区别及使用详解，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧2020-05-05
layui 的表格组件目前只支持单列排序，在实际应用中并不能很好的支撑我们的业务需求。今天一时手痒，决定改造一番以支持多重排序。2021-04-04
默认，会帮我们创建src/main/resources 按照Maven的规范，Maven会有3个目录，分别是： src/main/java : java源文件存放位置 src/main/resource : resource资源，如配置文件等 src/test/java : 测试代码源文件存放位置2016-04-04
这篇文章主要讲解一下如何通过注解实现对路由中的路径进行自定义编码，文中的示例代码讲解详细，对我们学习或工作有一定的帮助，需要的可以参考一下2022-06-06
本篇文章主要介绍了springmvc实现导出数据信息为excle表格，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧。2017-01-01
对象进行对象的转换是一个操作重复且繁琐的工作，于是市面上就有许多的对象转换工具来解决这个问题，下面我们就来看看几个比较常用的工具（mapstruct，Spring BeanUtils，Apache BeanUtils）使用方式及其性能2023-04-04
创建Maven项目的时候，如果你选择的Packaging为war，那么就会报错，本文主要介绍了Maven中pom.xml文件报错的原因解决，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧2023-07-07
在本篇文章里小编给各位整理的是一篇关于Java判断字符串回文的代码实例内容，需要的朋友们可以跟着学习参考下。2020-02-02
这篇文章主要介绍了Maven 的配置文件路径读取方法，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧2020-06-06
本文来介绍一题中缀表达式求值的问题，就是给定一个中缀计算式，编写程序将这个式子运算结果给计算出来，其实和后缀表达式的思路差不多，都是栈的运用问题，感兴趣的可以了解一下2022-11-11
最新评论