10.1 文件上传
文件上传是项目开发中最常用的功能。为了实现上传文件,必须将表单的 method 设置为 POST,并将 enctype 设置为 multipart/form-data。这样,浏览器才会把用户选择的文件二进制数据发送给服务器。
设置 enctype 为 multipart/form-data,浏览器即会采用二进制流的方式来处理表单数据,而对于文件上传的处理涉及在服务器端解析原始的 HTTP 响应。2003年,Apache Software Foundation 发布了开源的 Commons FileUpload 组件,其很快成为了 Servlet/JSP 程序员上传文件的最佳选择。Servlet 3.0 规范已经提供了方法来处理文件上传,但这种上传需要在 Servlet 中完成。而 Spring MVC 则提供了更简单的封装。
Spring MVC 为文件上传提供了直接的支持,这种支持是用即插即用的 MultipartResolver 实现的。Spring MVC 使用 Apache Commons FileUpload 技术实现了一个 MultipartResolver 实现类:CommonsMultipartResolver。因此,Spring MVC 的文件上传还需要依赖 Apache Commons FileUpload 的组件。
10.1.1 Spring MVC 的文件上传
- 准备 Apache 的 Commons FileUpload 的 jar 包放到项目的类路径下,其中包括 commons-fileupload.jar 和 commons-io.jar。
- 新建文件上传页面 uploadForm.jsp,负责上传文件的表单编码类型必须为 “multipart/form-data”。
<%@ taglib prefix="form" uri="http://www.springframework.org/tags/form" %>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>文件上传</title>
</head>
<body>
<h2>文件上传</h2>
<form:form action="upload" enctype="multipart/form-data" method="post">
<table>
<tr>
<td>文件描述:</td>
<td><input type="text" name="description"></td>
</tr>
<tr>
<td>请选择文件:</td>
<td><input type="file" name="file"></td>
</tr>
<tr>
<td><input type="submit" value="上传"></td>
</tr>
</table>
</form:form>
</body>
</html>
- 新建 FileUploadController 类对页面跳转和上传文件进行处理。
package controller;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.multipart.MultipartFile;
import javax.servlet.http.HttpServletRequest;
import java.io.File;
@Controller
public class FileUploadController {
private final static Log logger = LogFactory.getLog(FileUploadController.class);
@RequestMapping(value = "/{formName}")
public String autoForm(@PathVariable String formName){
return formName;
}
// 上传文件会自动绑定到 MultipartFile 中
@RequestMapping(value = "/upload" , method = RequestMethod.POST)
public String upload(
HttpServletRequest request,
@RequestParam("description") String description,
@RequestParam("file") MultipartFile file
) throws Exception{
// 如果文件不为空,写入上传路径
if (!file.isEmpty()){
// 上传文件路径
String path = request.getServletContext().getRealPath("/images/");
// 上传文件名
String filename = file.getOriginalFilename();
File filepath = new File(path,filename);
// 判断路径是否存在,如果不存在就创建一个
if (!filepath.getParentFile().exists()){
filepath.getParentFile().mkdirs();
}
//将上传文件保存到一个目标文件当中
file.transferTo(new File(path+File.separator+filename));
return "success";
}else {
return "error";
}
}
}
Spring MVC 会将上传文件绑定到 MultipartFile 对象中。MultipartFile 提供了获取上传文件内容、文件名等方法。通过 transferTo() 方法还可以将文件存储到硬件中,MultipartFile 对象中的常用方法如下:
- byte[] getBytes()。获取文件数据。
- String getContentType()。获取文件 MIME 类型,如 image/jpeg 等。
- InputStream getInputStream()。获取文件流。
- String getName()。获取表单中文件组件的名字。
- String getOriginalFilename()。获取上传文件的原名。
- long getSize()。获取文件的字节大小,单位为 byte。
- boolean isEmpty()。是否有上传的文件。
- void transferTo(FIle dest)。将上传文件保存到一个目标文件中。
- 修改 Spring MVC 配置文件。由于 Spring MVC 上下文中默认没有装配 MultipartResolver,因此默认情况下其不能处理文件上传工作。如果想使用 Spring 的文件上传功能,则需要在上下文中配置 MultipartResolver。
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:context="http://www.springframework.org/schema/context"
xmlns:mvc="http://www.springframework.org/schema/mvc"
xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context https://www.springframework.org/schema/context/spring-context.xsd http://www.springframework.org/schema/mvc https://www.springframework.org/schema/mvc/spring-mvc.xsd">
<context:component-scan base-package="controller"/>
<mvc:annotation-driven/>
<mvc:default-servlet-handler/>
<bean id="viewResolver"
class="org.springframework.web.servlet.view.InternalResourceViewResolver">
<property name="prefix">
<value>/WEB-INF/content/</value>
</property>
<property name="suffix">
<value>.jsp</value>
</property>
</bean>
<bean id="multipartResolver"
class="org.springframework.web.multipart.commons.CommonsMultipartResolver">
<!-- 上传文件大小上限,单位为字节(10MB) -->
<property name="maxUploadSize">
<value>10485760</value>
</property>
<!-- 请求的编码格式,必须和 jsp 的 pageEncoding 属性一致,以便正确读取表单内容,默认为 ISO-8859-1 -->
<property name="defaultEncoding">
<value>UTF-8</value>
</property>
</bean>
</beans>
- 部署 FileUploadTest 应用,在浏览器中输入如下 URL 来测试:
http://localhost:8080/FileUploadTest/uploadForm
结果如下:
目录中文件存在,上传成功。
注: 在程序运行时,如果未上传 commons-io.jar,则浏览器会报 Handler dispatch failed; nested exception is java.lang.NoClassDefFoundError: org/apache/commons/io/IOUtils
错误。如果出现此错误,将 commons-io.jar 导入项目即可修复。
10.1.2 使用对象接收上传文件
在实际的项目开发中,很多时候上传的文件会作为对象的属性被保存。Spring MVC 的处理也非常简单。
- 新建 registerForm.jsp 用于用户上传文件。
<%@ taglib prefix="form" uri="http://www.springframework.org/tags/form" %>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>用户注册</title>
</head>
<body>
<h2>用户注册</h2>
<form:form action="register" method="post" enctype="multipart/form-data">
<table>
<tr>
<td>用户名:</td>
<td><input type="text" name="username"></td>
</tr>
<tr>
<td>请上传头像:</td>
<td><input type="file" name="image"></td>
</tr>
<tr>
<td><input type="submit" value="注册"></td>
</tr>
</table>
</form:form>
</body>
</html>
- 新建 User 类用于接收页面信息。
package domain;
import org.springframework.web.multipart.MultipartFile;
import java.io.Serializable;
public class User implements Serializable {
private String username;
// 对应上传的 file,类型为 MultipartFile ,上传文件会自动绑定到 image 属性当中。
private MultipartFile image;
public String getUsername() {
return username;
}
public void setUsername(String username) {
this.username = username;
}
public MultipartFile getImage() {
return image;
}
public void setImage(MultipartFile image) {
this.image = image;
}
}
- 新建 FIleUploadController 类,负责处理页面跳转和文件上传。
package controller;
import domain.User;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.*;
import javax.servlet.http.HttpServletRequest;
import java.io.File;
@Controller
public class FileUploadController {
private final static Log logger = LogFactory.getLog(FileUploadController.class);
@RequestMapping(value = "/{formName}")
public String autoForm(@PathVariable String formName){
return formName;
}
@RequestMapping(value = "/register")
public String register(
HttpServletRequest request,
Model model,
@ModelAttribute User user){
System.out.println(user.getUsername());
// 如果文件不为空的话,写入上传路径
if (!user.getImage().isEmpty()){
// 上传文件路径
String path = request.getServletContext().getRealPath("/images/");
System.out.println(path);
// 上传文件名
String filename = user.getImage().getOriginalFilename();
System.out.println(filename);
File filepath = new File(path,filename);
// 判断路径是否存在,如果不存在就创建一个
if (!filepath.getParentFile().exists()){
filepath.getParentFile().mkdirs();
}
//将上传文件保存到一个目标文件当中
try {
user.getImage().transferTo(new File(path+File.separator+filename));
}catch (Exception e){
e.printStackTrace();
}
// 将用户添加到 model
model.addAttribute("user",user);
//跳转到下载页面
return "userInfo";
}else {
return "error";
}
}
}
- 新建用户下载页面 userInfo.jsp 。
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>文件下载</title>
</head>
<body>
<h3>文件下载</h3>
<a href="download?filename=${requestScope.user.image.originalFilename}">
${requestScope.user.image.originalFilename }
</a>
</body>
</html>
- 部署应用,并在浏览器输入如下 URL 测试:
http://localhost:8080/FileUploadTest/registerForm
结果如下:
10.2 文件下载
Spring MVC 的文件下载
Spring MVC 的文件下载比较简单,直接在页面给出一个超链接,该链接 href 的属性等于要下载文件的文件名,就可以实现文件下载了。
Spring MVC 提供了一个 ResponseEntity 类型,使用它可以很方便的定义返回的 HttpHeaders 和 HttpStatus。
- 在 FileUploadController 类中添加下载处理。
@RequestMapping(value = "/download")
public ResponseEntity<byte[]> download(
HttpServletRequest request,
@RequestParam("filename") String filename,
Model model) throws Exception {
// 下载文件路径
String path = request.getServletContext().getRealPath("/images/");
File file = new File(path+File.separator+filename);
HttpHeaders headers = new HttpHeaders();
// 下载显示的文件名,解决中文名称乱码问题
String downloadFileName = new String(filename.getBytes("UTF-8"),"iso-8859-1");
// 通知浏览器以 attachment(下载方式)打开图片
headers.setContentDispositionFormData("attachment",downloadFileName);
// application/octet-stream:二进制流数据(最常见的文件下载)。
headers.setContentType(MediaType.APPLICATION_OCTET_STREAM);
// 201 HttpStatus.CREATED
return new ResponseEntity<byte[]>(FileUtils.readFileToByteArray(file),headers, HttpStatus.CREATED);
}
download 处理方法接收到页面传递的文件名 filename 后,使用 Apache Commons FileUpload 组件的 FileUtils 读取项目的 iamges 文件夹下的该文件,并将其构建成 ResponseEntity 对象返回客户端下载。
使用 ResponseEntity 对象,可以很方便地定义返回的 HttpHeaders 和 HttpStatus。上面代码中的 MadiaType,代表的是 Internet Media Type,即互联网媒体类型,也叫做 MIME 类型。在 Http 协议消息头中,使用 Content-Type 来表示具体请求中的媒体类型信息。HttpStatus 类型代表的是 Http 协议中的状态。有关 MediaType 和 HttpStatus 类的详细信息参考 Spring MVC 的 API 文档。
点击下载页面的超链接,显示文件下载: