（轉(zhuǎn)載）Spring MVC 上傳文件(upload files)
2016-06-13 18:27:35?Heaven-Wang?
版權(quán)聲明：本文為博主原創(chuàng)文章，遵循?CC 4.0 BY-SA?版權(quán)協(xié)議，轉(zhuǎn)載請(qǐng)附上原文出處鏈接和本聲明。
本文鏈接：https://blog.csdn.net/suifeng3051/article/details/51659731
上傳功能是一個(gè)web應(yīng)用很常用的一個(gè)功能，比如在一些社交網(wǎng)站上傳些圖片、視頻等。本篇文章主要研究了spring mvc是如何實(shí)現(xiàn)文件上傳功能的，在具體講解spring mvc如何實(shí)現(xiàn)處理文件上傳之前，必須弄明白與文件上傳相關(guān)的multipart請(qǐng)求。
一、關(guān)于multipart 請(qǐng)求
我們傳統(tǒng)的表單提交的一般都是文本類(lèi)型的數(shù)據(jù)，比如我們的注冊(cè)表單，當(dāng)提交表單時(shí)，表單中的“屬性-值”對(duì)會(huì)被拼接成一個(gè)字符串：
firstName=Charles&lastName=Xavier&email=professorx%40xmen.org &username=professorx&password=letmein01
這種處理方式很簡(jiǎn)單也很有效，但是對(duì)于圖片、視頻等二進(jìn)制數(shù)據(jù)就不能這么處理了，這里就要用到multipart表單了。multipart表單和上面介紹的普通表單不同，它會(huì)把表單分割成塊，表單中的每個(gè)字段對(duì)應(yīng)一個(gè)塊，每個(gè)塊都有自己的數(shù)據(jù)類(lèi)型。也就是說(shuō)，對(duì)于上傳字段對(duì)應(yīng)的塊，它的數(shù)據(jù)類(lèi)型就可以是二進(jìn)制了：
------WebKitFormBoundaryqgkaBn8IHJCuNmiW
Content-Disposition: form-data; name="firstName" Charles
------WebKitFormBoundaryqgkaBn8IHJCuNmiW
Content-Disposition: form-data; name="profilePicture"; filename="me.jpg" Content-Type: image/jpeg
[[ Binary image data goes here ]]
------WebKitFormBoundaryqgkaBn8IHJCuNmiW--
在上面這個(gè)請(qǐng)求就是mutipart 請(qǐng)求，最后一個(gè)字段profilePicture有自己的Content-Type，值是image/jpeg，而其它字段都是簡(jiǎn)單的文本類(lèi)型。
雖然mutipart請(qǐng)求看起來(lái)比較復(fù)雜，但是在spring mvc中處理起來(lái)是非常簡(jiǎn)單的。在寫(xiě)我們處理上傳文件的controller之前，我們得先配置一個(gè)Mutipart Resolver來(lái)告訴DispatchServlet如何解析一個(gè)mutipart 請(qǐng)求。
二、配置mutipart resolver
實(shí)現(xiàn)文件上傳，其實(shí)就是解析一個(gè)Mutipart請(qǐng)求。DispatchServlet自己并不負(fù)責(zé)去解析mutipart 請(qǐng)求，而是委托一個(gè)實(shí)現(xiàn)了MultipartResolver接口的類(lèi)來(lái)解析mutipart請(qǐng)求。在Spring3.1之后Spring提供了兩個(gè)現(xiàn)成的MultipartResolver接口的實(shí)現(xiàn)類(lèi)：
CommonMutipartResolver：通過(guò)利用Jakarta Commons FileUpload來(lái)解析mutipart 請(qǐng)求StandardServletMutipartResolver：依賴(lài)Servlet3.0來(lái)解析mutipart請(qǐng)求
所以要實(shí)現(xiàn)文件上傳功能，只需在我們的項(xiàng)目中配置好這兩個(gè)bean中的任何一個(gè)即可。其實(shí)這兩個(gè)都很好用，如果我們部署的容器支持Servlet3.0，我們完全可以使用StandardServletMutipartResolver。但是如果我們的應(yīng)用部署的容器不支持Servlet3.0或者用到的Spring版本是3.1以前的，那么我們就需要用到CommonMutipartResolver了。下面就具體介紹一下兩種bean的配置，當(dāng)然也是實(shí)現(xiàn)文件上傳的兩種配置。
方式一：?通過(guò)StandardServletMutipartResolver解析mutipart 請(qǐng)求
1.配置multipartResolver的bean
<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver" >
? ? <property name="prefix" value="/WEB-INF/views/" />
? ? <property name="suffix" value=".jsp" />
? ? <property name="viewClass" value="org.springframework.web.servlet.view.JstlView" />
</bean>
<bean id="multipartResolver" class="org.springframework.web.multipart.support.StandardServletMultipartResolver"/>
2.配置MutipartResolver相關(guān)屬性
StandardServletMutipartResolver依賴(lài)于Servlet3.0，所以要想使用StandardServletMutipartResolver，我們還必須在DispatchServlet配置里面 注冊(cè)一個(gè)?MultipartConfigElement元素，具體配置方式如下：
<servlet>
? ? <servlet-name>appServlet</servlet-name>
? ? <servlet-class> org.springframework.web.servlet.DispatcherServlet </servlet-class>
? ? <load-on-startup>1</load-on-startup>
? ? <multipart-config>
? ? ? ? <location>/tmp/spittr/uploads</location>
? ? ? ? <max-file-size>2097152</max-file-size>
? ? ? ? <max-request-size>4194304</max-request-size>
? ? </multipart-config>
</servlet>
mutipart-config里面有三個(gè)配置項(xiàng)：
location：上傳文件用到的臨時(shí)文件夾，是一個(gè)絕對(duì)路徑，需要注意，這個(gè)屬性是必填的
max-file-size:上傳文件的最大值，單位是byte，默認(rèn)沒(méi)有限制
max-request-size:整個(gè)mutipart請(qǐng)求的最大值，單位是byte，默認(rèn)沒(méi)有限制
方式二：通過(guò)CommonMutipartResolver 解析mutipart 請(qǐng)求
當(dāng)然，如果我們部署的容器不是Servlet3.0，我們還可以使用CommonMutipartResolver，不過(guò)這個(gè)需要依賴(lài)Apache的commons-fileupload第三方類(lèi)庫(kù)。
1.配置第三方依賴(lài)
<dependency>
? ? ? ? <groupId>commons-fileupload</groupId>
? ? ? ? <artifactId>commons-fileupload</artifactId>
? ? ? ? <version>1.3.1</version>
</dependency>
2.配置multipartResolver的bean
<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver" >
? ? <property name="prefix" value="/WEB-INF/views/" />
? ? <property name="suffix" value=".jsp" />
? ? <property name="viewClass" value="org.springframework.web.servlet.view.JstlView" />
<bean id="multipartResolver" class="org.springframework.web.multipart.commons.CommonsMultipartResolver">
? ? ? ?<property name="maxUploadSize" value="100000" />
? ? ? ?<property name="maxInMemorySize" value="100000" />
</bean>
使用CommonMutipartResolver不需要在Servlet中配置MultipartConfigElement元素，上傳文件的location屬性也是可選的。
大家可能有個(gè)小疑問(wèn)，上面兩種方式都配置了一個(gè)id=”multipartResolver”的bean，那么DispatchServlet是如何找到這個(gè)bean的呢？我們可以看一下DispatchServlet的源碼，里面有這么一個(gè)方法：
?private void initMultipartResolver(ApplicationContext context) {
? ? try {
? ? ? ? this.multipartResolver = (MultipartResolver)context.getBean("multipartResolver", MultipartResolver.class);
? ? ? ? if(this.logger.isDebugEnabled()) {
? ? ? ? ? ? this.logger.debug("Using MultipartResolver [" + this.multipartResolver + "]");
? ? ? ? }
? ? } catch (NoSuchBeanDefinitionException var3) {
? ? ? ? this.multipartResolver = null;
? ? ? ? if(this.logger.isDebugEnabled()) {
? ? ? ? ? ? this.logger.debug("Unable to locate MultipartResolver with name \'multipartResolver\': no multipart request handling provided");
? ? ? ? }
? ? }
}
這個(gè)方法會(huì)默認(rèn)從Spring的上下文中獲取id為multipartResolver的bean作為它的MutipartResolver。
三、寫(xiě)一個(gè)上傳文件的controller
按照上面的任何一種方式配置好，Spring就已經(jīng)準(zhǔn)備好接受mutipart請(qǐng)求了，下面就需要寫(xiě)一個(gè)controller來(lái)接收上傳的文件了，請(qǐng)看代碼：
uploadFileHandler方法中有一個(gè)參數(shù)file，它的類(lèi)型是MutipartFile，也就是說(shuō)Spring 會(huì)自動(dòng)把mutipart請(qǐng)求中的二進(jìn)制文件轉(zhuǎn)換成MutipartFile類(lèi)型的對(duì)象，這么做有什么好處呢？我們具體看一下MutipartFile這個(gè)接口：
我們可以看到MutipartFile接口提供了很多方法，諸如獲取上傳文件的名稱(chēng)、內(nèi)容類(lèi)型、大小等等，甚至還提供了轉(zhuǎn)換成File類(lèi)型文件的方法。想想如果我們接收到僅僅是一個(gè)字節(jié)數(shù)組，那用起來(lái)該多么麻煩，感激這個(gè)MutipartFile吧。
四、寫(xiě)個(gè)upload.jsp頁(yè)面測(cè)試一下
我們的頁(yè)面代碼：
其中只有一點(diǎn)需要注意，就是表單的enctype屬性，這個(gè)屬性值multipart/form-data會(huì)告訴瀏覽器我們提交的是一個(gè)Mutipart請(qǐng)求而不是一個(gè)普通的form請(qǐng)求。
看一下頁(yè)面效果：
運(yùn)行程序，試著上傳一個(gè)文件吧。
