SpringMVC文件上传原理

最新推荐文章于 2022-04-15 08:54:50 发布
最新推荐文章于 2022-04-15 08:54:50 发布
阅读量352 收藏
点赞数
分类专栏： Spring
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/woshiwjma956/article/details/113737185
版权

文件上传原理 入口首先查看MultipartAutoConfiguration类,该类中定义SpringBoot已经帮我们配置好的一系列文件上传相关的操作

实验Controller

    @ResponseBody
    @PostMapping("/upload")
    public String upload(@RequestPart MultipartFile file) {
        try {
            FileCopyUtils.copy(file.getInputStream(), new FileOutputStream(new File("E:\\java_project\\integration-project\\spring-tutorial\\src\\main\\resources\\test\\" + file.getOriginalFilename())));
        } catch (IOException e) {
            e.printStackTrace();
        }
        return "update success";
    }

在该自动配置类中核心配置了StandardServletMultipartResolver 来处理文件上传逻辑,文件上传相关的配置MultipartProperties这个配置类中,对应yaml文件中的spring.servlet.multipart配置项

@Configuration(proxyBeanMethods = false)
@ConditionalOnClass({ Servlet.class, StandardServletMultipartResolver.class, MultipartConfigElement.class })
@ConditionalOnProperty(prefix = "spring.servlet.multipart", name = "enabled", matchIfMissing = true)
@ConditionalOnWebApplication(type = Type.SERVLET)
@EnableConfigurationProperties(MultipartProperties.class)
public class MultipartAutoConfiguration {

	private final MultipartProperties multipartProperties;

	public MultipartAutoConfiguration(MultipartProperties multipartProperties) {
		this.multipartProperties = multipartProperties;
	}

	@Bean
	@ConditionalOnMissingBean({ MultipartConfigElement.class, CommonsMultipartResolver.class })
	public MultipartConfigElement multipartConfigElement() {
		return this.multipartProperties.createMultipartConfig();
	}

	@Bean(name = DispatcherServlet.MULTIPART_RESOLVER_BEAN_NAME)
	@ConditionalOnMissingBean(MultipartResolver.class)
	public StandardServletMultipartResolver multipartResolver() {
		StandardServletMultipartResolver multipartResolver = new StandardServletMultipartResolver();
		multipartResolver.setResolveLazily(this.multipartProperties.isResolveLazily());
		return multipartResolver;
	}

}

文件上传原理需要分析StandardServletMultipartResolver类

