背景
最近在做国产化中间件适配,替换Tomcat后,发现原来上传文件的功能失败,原因是获取不到上传的文件信息,最终通过跟踪执行流程,阅读源码,发现了问题产生的原因,也因此了解到了Springboot上传文件的实现步骤
简单说:tomcat 先将文件上传到tomcat临时目录(我们一般都没指定文件夹),tomcat 会将文件信息封装为一个对象,我们使用这个对象,就可以获取文件流,从而将从页面上传的文件写入到我们要上传到的目标文件夹下面
下面我们就一步步进行反推,从使用开始!
1.文件上传
这个不多说,在百度 搜索 springboot 上传文件 就会有一大堆的demo可以参考
但不管代码怎么变,最终都逃不过 MultipartHttpServletRequest ,这个request对象
1.1上传报错,MultipartFile 对象为空
更换中间件后,执行上传操作,发现获取不到 图1 所示sFileName
因此逐步排查,是什么原因导致 sFileName 为空
2.排查
2.1 org.springframework.web.multipart.MultipartHttpServletRequest
这是一个接口
根据代码,我们可以发现,从传进来的HttpServletRequest会转化为MultipartHttpServletRequest,再从MultipartHttpServletRequest里获取MultipartFile对象(也就是最终操作的文件对象)
2.2 org.springframework.web.multipart.support.AbstractMultipartHttpServletRequest#getFiles
MultipartHttpServletRequest要获取到MultipartFile对象,实际上是他的实现类AbstractMultipartHttpServletRequest去获取
到这里的时候,multipartFiles 已经被初始化了!
那么他在哪里进行初始化的呢?
2.3 org.springframework.web.multipart.support.StandardMultipartHttpServletRequest#parseRequest
在这里
我们发现, this.setMultipartFiles(files); 语句对 multipartFiles 进行了赋值
但是赋值的值来源于 request.getParts();
那么,问题来了
request的parts又是从哪来的呢?
2.4 org.springframework.web.servlet.DispatcherServlet#doDispatch
在这里会检查是否是上传请求,也就是在这里,对
StandardMultipartHttpServletRequest 进行了初始化操作
在这里,还是没解决 request的parts又是从哪来的呢?
继续跟踪
debug ...
3 debug 跟踪
主要就是要找到,是在什么时候,对request的parts对象赋值了
第三章可以从后往前看,这是debug后倒推的步骤,看着会有点别扭
3.1 org.apache.catalina.connector.Request#parseParts
为什么突然定位到这里,答案是debug过来的
这里有一个 MultipartConfigElement 对象在后面第四章讲一下
3.1.1 tomcat进行文件上传
在这里,tomcat 会将文件上传到 tomcat 的临时目录下,我们在后面读取的文件流(第一章 图1),其实是读取的 tomcat 放到服务器上的文件的文件流
我们可以指定 tomcat 将临时文件放在哪里,只需要在配置文件里配置就行
比如:
spring.http.multipart.location=D:\\temp\\file\\upload
3.1.2 对parts赋值
这一步就是我们苦苦找寻的 request的parts又是从哪来的呢?
3.2 org.apache.catalina.connector.Request#parseParameters
从图里我们也可以知道,为什么上传图片的时候要求 contentType = multipart/form-data 了
3.3 org.apache.catalina.connector.Request#getParameter
3.4 org.apache.catalina.connector.RequestFacade#getParameter
3.5 org.springframework.web.filter.HiddenHttpMethodFilter#doFilterInternal
post请求,会对参数做特殊处理,这里面就涉及到了 tomcat 对文件的默认上传
4. MultipartConfigElement
我们从 图 3.1-1 可以看到,有行代码:
MultipartConfigElement mce = this.getWrapper().getMultipartConfigElement();
MultipartConfigElement 的作用是啥?
用来配置上传文件大小等信息的
如果上传的文件超过了默认设置,就会报下面的这个错
Could not parse multipart servlet request; nested exception is java.lang.IllegalStateException: org.apache.tomcat.util.http.fileupload.FileUploadBase$SizeLimitExceededException: the request was rejected because its size (27503483) exceeds the configured maximum (10485760)
解决这个报错的方法就是,在application.properties文件中加入下面这两个配置就完了
# 单个文件大小
spring.http.multipart.maxFileSize=1000Mb
# 总上传的数据大小
spring.http.multipart.maxRequestSize=10000Mb
4.1 MultipartProperties
Springboot又是在哪里读取配置文件里的数据的?
直接在 MultipartConfigElement 的构造器打上断点,你就可以跟踪到 org.springframework.boot.autoconfigure.web.MultipartProperties
这个类有 ConfigurationProperties 注解,标识是一个配置类,Springboot 会自动对他进行赋值
5.总结
至此,从配置 文件上传大小,到文件上传到我们指定的位置,就已经非常清楚的走了一遍