SSM系列文章
- 学会Spring的正确姿势！
- 万万没想到！Bean还有这么多东西
- Spring中的AOP！
- 聊聊Spring数据库开发
- Spring事务还能这样管理？
- 老师问我 Spring MVC 的工作流程
- 分享 | 后端必会的Spring MVC核心类和注解
- 还有人不知道？Spring MVC的数据绑定来了
- 开发必掌握！JSON数据交互和RESTful开发
- 拦截器的骚操作
SpringBoot和SpringCloud可以看这里
- 初次见面，请多多指教。。
- 时隔一个月，让大家久等了
- Spring Boot整合JustAuth，实现第三方登录
- SpringBoot-Vue 前后端分离开发
- 微服务架构之Spring Cloud入门
- 微服务架构之Spring Cloud入门2
- 1. 文件上传
- 2. 文件下载
- 总结
“GitHub：https://github.com/nateshao/ssm/tree/master/111-springmvc-file-upload
1. 文件上传
文件上传概述
“多数文件上传都是通过表单形式提交给后台服务器的，因此，要实现文件上传功能，就需要提供一个文件上传的表单，而该表单必须满足以下3个条件：
- form表单的method属性设置为post；
- form表单的enctype属性设置为multipart/form-data；
- 提供< input type="file" name="filename" />的文件上传输入框。
文件上传表单示例如下
代码语言：javascript复制 <form action="uploadUrl" method="post" enctype="multipart/form-data">
<input type="file" name="filename" multiple="multiple" />
<input type="submit" value="文件上传" />
</form>
multiple属性是HTML5中新属性，可实现多文件上传
“当
form表单的enctype属性为multipart/form-data时，浏览器就会采用二进制流来处理表单数据，服务器端就会对文件上传的请求进行解析处理。Spring MVC通过MultipartResolver实现文件上传功能。MultipartResolver是一个接口对象，需要通过它的实现CommonsMultipartResolver来完成文件上传工作。
MultipartResolver配置示例如下:
代码语言：javascript复制<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
- lcommons-io-2.5.jar
当完成页面表单和文件上传解析器的配置后，在Controller中编写文件上传的方法即可实现文件上传，其代码如下所示：
代码语言：javascript复制 /**
* 执行文件上传
* @param name
* @param uploadfile
* @param request
* @return
*/
@RequestMapping("/fileUpload")
public String handleFormUpload(@RequestParam("name") String name,
@RequestParam("uploadfile") List<MultipartFile> uploadfile,//使用MultipartFile 绑定接收上传文件
HttpServletRequest request) {
// 判断所上传文件是否存在
if (!uploadfile.isEmpty() && uploadfile.size() > 0) {
//循环输出上传的文件
for (MultipartFile file : uploadfile) {
// 获取上传文件的原始名称
String originalFilename = file.getOriginalFilename();
// 设置上传文件的保存地址目录
String dirPath =
request.getServletContext().getRealPath("/upload/");
File filePath = new File(dirPath);
// 如果保存文件的地址不存在，就先创建目录
if (!filePath.exists()) {
filePath.mkdirs();
}
// 使用UUID重新命名上传的文件名称(上传人_uuid_原始文件名称)
String newFilename = name "_" UUID.randomUUID()
"_" originalFilename;
try {
// 使用MultipartFile接口的方法完成文件上传到指定位置
file.transferTo(new File(dirPath newFilename));
} catch (Exception e) {
e.printStackTrace();
return "error";
}
}
// 跳转到成功页面
return "success";
} else {
return "error";
}
}
在上述代码中，包含一个MultipartFile接口类型的参数file，上传到程序中的文件是被封装在该参数中的。
org.springframework.web.multipart.MultipartFile接口中提供了获取上传文件、文件名称等方法，如下表所示：
代码实现：
fileUpload.jsp
代码语言：javascript复制<%@ page language="java" contentType="text/html; charset=UTF-8"
pageEncoding="UTF-8" %>
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>文件上传</title>
<script>
// 判断是否填写上传人并已选择上传文件
function check() {
var name = document.getElementById("name").value;
var file = document.getElementById("file").value;
if (name == "") {
alert("填写上传人");
return false;
}
if (file.length == 0 || file == "") {
alert("请选择上传文件");
return false;
}
return true;
}
</script>
</head>
<body>
<form action="${pageContext.request.contextPath }/fileUpload"
method="post" enctype="multipart/form-data" onsubmit="return check()">
上传人：<input id="name" type="text" name="name"/><br/>
请选择文件：<input id="file" type="file" name="uploadfile"
multiple="multiple"/><br/>
<input type="submit" value="上传"/>
</form>
</body>
</html>
2. 文件下载
“文件下载就是将文件服务器中的文件下载到本机上。在Spring MVC环境中，实现文件下载大致可分为如下两个步骤：
在客户端页面使用一个文件下载的超链接，该链接的href属性要指定后台文件下载的方法以及文件名（需要先在文件下载目录中添加了一个名称为“1.jpg”的文件）。
代码语言：javascript复制 <a href="${pageContext.request.contextPath }/download?filename=1.jpg">
文件下载
</a>
在后台使用Spring MVC提供的ResponseEntity类型对象完成文件下载，使用它可以很方便的定义返回的HttpHeaders对象和HttpStatus对象，通过对这两个对象的设置，即可完成下载文件时所需的配置信息。
代码语言：javascript复制@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);
// 对文件名编码，防止中文文件乱码
filename = this.getFilename(request, filename);
// 设置响应头
HttpHeaders headers = new HttpHeaders();
// 通知浏览器以下载的方式打开文件
headers.setContentDispositionFormData("attachment", filename);
// 定义以流的形式下载返回文件数据
headers.setContentType(MediaType.APPLICATION_OCTET_STREAM);
// 使用Sring MVC框架的ResponseEntity对象封装返回下载数据
return new ResponseEntity<byte[]>(FileUtils.readFileToByteArray(file),
headers, HttpStatus.OK);
}
文件下载中的ResponseEntity对象有些类似前面章节中的@ResponseBody注解，它用于直接返回结果对象。
响应头信息中的MediaType代表的是Interner Media Type（即互联网媒体类型），也叫做MIME类型，MediaType.APPLICATION_OCTET_STREAM的值为application/octet-stream，即表示以二进制流的形式下载数据；
HttpStatus类型代表的是Http协议中的状态，示例中的HttpStatus.OK表示200，即服务器已成功处理了请求。
当对中文名文件下载时会怎样？
当对中文名称的文件进行下载时，因为各个浏览器内部转码机制的不同，就会出现不同的乱码以及解析异常问题。
如何解决中文名文件下载乱码问题呢？
为了解决浏览器中文件下载时中文名称的乱码问题，可以在前端页面发送请求前先对中文名进行统一编码，然后在后台控制器类中对文件名称进行相应的转码。
在下载页面中对中文文件名编码。可以使用Servlet API中URLEncoder.encoder(String s, String enc)方法将中文转为UTF-8编码。
代码语言：javascript复制<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%>
<%@page import="java.net.URLEncoder"%>
...
<body>
<a href="${pageContext.request.contextPath }/download?filename=<%=URLEncoder.encode(“
壁纸.jpg", "UTF-8")%>">
中文名称文件下载 </a>
</body>
</html>
在控制器类中编写对中文名文件下载时进行转码编码的方法。
代码语言：javascript复制public String getFilename(HttpServletRequest request,String filename) throws Exception {
String[] IEBrowserKeyWords = {"MSIE", "Trident", "Edge"};
String userAgent = request.getHeader("User-Agent");
for (String keyWord : IEBrowserKeyWords) {
if (userAgent.contains(keyWord)) {
return URLEncoder.encode(filename, "UTF-8");
}
}
return new String(filename.getBytes("UTF-8"), "ISO-8859-1");
}
总结
本章主要对Spring MVC环境下的文件上传和下载进行了详细讲解。
- 首先讲解了如何实现文件上传，并通过一个应用案例来演示文件上传功能的实现；
- 然后讲解了非中文名称文件下载的实现过程，以及中文名称文件下载的实现过程。
通过本章的学习，我们要学会如何在Spring MVC环境下进行文件上传和下载，并能够掌握中文名称文件下载时乱码的解决方案。
革命尚未成功，同志仍需努力，冲冲冲
