SpringMVC工作原理☞:MultipartResolver
- boolean isMultipart(HttpServletRequest request); // 是否是 multipart
- MultipartHttpServletRequest resolveMultipart(HttpServletRequest request); // 解析請求
- void cleanupMultipart(MultipartHttpServletRequest request);
MultipartFile 封裝了請求資料中的檔案,此時這個檔案儲存在記憶體中或臨時的磁碟檔案中,需要將其轉存到一個合適的位置,因為請求結束後臨時儲存將被清空。在 MultipartFile 介面中有如下方法:
- String getName(); // 獲取引數的名稱
- String getOriginalFilename(); // 獲取檔案的原名稱
- String getContentType(); // 檔案內容的型別
- boolean isEmpty(); // 檔案是否為空
- long getSize(); // 檔案大小
- byte[] getBytes(); // 將檔案內容以位元組陣列的形式返回
- InputStream getInputStream(); // 將檔案內容以輸入流的形式返回
- void transferTo(File dest); // 將檔案內容傳輸到指定檔案中
- MultipartResolver 是一個介面,它的實現類如下圖所示,分為 CommonsMultipartResolver 類和 StandardServletMultipartResolver 類。
其中 CommonsMultipartResolver 使用 commons Fileupload 來處理 multipart 請求,所以在使用時,必須要引入相應的 jar 包;而 StandardServletMultipartResolver 是基於 Servlet 3.0來處理 multipart 請求的,所以不需要引用其他 jar 包,但是必須使用支援 Servlet 3.0的容器才可以,以tomcat為例,從 Tomcat 7.0.x的版本開始就支援 Servlet 3.0了。
一、CommonsMultipartResolver
1. 使用方式
1.1 配置檔案
<!-- 定義檔案上傳解析器 -->
<bean id="multipartResolver" class="org.springframework.web.multipart.commons.CommonsMultipartResolver">
<!-- 設定預設編碼 -->
<property name="defaultEncoding" value="UTF-8"></property>
<!-- 設定檔案上傳的最大值為5MB,5*1024*1024 -->
<property name="maxUploadSize" value="5242880"></property>
<!-- 設定檔案上傳時寫入記憶體的最大值,如果小於這個引數不會生成臨時檔案,預設為10240 -->
<property name="maxInMemorySize" value="40960"></property>
<!-- 上傳檔案的臨時路徑 -->
<property name="uploadTempDir" value="fileUpload/temp"></property>
<!-- 延遲檔案解析 -->
<property name="resolveLazily" value="true"/>
</bean>
1.2 上傳表單
要在 form 標籤中加入 enctype=“multipart/form-data” 表示該表單要提交檔案。
<form action="${pageContext.request.contextPath}/test/file-upload.do" method="post" enctype="multipart/form-data">
<input type="file" name="file">
<input type="submit" value="提交">
</form>
1.3 處理檔案
@RequestMapping("/file-upload")
public ModelAndView upload(@RequestParam(value = "file", required = false) MultipartFile file,
HttpServletRequest request, HttpSession session) {
// 檔案不為空
if(!file.isEmpty()) {
// 檔案存放路徑
String path = request.getServletContext().getRealPath("/");
// 檔名稱
String name = String.valueOf(new Date().getTime()+"_"+file.getOriginalFilename());
File destFile = new File(path,name);
// 轉存檔案
try {
file.transferTo(destFile);
} catch (IllegalStateException | IOException e) {
e.printStackTrace();
}
// 訪問的url
String url = request.getScheme() + "://" + request.getServerName() + ":" + request.getServerPort()
+ request.getContextPath() + "/" + name;
}
ModelAndView mv = new ModelAndView();
mv.setViewName("other/home");
return mv;
}
2. 原始碼分析
CommonsMultipartResolver 實現了 MultipartResolver 介面,resolveMultipart() 方法如下所示,其中 resolveLazily 是判斷是否要延遲解析檔案(通過XML可以設定)。當 resolveLazily 為 flase 時,會立即呼叫 parseRequest() 方法對請求資料進行解析,然後將解析結果封裝到 DefaultMultipartHttpServletRequest 中;而當 resolveLazily 為 true 時,會在 DefaultMultipartHttpServletRequest 的 initializeMultipart() 方法呼叫 parseRequest() 方法對請求資料進行解析,而 initializeMultipart() 方法又是被 getMultipartFiles() 方法呼叫,即當需要獲取檔案資訊時才會去解析請求資料,這種方式用了懶載入的思想。
@Override
public MultipartHttpServletRequest resolveMultipart(final HttpServletRequest request) throws MultipartException {
Assert.notNull(request, "Request must not be null");
if (this.resolveLazily) {
//懶載入,當呼叫DefaultMultipartHttpServletRequest的getMultipartFiles()方法時才解析請求資料
return new DefaultMultipartHttpServletRequest(request) {
@Override //當getMultipartFiles()方法被呼叫時,如果還未解析請求資料,則呼叫initializeMultipart()方法進行解析 protected void initializeMultipart() {
MultipartParsingResult parsingResult = parseRequest(request);
setMultipartFiles(parsingResult.getMultipartFiles());
setMultipartParameters(parsingResult.getMultipartParameters());
setMultipartParameterContentTypes(parsingResult.getMultipartParameterContentTypes());
}
};
} else {
//立即解析請求資料,並將解析結果封裝到DefaultMultipartHttpServletRequest物件中
MultipartParsingResult parsingResult = parseRequest(request);
return new DefaultMultipartHttpServletRequest(request, parsingResult.getMultipartFiles(),
parsingResult.getMultipartParameters(), parsingResult.getMultipartParameterContentTypes());
}
}
在上面的程式碼中可以看到,對請求資料的解析工作是在 parseRequest() 方法中進行的,繼續看一下 parseRequest() 方法原始碼
protected MultipartParsingResult parseRequest(HttpServletRequest request) throws MultipartException {
// 獲取請求的編碼型別
String encoding = determineEncoding(request);
FileUpload fileUpload = prepareFileUpload(encoding);
try {
List<FileItem> fileItems = ((ServletFileUpload) fileUpload).parseRequest(request);
return parseFileItems(fileItems, encoding);
} catch (...) {}
}
在 parseRequest() 方法中,首先呼叫了 prepareFileUpload() 方法來根據編碼型別確定一個 FileUpload 例項,然後利用這個 FileUpload 例項解析請求資料後得到檔案資訊,最後將檔案資訊解析成 CommonsMultipartFile (實現了 MultipartFile 介面) 幷包裝在 MultipartParsingResult 物件中。
二、StandardServletMultipartResolver
1. 使用方式
1.1 配置檔案
<bean id="multipartResolver" class="org.springframework.web.multipart.support.StandardServletMultipartResolver">
</bean>
這裡並沒有配置檔案大小等引數,這些引數的配置在 web.xml 中
<servlet>
<servlet-name>springmvc</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<init-param>
<param-name>contextConfigLocation</param-name>
<param-value>classpath:springmvc.xml</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
<multipart-config>
<!-- 臨時檔案的目錄 -->
<location>d:/</location>
<!-- 上傳檔案最大2M -->
<max-file-size>2097152</max-file-size>
<!-- 上傳檔案整個請求不超過4M -->
<max-request-size>4194304</max-request-size>
</multipart-config>
</servlet>
1.2 上傳表單
要在 form 標籤中加入 enctype=“multipart/form-data” 表示該表單要提交檔案。
<form action="${pageContext.request.contextPath}/test/file-upload.do" method="post" enctype="multipart/form-data">
<input type="file" name="file">
<input type="submit" value="提交">
</form>
1.3 處理檔案
1.3.1 通過 MultipartFile 型別的引數
@RequestMapping("/file-upload")
public ModelAndView upload(@RequestParam(value = "file", required = false) MultipartFile file,
HttpServletRequest request, HttpSession session) {
// 檔案不為空
if(!file.isEmpty()) {
// 檔案存放路徑
String path = request.getServletContext().getRealPath("/");
// 檔名稱
String name = String.valueOf(new Date().getTime()+"_"+file.getOriginalFilename());
File destFile = new File(path,name);
// 轉存檔案
try {
file.transferTo(destFile);
} catch (IllegalStateException | IOException e) {
e.printStackTrace();
}
// 訪問的url
String url = request.getScheme() + "://" + request.getServerName() + ":" + request.getServerPort()
+ request.getContextPath() + "/" + name;
}
ModelAndView mv = new ModelAndView();
mv.setViewName("other/home");
return mv;
}
1.3.2 通過 MultipartHttpServletRequest 型別的引數
@RequestMapping("/file-upload")
public ModelAndView upload(MultipartHttpServletRequest request, HttpSession session) {
// 根據頁面input標籤的name
MultipartFile file = request.getFile("file");
// 檔案不為空
if(!file.isEmpty()) {
// 檔案存放路徑
String path = request.getServletContext().getRealPath("/");
// 檔名稱
String name = String.valueOf(new Date().getTime()+"_"+file.getOriginalFilename());
File destFile = new File(path,name);
// 轉存檔案
try {
file.transferTo(destFile);
} catch (IllegalStateException | IOException e) {
e.printStackTrace();
}
// 訪問的url
String url = request.getScheme() + "://" + request.getServerName() + ":" + request.getServerPort()
+ request.getContextPath() + "/" + name;
}
ModelAndView mv = new ModelAndView();
mv.setViewName("other/home");
return mv;
}
2. 原始碼分析
StandardServletMultipartResolver 實現了 MultipartResolver 介面,resolveMultipart() 方法如下所示,其中 resolveLazily 是判斷是否要延遲解析檔案(通過XML可以設定)。
public MultipartHttpServletRequest resolveMultipart(HttpServletRequest request) throws MultipartException {
return new StandardMultipartHttpServletRequest(request, this.resolveLazily);
}
public StandardMultipartHttpServletRequest(HttpServletRequest request, boolean lazyParsing) throws MultipartException {
super(request);
// 判斷是否立即解析
if (!lazyParsing) {
parseRequest(request);
}
}
對請求資料的解析工作是在 parseRequest() 方法中進行的,繼續看一下 parseRequest() 方法原始碼
private void parseRequest(HttpServletRequest request) {
try {
Collection<Part> parts = request.getParts();
this.multipartParameterNames = new LinkedHashSet<String>(parts.size());
MultiValueMap<String, MultipartFile> files = new LinkedMultiValueMap<String, MultipartFile>(parts.size());
for (Part part : parts) {
String disposition = part.getHeader(CONTENT_DISPOSITION);
String filename = extractFilename(disposition);
if (filename == null) {
filename = extractFilenameWithCharset(disposition);
}
if (filename != null) {
files.add(part.getName(), new StandardMultipartFile(part, filename));
} else {
this.multipartParameterNames.add(part.getName());
}
}
setMultipartFiles(files);
} catch (Throwable ex) {}
}
parseRequest() 方法利用了 servlet3.0 的 request.getParts() 方法獲取上傳檔案,並將其封裝到 MultipartFile 物件中。