更新時(shí)間:2021-07-05 16:23:52 來源:動(dòng)力節(jié)點(diǎn) 瀏覽1439次
上傳功能是一個(gè)web應(yīng)用很常用的一個(gè)功能,比如在一些社交網(wǎng)站上傳些圖片、視頻等。本篇文章主要研究了spring mvc是如何實(shí)現(xiàn)文件上傳功能的,在具體講解spring mvc如何實(shí)現(xiàn)處理文件上傳之前,必須弄明白與文件上傳相關(guān)的multipart請(qǐng)求。
我們傳統(tǒng)的表單提交的一般都是文本類型的數(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ù)類型。也就是說,對(duì)于上傳字段對(duì)應(yīng)的塊,它的數(shù)據(jù)類型就可以是二進(jìn)制了:
------WebKitFormBoundaryqgkaBn8IHJCuNmiW
Content-Disposition: form-data; name="firstName"
Charles
------WebKitFormBoundaryqgkaBn8IHJCuNmiW
Content-Disposition: form-data; name="lastName"
Xavier
------WebKitFormBoundaryqgkaBn8IHJCuNmiW
Content-Disposition: form-data; name="email"
charles@xmen.com
------WebKitFormBoundaryqgkaBn8IHJCuNmiW
Content-Disposition: form-data; name="username"
professorx
------WebKitFormBoundaryqgkaBn8IHJCuNmiW
Content-Disposition: form-data; name="password"
letmein01
------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)單的文本類型。
雖然mutipart請(qǐng)求看起來比較復(fù)雜,但是在spring mvc中處理起來是非常簡(jiǎn)單的。在寫我們處理上傳文件的controller之前,我們得先配置一個(gè)Mutipart Resolver來告訴DispatchServlet如何解析一個(gè)mutipart請(qǐng)求。
實(shí)現(xiàn)文件上傳,其實(shí)就是解析一個(gè)Mutipart請(qǐng)求。DispatchServlet自己并不負(fù)責(zé)去解析mutipart請(qǐng)求,而是委托一個(gè)實(shí)現(xiàn)了MultipartResolver接口的類來解析mutipart請(qǐng)求。在Spring3.1之后Spring提供了兩個(gè)現(xiàn)成的MultipartResolver接口的實(shí)現(xiàn)類:
CommonMutipartResolver:通過利用Jakarta Commons FileUpload來解析mutipart請(qǐng)求
StandardServletMutipartResolver:依賴Servlet3.0來解析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)文件上傳的兩種配置。
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依賴于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):
當(dāng)然,如果我們部署的容器不是Servlet3.0,我們還可以使用CommonMutipartResolver,不過這個(gè)需要依賴Apache的commons-fileupload第三方類庫(kù)。
1.配置第三方依賴
<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è)小疑問,上面兩種方式都配置了一個(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。
按照上面的任何一種方式配置好,Spring就已經(jīng)準(zhǔn)備好接受mutipart請(qǐng)求了,下面就需要寫一個(gè)controller來接收上傳的文件了,請(qǐng)看代碼:
@Controller
public class FileUploadController {
@RequestMapping(value = "/uploadFile", method = RequestMethod.POST)
@ResponseBody
public String uploadFileHandler( @RequestParam("file") MultipartFile file) {
if (!file.isEmpty()) {
try {
// 文件存放服務(wù)端的位置
String rootPath = "d:/tmp";
File dir = new File(rootPath + File.separator + "tmpFiles");
if (!dir.exists())
dir.mkdirs();
// 寫文件到服務(wù)器
File serverFile = new File(dir.getAbsolutePath() + File.separator + file.getOriginalFilename());
file.transferTo(serverFile);
return "You successfully uploaded file=" + file.getOriginalFilename();
} catch (Exception e) {
return "You failed to upload " + file.getOriginalFilename() + " => " + e.getMessage();
}
} else {
return "You failed to upload " + file.getOriginalFilename() + " because the file was empty.";
}
}
}
uploadFileHandler
方法中有一個(gè)參數(shù)file,它的類型是MutipartFile,也就是說Spring 會(huì)自動(dòng)把mutipart請(qǐng)求中的二進(jìn)制文件轉(zhuǎn)換成MutipartFile類型的對(duì)象,這么做有什么好處呢?我們具體看一下MutipartFile這個(gè)接口:
public interface MultipartFile {
String getName();
String getOriginalFilename();
String getContentType();
boolean isEmpty();
long getSize();
byte[] getBytes() throws IOException;
InputStream getInputStream() throws IOException;
void transferTo(File var1) throws IOException, IllegalStateException;
}
我們可以看到MutipartFile接口提供了很多方法,諸如獲取上傳文件的名稱、內(nèi)容類型、大小等等,甚至還提供了轉(zhuǎn)換成File類型文件的方法。想想如果我們接收到僅僅是一個(gè)字節(jié)數(shù)組,那用起來該多么麻煩,感激這個(gè)MutipartFile吧。
我們的頁面代碼:
<%@ taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c" %>
<%@ page session="false" %>
<html>
<head>
<title>Upload File Request Page</title>
</head>
<body>
<form method="POST" action="uploadFile" enctype="multipart/form-data">
File to upload: <input type="file" name="file">
<input type="submit" value="Upload"> Press here to upload the file!
</form>
</body>
</html>
其中只有一點(diǎn)需要注意,就是表單的enctype
屬性,這個(gè)屬性值multipart/form-data
會(huì)告訴瀏覽器我們提交的是一個(gè)Mutipart請(qǐng)求而不是一個(gè)普通的form請(qǐng)求。
看一下頁面效果:
運(yùn)行程序,試著上傳一個(gè)文件吧。
以上就是動(dòng)力節(jié)點(diǎn)小編介紹的"SpringMVC文件上傳",希望對(duì)大家有幫助,想了解更多可查看SpringMVC教程,如有疑問,請(qǐng)?jiān)诰€咨詢,有專業(yè)老師隨時(shí)為您服務(wù)。
0基礎(chǔ) 0學(xué)費(fèi) 15天面授
有基礎(chǔ) 直達(dá)就業(yè)
業(yè)余時(shí)間 高薪轉(zhuǎn)行
工作1~3年,加薪神器
工作3~5年,晉升架構(gòu)
提交申請(qǐng)后,顧問老師會(huì)電話與您溝通安排學(xué)習(xí)