SpringMVC文件上傳請求問題分析
我們文件上傳接口只需要在方法參數(shù)上寫MultipartFile類,mvc就可以幫我們把上傳的文件封裝為這個類的對
象供我們非常方便的操作,那它是怎么做的呢?我們一起來看看
我們發(fā)的請求默認(rèn)都是由DispatcherServlet類的doDispatch()
來處理,這個方法的邏輯處理的第一步就是處理文件上傳的請求,我們一起來看看是怎么處理的吧。
本文分析的問題:文件上傳請求的執(zhí)行原理、文件上傳自動配置原理
執(zhí)行流程原理
checkMultipart()-處理文件上傳的請求
processedRequest = checkMultipart(request)
:處理文件上傳請求。所以我們把這個方法看明白就知道了
@Nullable // 文件上傳解析器,只能有一個 private MultipartResolver multipartResolver; protected HttpServletRequest checkMultipart(HttpServletRequest request) throws MultipartException { // 1.利用文件上傳解析器來判斷是否是文件上傳請求 if (this.multipartResolver != null && this.multipartResolver.isMultipart(request)) { // 如果之前被MultipartFilter包裝過了,就不做處理 if (WebUtils.getNativeRequest(request, MultipartHttpServletRequest.class) != null) { if (DispatcherType.REQUEST.equals(request.getDispatcherType())) { logger.trace("Request already resolved to MultipartHttpServletRequest, e.g. by MultipartFilter"); } } // 是否有異常 else if (hasMultipartException(request)) { logger.debug("Multipart resolution previously failed for current request - " + "skipping re-resolution for undisturbed error rendering"); } else { try { // 2、利用文件上傳解析器來解析文件上傳的請求 return this.multipartResolver.resolveMultipart(request); } catch (MultipartException ex) { if (request.getAttribute(WebUtils.ERROR_EXCEPTION_ATTRIBUTE) != null) { logger.debug("Multipart resolution failed for error dispatch", ex); // Keep processing error dispatch with regular request handle below } else { throw ex; } } } } // If not returned before: return original request. return request; }
流程:
- 利用 MultipartResolver(文件上傳解析器)來判斷是否是文件上傳請求:
isMultipart
默認(rèn)使用StandardServletMultipartResolver
- 利用 MultipartResolver(文件上傳解析器)來解析文件上傳的請求:
resolveMultipart()
會把請求包裝為StandardMultipartHttpServletRequest
這些工作都是利用文件上傳解析器來做的,所以我們把文件上傳解析器搞明白也就知道了
繼承圖:
MultipartResolver(文件上傳解析器)
主要作用就是把真實文件包裝為MultipartFile對象,并緩存起來以便后面封裝參數(shù)時使用
public interface MultipartResolver { // 判斷請求是否是文件上傳的請求 boolean isMultipart(HttpServletRequest request); // 將請求包裝為 StandardMultipartHttpServletRequest MultipartHttpServletRequest resolveMultipart(HttpServletRequest request) throws MultipartException; // 清除資源 void cleanupMultipart(MultipartHttpServletRequest request); }
1、 isMultipart()
:判斷請求是否是文件上傳的請求。其實就是判斷 Content-Type 的值是否是以
multipart/form-data 或 multipart/ 開頭
(這里也就解釋了為啥我們發(fā)送文件上傳的請求時 Content-Type的值要為 multipart/form-data)
2、resolveMultipart()
:將請求包裝為MultipartHttpServletRequest
MultipartResolver 的默認(rèn)實現(xiàn)是 StandardServletMultipartResolver,它會把請求封裝為StandardMultipartHttpServletRequest,把文件封裝為StandardMultipartFile
// 是否延遲解析 private boolean resolveLazily = false; // 判斷 public boolean isMultipart(HttpServletRequest request) { return StringUtils.startsWithIgnoreCase(request.getContentType(), (this.strictServletCompliance ? MediaType.MULTIPART_FORM_DATA_VALUE : "multipart/")); } // 包裝請求 public MultipartHttpServletRequest resolveMultipart(HttpServletRequest request) throws MultipartException { return new StandardMultipartHttpServletRequest(request, this.resolveLazily); }
MultipartHttpServletRequest(文件上傳請求)
默認(rèn)實現(xiàn)StandardMultipartHttpServletRequest
,會把文件封裝為StandardMultipartFile
// 創(chuàng)建文件上傳請求 public StandardMultipartHttpServletRequest(HttpServletRequest request, boolean lazyParsing) throws MultipartException { super(request); // 是否延遲解析,默認(rèn)false if (!lazyParsing) { // 解析請求 parseRequest(request); } } private void parseRequest(HttpServletRequest request) { try { // 從 HttpServletRequest 中獲取上傳的文件 Collection<Part> parts = request.getParts(); this.multipartParameterNames = new LinkedHashSet<>(parts.size()); // 存儲封裝好的文件對象 MultiValueMap<String, MultipartFile> files = new LinkedMultiValueMap<>(parts.size()); // 遍歷所有的文件 for (Part part : parts) { String headerValue = part.getHeader(HttpHeaders.CONTENT_DISPOSITION); ContentDisposition disposition = ContentDisposition.parse(headerValue); // 獲取文件名字 String filename = disposition.getFilename(); if (filename != null) { // 添加到集合中 files.add(part.getName(), new StandardMultipartFile(part, filename)); } else { // 沒有文件名,就是普通參數(shù)了 this.multipartParameterNames.add(part.getName()); } } // 將上面所有生成的 StandardMultipartFile 文件對象設(shè)置到父類的 multipartFiles屬性中 // 以便后面封裝參數(shù)時使用 setMultipartFiles(files); } catch (Throwable ex) { handleParseFailure(ex); } } protected final void setMultipartFiles(MultiValueMap<String, MultipartFile> multipartFiles) { this.multipartFiles = new LinkedMultiValueMap<>(Collections.unmodifiableMap(multipartFiles)); }
從
HttpServletRequest
中獲取上傳的文件Part
遍歷所有的文件
從
Part
中獲取請求頭Content-Disposition
的值,解析生成ContentDisposition
對象,然后獲取文件名情況1:文件名不為空,說明是文件,把文件封裝為
StandardMultipartFile
對象情況2:文件名為空,說明是普通參數(shù),則保存參數(shù)名稱
將上面所有生成的
StandardMultipartFile
文件對象設(shè)置到父類的multipartFiles
屬性中,以便后面封裝參數(shù)時使用
整個執(zhí)行的原理到這里也就完畢了。
自動配置原理
文件上傳的自動配置類是MultipartAutoConfiguration
@AutoConfiguration @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) 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; } }
啟用文件上傳的配置類
MultipartProperties
,配置前綴:spring.servlet.multipart
也就是說我們可以通過這個類,然后在
application.yml
配置文件中來配置默認(rèn)底層的規(guī)則給容器中導(dǎo)入了
MultipartConfigElement
類:文件上傳的配置我們可以在容器中自己注冊這個類
給容器中導(dǎo)入了文件上傳解析器
StandardServletMultipartResolver
,標(biāo)準(zhǔn)的Servlet文件上傳解析器,用來處理文件上傳設(shè)置了
resolveLazily
屬性:解析文件是否延遲解析,默認(rèn)不是延遲解析
我們也可以往容器中注冊我們自定義的文件上傳解析器,SpringBoot就會使用我們的。因為有條件注解來動態(tài)判斷
總結(jié)
執(zhí)行流程:利用 StandardServletMultipartResolver
(文件上傳解析器)來包裝請求、把每一個真實文件封裝為MultipartFile
類,以便我們能簡單的操作。還會把所有的MultipartFile
對象設(shè)置到父類的multipartFiles
屬性中,以便后面封裝參數(shù)時使用
自動配置:利用SpringBoot的自動配置往容器中注冊一個默認(rèn)的文件上傳解析器
注意:文件上傳解析器默認(rèn)全局只能有一個,不能像 HandlerMapping
、HandlerAdapter
有多個
DispatcherServlet中就是這么寫的
@Nullable private MultipartResolver multipartResolver; private List<HandlerMapping> handlerMappings; /** List of HandlerAdapters used by this servlet. */ @Nullable private List<HandlerAdapter> handlerAdapters;
到此這篇關(guān)于SpringMVC文件上傳請求的文章就介紹到這了,更多相關(guān)SpringMVC文件上傳請求內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
java編程中拷貝數(shù)組的方式及相關(guān)問題分析
這篇文章主要介紹了java編程中拷貝數(shù)組的方式及相關(guān)問題分析,分享了Java中數(shù)組復(fù)制的四種方式,其次對二維數(shù)組的簡單使用有一段代碼示例,具有一定參考價值,需要的朋友可以了解下。2017-11-11easyexcel讀取excel合并單元格數(shù)據(jù)的操作代碼
這篇文章主要介紹了easyexcel讀取excel合并單元格數(shù)據(jù)的操作代碼,本文通過實例代碼給大家介紹的非常詳細(xì),對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值,需要的朋友可以參考下2023-05-05Spring Web項目spring配置文件隨服務(wù)器啟動時自動加載
這篇文章主要介紹了Spring Web項目spring配置文件隨服務(wù)器啟動時自動加載,加載spring的配置文件,并且只加載一次,從而提高程序效率。具體內(nèi)容詳情大家通過本文一起學(xué)習(xí)吧2018-01-01java后端+前端使用WebSocket實現(xiàn)消息推送的詳細(xì)流程
后端向前端推送消息就需要長連接,首先想到的就是websocket,下面這篇文章主要給大家介紹了關(guān)于java后端+前端使用WebSocket實現(xiàn)消息推送的詳細(xì)流程,需要的朋友可以參考下2022-10-10Spring boot中自定義Json參數(shù)解析器的方法
這篇文章主要介紹了Spring boot中自定義Json參數(shù)解析器的方法,小編覺得挺不錯的,現(xiàn)在分享給大家,也給大家做個參考。一起跟隨小編過來看看吧2019-01-01java遍歷http請求request的所有參數(shù)實現(xiàn)方法
下面小編就為大家?guī)硪黄猨ava遍歷http請求request的所有參數(shù)實現(xiàn)方法。小編覺得挺不錯的,現(xiàn)在就分享給大家,也給大家做個參考。一起跟隨小編過來看看吧2016-09-09Java 反射獲取類詳細(xì)信息的常用方法總結(jié)
Java 反射獲取類詳細(xì)信息的常用方法總結(jié),需要的朋友可以參考一下2013-03-03