文件上传概述
多数文件上传都是通过表单形式提交给后台服务器的,因此,要实现文件上传功能,就需要提供一个文件上传的表单,而该表单必须满足以下3个条件:
● form表单的method属性设置为post;
● form表单的enctype属性设置为multipart/form-data;
● 提供<input type="file" name="filename" />的文件上传输入框。
文件上传表单的示例代码如下:
<form action="uploadUrl" method="post" enctype="multipart/form-data">
<input type="file" name="filename" multiple="multiple" />
<input type="submit" value="文件上传" />
</form>
上述代码中,除了满足上传表单所必须的3个条件外,在<input>元素中还增加了一个multiple属性。该属性是HTML5中的新属性,如果使用了该属性,则可以同时选择多个文件进行上传,即可实现多文件上传。
当客户端form表单的enctype属性为multipart/form-data时,浏览器就会采用二进制流的方式来处理表单数据,服务器端就会对文件上传的请求进行解析处理。Spring MVC为文件上传提供了直接的支持,这种支持是通过MultipartResolver(多部件解析器)对象实现的。MultipartResolver是一个接口对象,需要通过它的实现类CommonsMultipartResolver来完成文件上传工作。在Sring MVC中使用MultipartResolver对象非常简单,只需要在配置文件中定义MultipartResolver接口的Bean即可,其具体配置方式如下:
<bean id="multipartResolver" class=
"org.springframework.web.multipart.commons.CommonsMultipartResolver">
<!-- 设置请求编码格式,必须与JSP中的pageEncoding属性一致,默认为ISO-8859-1 -->
<property name="defaultEncoding" value="UTF-8" />
<!-- 设置允许上传文件的最大值(2M),单位为字节 -->
<property name="maxUploadSize" value="2097152" />
...
</bean>
在上述配置代码中,除配置了CommonsMultipartResolver类外,还通过<property>元素配置了编码格式以及允许上传文件的大小。
通过<property>元素可以对文件解析器类CommonsMultipartResolver的如下属性进行配置:
● maxUploadSize:上传文件最大长度(以字节为单位);
● maxInMemorySize:缓存中的最大尺寸;
● defaultEncoding:默认编码格式;
● resolveLazily:推迟文件解析,以便在Controller中捕获文件大小异常。
注意:
因为MultipartResolver接口的实现类CommonsMultipartResolver内部是引用multipartResolver字符串获取该实现类对象并完成文件解析的,所以在配置CommonsMultipartResolver时必须指定该Bean的id为multipartResolver。
由于CommonsMultipartResolver是Spring MVC内部通过Apache Commons FileUpload技术实现的,所以Spirng MVC的文件上传还需要依赖Apache Commons FileUpload的组件,即需要导入支持文件上传的相关JAR包,具体如下:
● commons-fileupload-1.3.2.jar
● commons-io-2.5.jar
以上2个JAR包的版本是本书编写时的最新版本,读者可以通过Apache官网地址“http://commons.apache.org/
”下载(进入该网址后,在Apache Commons Proper下方列表的Components列中找到FileUplod和IO,单击链接后,即可在打开页面找到下载链接),也可以直接使用本书源码中的JAR包。
当完成页面表单和文件上传解析器的配置后,在Controller中编写文件上传的方法即可实现文件上传。在Spring MVC中,文件上传的方法编写十分简单,其代码如下所示。
@Controller
public class FileUploadController {
@RequestMapping("/fileUpload ")
public String handleFormUpload(@RequestParam("name") String name,
@RequestParam("filename") MultipartFile file,...) {
if (!file.isEmpty()) {
// 具体的执行方法
...
return "uploadSuccess";
}
return "uploadFailure";
}
}
在上述代码中,包含一个MultipartFile接口类型的参数file,上传到程序中的文件就是被封装在该参数中的。org.springframework.web.multipart.MultipartFile接口中提供了获取上传文件、文件名称等方法,这些方法及其说明如表1所示。
表1 MultipartFile接口中的主要方法
方法 | 说明 |
---|---|
byte[] getBytes() | 以字节数组的形式返回文件的内容 |
String getContentType() | 返回文件的内容类型 |
InputStream getInputStream() | 读取文件内容,返回一个InputStream流 |
String getName() | 获取多部件form表单的参数名称 |
String getOriginalFilename() | 获取上传文件的初始化名 |
long getSize() | 获取上传文件的大小,单位是字节 |
boolean isEmpty() | 判断上传的文件是否为空 |
void transferTo(File file) | 将上传文件保存到目标目录下 |