Springboot 是怎么支持文件上传的?

背景

最近在做国产化中间件适配,替换Tomcat后,发现原来上传文件的功能失败,原因是获取不到上传的文件信息,最终通过跟踪执行流程,阅读源码,发现了问题产生的原因,也因此了解到了Springboot上传文件的实现步骤

简单说:tomcat 先将文件上传到tomcat临时目录(我们一般都没指定文件夹),tomcat 会将文件信息封装为一个对象,我们使用这个对象,就可以获取文件流,从而将从页面上传的文件写入到我们要上传到的目标文件夹下面

下面我们就一步步进行反推,从使用开始!

1.文件上传

这个不多说,在百度 搜索 springboot 上传文件 就会有一大堆的demo可以参考

但不管代码怎么变,最终都逃不过 MultipartHttpServletRequest ,这个request对象

图1-转换request对象为MultipartHttpServletRequest,再获取文件对象MultipartFile

1.1上传报错,MultipartFile 对象为空

更换中间件后,执行上传操作,发现获取不到 图1 所示sFileName
因此逐步排查,是什么原因导致 sFileName 为空

2.排查

2.1 org.springframework.web.multipart.MultipartHttpServletRequest

这是一个接口
根据代码,我们可以发现,从传进来的HttpServletRequest会转化为MultipartHttpServletRequest,再从MultipartHttpServletRequest里获取MultipartFile对象(也就是最终操作的文件对象)

图2.1-1

2.2 org.springframework.web.multipart.support.AbstractMultipartHttpServletRequest#getFiles

MultipartHttpServletRequest要获取到MultipartFile对象,实际上是他的实现类AbstractMultipartHttpServletRequest去获取

图2.2-1

图2.2-2

到这里的时候,multipartFiles 已经被初始化了!

那么他在哪里进行初始化的呢?

2.3 org.springframework.web.multipart.support.StandardMultipartHttpServletRequest#parseRequest

图2.3-1

在这里
我们发现, this.setMultipartFiles(files); 语句对 multipartFiles 进行了赋值

但是赋值的值来源于 request.getParts();

那么,问题来了

request的parts又是从哪来的呢?

2.4 org.springframework.web.servlet.DispatcherServlet#doDispatch

图2.4-1

在这里会检查是否是上传请求,也就是在这里,对
StandardMultipartHttpServletRequest 进行了初始化操作

在这里,还是没解决 request的parts又是从哪来的呢?

继续跟踪

debug ...

3 debug 跟踪

主要就是要找到,是在什么时候,对request的parts对象赋值了

第三章可以从后往前看,这是debug后倒推的步骤,看着会有点别扭

3.1 org.apache.catalina.connector.Request#parseParts

为什么突然定位到这里,答案是debug过来的

图3.1-1

这里有一个 MultipartConfigElement 对象在后面第四章讲一下

3.1.1 tomcat进行文件上传

图3.1.1-1
图3.1.1-2

在这里,tomcat 会将文件上传到 tomcat 的临时目录下,我们在后面读取的文件流(第一章 图1),其实是读取的 tomcat 放到服务器上的文件的文件流

我们可以指定 tomcat 将临时文件放在哪里,只需要在配置文件里配置就行

比如:

spring.http.multipart.location=D:\\temp\\file\\upload

3.1.2 对parts赋值

3.1.2-1 添加part,对parts赋值

这一步就是我们苦苦找寻的 request的parts又是从哪来的呢?

3.2 org.apache.catalina.connector.Request#parseParameters

图3.2-1

从图里我们也可以知道,为什么上传图片的时候要求 contentType = multipart/form-data 了

3.3 org.apache.catalina.connector.Request#getParameter

图3.3-1

3.4 org.apache.catalina.connector.RequestFacade#getParameter

图3.4-1

3.5 org.springframework.web.filter.HiddenHttpMethodFilter#doFilterInternal

图3.5-1

post请求,会对参数做特殊处理,这里面就涉及到了 tomcat 对文件的默认上传

4. MultipartConfigElement

图4-1

我们从 图 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.总结

至此,从配置 文件上传大小,到文件上传到我们指定的位置,就已经非常清楚的走了一遍

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,470评论 6 501
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,393评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,577评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,176评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,189评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,155评论 1 299
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,041评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,903评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,319评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,539评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,703评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,417评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,013评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,664评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,818评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,711评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,601评论 2 353