原理步骤

  1. 进入DispatcherServlet#doDispatch方法,检查是否是Multipart请求

    image-20210207101059686

  2. 底层调用了multipartResolver的isMultipart方法判断是不是文件上传请求 isMultipart方法逻辑也很简单 就是判断一下请求头中的ContentType是不是以multipart/开头

    	@Override
	public boolean isMultipart(HttpServletRequest request) {
		return StringUtils.startsWithIgnoreCase(request.getContentType(), "multipart/");
	}

  3. 如果是multipart上传请求 调用 resolver的 resolveMultipart方法将原生的Request包装成一个上传的Request

    public MultipartHttpServletRequest resolveMultipart(HttpServletRequest request) throws MultipartException {
   return new StandardMultipartHttpServletRequest(request, this.resolveLazily);
}

  4. 底层StandardMultipartHttpServletRequest 构造器里面有一个parseRequest方法 里面封装了将request域中的数据封装到一个Map中

    	public StandardMultipartHttpServletRequest(HttpServletRequest request, boolean lazyParsing)
			throws MultipartException {

		super(request);
        // 是否懒解析 默认false 进入parseRequest方法核心
		if (!lazyParsing) {
			parseRequest(request);
		}
	}

    	private void parseRequest(HttpServletRequest request) {
		try {
            // 原生request的getParts方法
			Collection<Part> parts = request.getParts();
            // 保存所有的文件名
			this.multipartParameterNames = new LinkedHashSet<>(parts.size());
            // 一个Map保存了 文件名为K  内容为V的数据
			MultiValueMap<String, MultipartFile> files = new LinkedMultiValueMap<>(parts.size());
            // 遍历parts中的对象 将所有对象封装到该 map中
			for (Part part : parts) {
				String headerValue = part.getHeader(HttpHeaders.CONTENT_DISPOSITION);
				ContentDisposition disposition = ContentDisposition.parse(headerValue);
				String filename = disposition.getFilename();
				if (filename != null) {
					if (filename.startsWith("=?") && filename.endsWith("?=")) {
						filename = MimeDelegate.decode(filename);
					}
					files.add(part.getName(), new StandardMultipartFile(part, filename));
				}
				else {
					this.multipartParameterNames.add(part.getName());
				}
			}
            // 循环完毕之后 将这个Map 设置到该对象multipartFiles属性中,供后面的方法可以使用
			setMultipartFiles(files);
		}
		catch (Throwable ex) {
			handleParseFailure(ex);
		}
	}

  5. 经过上面的步骤将Part文件包装到了MultipleRequest的包装类中的Map中,然后进入handlerAdapter的handler方法跟之前逻辑类似,先找所有的argumentResolvers,调用supportsParameter判断是否支持该类型的参数解析器,我们找到RequestPartMethodArgumentResolver来处理被@RequestPart标记的方法

    protected Object[] getMethodArgumentValues(NativeWebRequest request, @Nullable ModelAndViewContainer mavContainer,
			Object... providedArgs) throws Exception {

		MethodParameter[] parameters = getMethodParameters();
		if (ObjectUtils.isEmpty(parameters)) {
			return EMPTY_ARGS;
		}

		Object[] args = new Object[parameters.length];
		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) {
				continue;
			}
            // 遍历所有argumentsResolver 获取能处理解析器
			if (!this.resolvers.supportsParameter(parameter)) {
				throw new IllegalStateException(formatArgumentError(parameter, "No suitable resolver"));
			}
			try {
                // 找到 RequestPartMethodArgumentResolver 处理
				args[i] = this.resolvers.resolveArgument(parameter, mavContainer, request, this.dataBinderFactory);
			}
			catch (Exception ex) {
				// Leave stack trace for later, exception may actually be resolved and handled...
				if (logger.isDebugEnabled()) {
					String exMsg = ex.getMessage();
					if (exMsg != null && !exMsg.contains(parameter.getExecutable().toGenericString())) {
						logger.debug(formatArgumentError(parameter, exMsg));
					}
				}
				throw ex;
			}
		}
		return args;
	}

  6. 进去该参数解析器中的resolveArgument方法来解析参数, 核心在于调用了MultipartResolutionDelegate.resolveMultipartArgument方法来解析文件上传请求

    	@Override
	@Nullable
	public Object resolveArgument(MethodParameter parameter, @Nullable ModelAndViewContainer mavContainer,
			NativeWebRequest request, @Nullable WebDataBinderFactory binderFactory) throws Exception {
// 拿到原生Request请求
		HttpServletRequest servletRequest = 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 = getPartName(parameter, requestPart);
		parameter = parameter.nestedIfOptional();
		Object arg = null;
		// 核心在于这段代码 调用了MultipartResolutionDelegate代理类的resolveMultipartArgument方法
		Object mpArg = MultipartResolutionDelegate.resolveMultipartArgument(name, parameter, servletRequest);
		if (mpArg != MultipartResolutionDelegate.UNRESOLVABLE) {
			arg = mpArg;
		}
		else {
			try {
				HttpInputMessage inputMessage = new RequestPartServletServerHttpRequest(servletRequest, name);
				arg = readWithMessageConverters(inputMessage, parameter, parameter.getNestedGenericParameterType());
				if (binderFactory != null) {
					WebDataBinder binder = binderFactory.createBinder(request, arg, name);
					if (arg != null) {
						validateIfApplicable(binder, parameter);
						if (binder.getBindingResult().hasErrors() && isBindExceptionRequired(binder, parameter)) {
							throw new MethodArgumentNotValidException(parameter, binder.getBindingResult());
						}
					}
					if (mavContainer != null) {
						mavContainer.addAttribute(BindingResult.MODEL_KEY_PREFIX + name, binder.getBindingResult());
					}
				}
			}
			catch (MissingServletRequestPartException | MultipartException ex) {
				if (isRequired) {
					throw ex;
				}
			}
		}

		if (arg == null && isRequired) {
			if (!MultipartResolutionDelegate.isMultipartRequest(servletRequest)) {
				throw new MultipartException("Current request is not a multipart request");
			}
			else {
				throw new MissingServletRequestPartException(name);
			}
		}
		return adaptArgumentIfNecessary(arg, parameter);
	}

  7. 查看MultipartResolutionDelegate#resolveMultipartArgument方法 各种判断不同类型不同的处理方式

    	@Nullable
	public static Object resolveMultipartArgument(String name, MethodParameter parameter, HttpServletRequest request)
			throws Exception {

		MultipartHttpServletRequest multipartRequest =
				WebUtils.getNativeRequest(request, MultipartHttpServletRequest.class);
		boolean isMultipart = (multipartRequest != null || isMultipartContent(request));

		if (MultipartFile.class == parameter.getNestedParameterType()) {
			if (multipartRequest == null && isMultipart) {
				multipartRequest = new StandardMultipartHttpServletRequest(request);
			}
            // 因为之前new StandardMultipartHttpServletRequest 已经做了parse操作 此时这个multipartRequest中的file已经封装了文件相关内容,只需要去内部的Map中拿执行的文件名曲取即可
			return (multipartRequest != null ? multipartRequest.getFile(name) : null);
		}
		else if (isMultipartFileCollection(parameter)) {
			if (multipartRequest == null && isMultipart) {
				multipartRequest = new StandardMultipartHttpServletRequest(request);
			}
			return (multipartRequest != null ? multipartRequest.getFiles(name) : null);
		}
		else if (isMultipartFileArray(parameter)) {
			if (multipartRequest == null && isMultipart) {
				multipartRequest = new StandardMultipartHttpServletRequest(request);
			}
			if (multipartRequest != null) {
				List<MultipartFile> multipartFiles = multipartRequest.getFiles(name);
				return multipartFiles.toArray(new MultipartFile[0]);
			}
			else {
				return null;
			}
		}
		else if (Part.class == parameter.getNestedParameterType()) {
			return (isMultipart ? request.getPart(name): null);
		}
		else if (isPartCollection(parameter)) {
			return (isMultipart ? resolvePartList(request, name) : null);
		}
		else if (isPartArray(parameter)) {
			return (isMultipart ? resolvePartList(request, name).toArray(new Part[0]) : null);
		}
		else {
			return UNRESOLVABLE;
		}
	}

  8. 此时文件上传的请求参数封装就完毕了,后面就继续调用 doInvoke方法,进入目标方法调用逻辑继续往下执行

  9. 如果没有使用@RequestPart注解 会使用RequestParamMethodArgumentResolver来处理,底层还是调用了MultipartResolutionDelegate#resolveMultipartArugment

    
	@Override
	@Nullable
	protected Object resolveName(String name, MethodParameter parameter, NativeWebRequest request) throws Exception {
		HttpServletRequest servletRequest = request.getNativeRequest(HttpServletRequest.class);

		if (servletRequest != null) {
            // 底层逻辑还是一直
			Object mpArg = MultipartResolutionDelegate.resolveMultipartArgument(name, parameter, servletRequest);
			if (mpArg != MultipartResolutionDelegate.UNRESOLVABLE) {
				return mpArg;
			}
		}

		Object arg = null;
		MultipartRequest multipartRequest = request.getNativeRequest(MultipartRequest.class);
		if (multipartRequest != null) {
			List<MultipartFile> files = multipartRequest.getFiles(name);
			if (!files.isEmpty()) {
				arg = (files.size() == 1 ? files.get(0) : files);
			}
		}
		if (arg == null) {
			String[] paramValues = request.getParameterValues(name);
			if (paramValues != null) {
				arg = (paramValues.length == 1 ? paramValues[0] : paramValues);
			}
		}
		return arg;
	}
