文件上传
文件上传表单的满足条件
大多数文件上传都是通过表单形式提交给后台服务器,因此,要实现文件上传功能,就需要提供一个文件上传的表单,并且该表单必须满足以下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个条件之外,还在文件上传输入框中增加了一个HTML5中的新属性multiple。如果文件上传输入框中使用了multiple属性,则在上传文件时,可以同时选择多个文件进行上传,即可实现多文件上传。
MultipartResolver接口
当客户端提交的form表单中enctype属性为multipart/form-data时,浏览器会采用二进制流的方式来处理表单数据,服务器端会对请求中上传的文件进行解析处理。
Spring MVC为文件上传提供了直接的支持,这种支持是通过MultipartResolver(多部件解析器)对象实现的。MultipartResolver是一个接口,可以使用MultipartResolver的实现类CommonsMultipartResolver来完成文件上传工作。
在SringMVC中使用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>
<property>元素可以配置文件解析器类CommonsMultipartResolver的如下属性。
• maxUploadSize:上传文件最大值(以字节为单位)。
• maxInMemorySize:缓存中的最大值(以字节为单位)。
• defaultEncoding:默认编码格式。
• resolveLazily:推迟文件解析,以便在Controller中捕获文件大小异常。
CommonsMultipartResolver如何实现上传功能
CommonsMultipartResolver并未自主实现文件上传下载对应的功能,而是在内部调用了Apache Commons FileUpload的组件,所以使用SpirngMVC的文件上传功能,需要在项目中导入Apache Commons FileUpload组件的依赖,即commons-fileupload依赖和commons-io依赖。由于commons-fileupload依赖会自动依赖commons-io,所以可以只在项目的pom.xml文件中引入如下依赖。
<dependency>
<groupId>commons-fileupload</groupId>
<artifactId>commons-fileupload</artifactId>
<version>1.4</version>
</dependency>
当完成文件上传表单和文件上传解析器的配置后,就可以在Controller中编写上传文件的方法。在Spring MVC中,上传文件的方法编写十分简单,其代码如下所示。
@Controller
public class FileUploadController {
@RequestMapping("/fileUpload ")
public String fileUpload(MultipartFile file) {
if (!file.isEmpty()) {// 保存上传的文件,filepath为保存的目标目录
file.transferTo(new File(filePath))return "uploadSuccess";
}
return "uploadFailure";
}
}
MultipartFile接口的常用方法
方法声明 | 功能描述 |
---|---|
byte[]getBytes() | 将文件转换为字节数组形式 |
StringgetContentType() | 获取文件的内容类型 |
InputStream getInputStream() | 读取文件内容,返回一个InputStream流 |
StringgetName() | 获取多部件form表单的参数名称 |
StringgetOriginalFilename() | 获取上传文件的初始化名 |
longgetSize() | 获取上传文件的大小,单位是字节 |
boolean isEmpty() | 判断上传的文件是否为空 |
voidtransferTo(File file) | 将上传文件保存到目标目录下 |
文件下载
使用ResponseEntity对象进行文件下载
@RequestMapping("/download")
public ResponseEntity<byte[]> fileDownload(HttpServletRequest request,String filename) throws Exception{
String path = request.getServletContext().getRealPath("/upload/");// 下载文件所在路径
File file = new File(path+File.separator+filename); // 创建文件对象
HttpHeaders headers = new HttpHeaders(); // 设置消息头
headers.setContentDispositionFormData(“attachment”, filename);// 打开文件
headers.setContentType(MediaType.APPLICATION_OCTET_STREAM); // 下载返回的文件数据
return new ResponseEntity<byte[]>(FileUtils.readFileToByteArray(file),
headers,HttpStatus.OK); // 使用ResponseEntity对象封装返回下载数据
}
上面示例中,设置响应头信息中的MediaType代表的是InternerMedia Type(即互联网媒体类型),也叫做MIME类型,MediaType.APPLICATION_OCTET_STREAM的值为application/octet-stream,即表示以二进制流的形式下载数据。HttpStatus类型代表的是Http协议中的状态,示例中的HttpStatus.OK表示200,即服务器已成功处理了请求。