夹毛局的程序员
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
SpringMVC文件上传原理及实现过程解析
08-18
主要介绍了SpringMVC文件上传原理及实现过程解析,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
SpringMVC文件上传与下载 源码
08-02
通过以上知识点的学习和源码分析，你将能够熟练地在SpringMVC项目中实现文件上传与下载功能，并理解其实现原理。记得在实际应用中，还要考虑错误处理、安全性（如防止文件覆盖、非法文件上传等）以及性能优化（如大...
springMVC的文件上传
qq_48569009的博客
04-15 554
文件上传的三要素：【表单三要素】 表单项： type：=“file”。 表单的提交方式：post。 表单的encype属性是多部份表单的形式，entype=”multipart/form-data”。 代码示例： 文件上传的原理： 单文件上传： 单文件上传的步骤： 导入文件上传的相关坐标。 在springMVC配置文件中进行配置文件上传解析器。 编写文件上传的代码。 导入文件上传的相关坐标： <!-- 文件上传的坐标--> <de..
SpringMVC文件上传 原理简析与实例
一只大鸭梨
04-12 2694
SpringMVC 文件上传 原理与实例 SpringMVC除了对数据的封装之外，还对文件组件进行了封装。 流程原理和MultipartResolver接口 在DispatcherServlet中定义了一个MultipartResolver属性，如果用户配置了该Bean，启动容器的时候，会自动注入参数，如果用户没有配置，则默认为null。当DispaterServlet收到请求时，它的checkM...
文件上传的原理
学而不思
07-27 1699
1.    文件上传的原理： 表单元素的enctype属性指定的是表单数据的编码方式，该属性有3个值： 1)      application/x-www-form-urlencoded：这是默认编码方式，它只处理表单域里的value属性值，采用这种编码方式的表单会将表单域的值处理成URL编码方式。 2)      multipart/form-data：这种编码方式的表单会以二进制
SpringMVC运行原理以及文件的上传
Dana_i的博客
03-05 313
1、SpringMVC的运行原理 首先是由用户进行发起请求，比如post、get请求，然后服务器会根据传过来的url地址进行匹配，接着DispatcherServlet (前端控制器) 会进行处理。 随后DispatcherServlet收到后会调用HandlerMapping(处理器映射器)，会生成对应的对象全部返回给前端控制器，此时dispatcherServlet会调用经过Adapter...
SpringMVC文件上传，多文件上传实例
03-01
1. **文件上传原理**： 文件上传是通过HTTP协议的POST请求来完成的，通常使用`multipart/form-data`编码类型。在客户端，HTML表单中的`<input type="file">`元素允许用户选择本地文件；在服务器端，我们需要解析...
SpringMVC文件上传功能实例解析
08-31
在本文中，我们将深入探讨如何在SpringMVC中实现文件上传，并理解其背后的原理。 首先，文件上传有两种常见的方式。第一种是通过Apache Commons FileUpload库，这是一个专门用于处理文件上传的第三方组件，它可以...
ssm框架Springmvc文件上传实现代码详解
08-18
ssm框架Springmvc文件上传实现代码详解 ssm框架是基于Spring框架的...通过详细的示例代码和配置，大家可以更好地理解ssm框架Springmvc文件上传实现的原理和实现方法，对大家的学习或者工作具有一定的参考学习价值。
springmvc上传文件功能
gsy_yang的博客
02-27 2556
1.文件上传功能需求： 通过jsp选择文件目录，点击保存到数据库(文件名)。 2.原理：使用Fileupload进行文件上传，springmvc建立文件的虚拟目录，也就是本地磁盘上，用于存放临时文件，这个临时文件是在做文件上传的时候， 通过uuid随机生成文件名（避免文件重复），然后通过MultipartFile 对象的transferTo，将文件内容写入到创建好的临时文件中，将文件名保存到
基于SpringMVC的文件上传下载及显示问题
一点思考
08-16 1972
首先，不得不感慨spring框架的强大，学习了很久还是发现很多东西都只是理解了皮毛，但是往往你所能想到的功能，都可以用编码来实现，只不过效率高低取决于采取什么方法。 今天在完善我的《教务信息管理系统》项目时，构想如下： 教师登录自己的教师系统，可以查看到自己所教授的课程，同时可以进行给学生打分、上传课件等操作； 学生登录自己的学生系统，在已选课程列表可以...
上传文件到第三方平台 java_SpringMVC使用第三方组件实现文件上传
weixin_39633807的博客
02-13 396
一、文件上传的必要前提A form 表单的 enctype 取值必须是：multipart/form-data(默认值是:application/x-www-form-urlencoded) enctype:是表单请求正文的类型B method 属性取值必须是 PostC 提供一个文件选择域 input type=file二、借助第三方组件实现文件上传三、/*** springmvc跨服务器上传文...
Spring MVC上传文件原理和resolveLazily说明
蒜蓉粉丝蒸扇贝的专栏
05-30 2993
问题：使用Spring MVC上传大文件，发现从页面提交，到进入后台controller，时间很长。怀疑是文件上传完成后，才进入。由于在HTTP首部自定义了“Token”字段用于权限校验，Token的有效时间很短，因此上传大文件时，就会验证Token失败。示例代码：前端：&lt;form action="upload" enctype="multipart/form-data" method="p...
SpringMVC 实现文件的上传与下载
z69183787的专栏
06-30 1013
https://www.cnblogs.com/xuningchuanblogs/p/7683866.html一  配置SpringMVC ,并导入与文件上传下载有关的jar包（在此不再赘述）二 新建 相应 jsp 和controllerFileUpAndDown.jsp&lt;%@ page language="java" contentType="text/html; charset=UTF-...
SpringMVC之文件上传功能实现
carson0408的博客
04-02 3242
         在客户端发送上传文件请求时，一般会与普通请求一样，将请求发送给SpringMVC的前端控制器DispatcherServlet，然后由DispatcherServlet调用HandlerMapping找到处理该请求的Controller。然后DispatcherServlet将请求提交给Controller(如果不适用可以会自动调用HandlerAdapter适配)。Contro...
springMVC实现文件上传
北纬30°
09-28 418
了解springMVC详见： springMVC实现上传功能也不难。只要理解springMVC的原理和逻辑，学习起来就比较轻松。 springMVC逻辑基础理解文章：https://blog.csdn.net/qq_41879385/article/details/82858489 注：本篇代码是跟着上一篇代码写在一起的的。 MultipartResolver springMVC文件上传...
利用MultipartFile实现文件上传
热门推荐
hbcui1984的专栏
01-30 22万+
利用MultipartFile实现文件上传         在java中上传文件似乎总有点麻烦,没.net那么简单,记得最开始的时候用smartUpload实现文件上传,最近在工作中使用spring的MultipartFile实现文件上传,感觉挺简单,在这里和大家分享一下.一.主要有两个java类,和一般的servlet放在一起即可.1.FileUploadBean.java
spring boot的单个文件多文件上传原理及使用
qq_46341024的博客
08-04 1679
一、原理 自动配置原理 文件上传自动配置类-MultipartAutoConfiguration-MultipartProperties 自动配置好了 StandardServletMultipartResolver 【文件上传解析器】 原理步骤 1、请求进来使用文件上传解析器判断（isMultipart）并封装（resolveMultipart，返回MultipartHttpServletRequest）文件上传请求 2、参数解析器来解析请求中的文件内容封装成MultipartFile 3、将r
layui框架的上传文件原理
最新发布
05-24
Layui框架使用了多种技术来实现文件上传，其中最常用的是Ajax上传和iframe上传。 Ajax上传是指通过...其中，SpringMVC提供的MultipartResolver组件是一个比较好用的文件上传组件，可以方便地实现文件上传功能。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值