Spring MVC文件上传和下载

文章目录

文件上传

文件上传概述
文件上传示例

文件下载

实现文件下载
中文名称的文件下载

文件上传

文件上传概述

多数文件上传都是通过表单形式提交给后台服务器的，因此，要实现文件上传的功能，就需要提供一个文件上传表单，而表单必须满足以下3个条件。

form表单的method属性设置为post
form表单的enctype属性设置为multipart/form-data
提供<input type="file" name="filename" />的文件上传输入框

文件上传表单的示例代码如下：

<form action="fileUpload"
    method="post" enctype="multipart/form-data">
		<input type="file" name="filename" multiple="multiple" />
		<input type="submit" value="文件上传" />
</form>

在上述代码中有一个multiple属性，使用该属性可实现多文件上传。

因为客户端浏览器采用二进制流的方式处理表单数据，所以服务器端要对文件上传的请求进行解析处理。因此Spring MVC为文件上传提供了一个MultipartResolver(多部件解析器)接口对象，用法配置方式代码如下：

<!-- 配置文件上传解析器 MultipartResolver -->
<bean id="multipartResolver" class=
  "org.springframework.web.multipart.commons.CommonsMultipartResolver">
         <!-- 设置请求编码格式-->
         <property name="defaultEncoding" value="UTF-8" />
         <!-- 设置允许上传文件的最大长度 -->
         <property name="maxUploadSize" value="2097152" />
         <!-- maxInMemorySize：设置缓存中的最大尺寸 -->
         <!-- resolveLazily：推迟文件解析 -->
</bean>

Spring MVC的文件上传还要依赖相关JAR包
在这里插入图片描述

文件上传示例

创建并编写springmvc-config.xml文件

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
  xmlns:mvc="http://www.springframework.org/schema/mvc"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:context="http://www.springframework.org/schema/context"
  xsi:schemaLocation="http://www.springframework.org/schema/beans
  http://www.springframework.org/schema/beans/spring-beans-4.3.xsd
  http://www.springframework.org/schema/mvc
  http://www.springframework.org/schema/mvc/spring-mvc-4.3.xsd
  http://www.springframework.org/schema/context 
  http://www.springframework.org/schema/context/spring-context-4.3.xsd">
	<!-- 定义组件扫描器，指定需要扫描的包 -->
	<context:component-scan base-package="包名" />
	<!--配置注解驱动  -->
	<mvc:annotation-driven />
	<!-- 定义视图解析器 -->
	<bean id="viewResolver" class=
    "org.springframework.web.servlet.view.InternalResourceViewResolver">
	     <!-- 设置前缀 -->
	     <property name="prefix" value="/WEB-INF/jsp/" />
	     <!-- 设置后缀 -->
	     <property name="suffix" value=".jsp" />
	</bean>
	<!-- 配置文件上传解析器 MultipartResolver -->
	<bean id="multipartResolver" class=
   "org.springframework.web.multipart.commons.CommonsMultipartResolver">
          <!-- 设置请求编码格式-->
          <property name="defaultEncoding" value="UTF-8" />
	</bean>
</beans>

创建上传文件的jsp页面

<%@ 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 />
		请选择文件：
		<!-- multiple属性可以实现多文件上传 -->
		<input id="file" type="file" name="uploadfile" multiple="multiple" /><br />
		<input type="submit" value="上传" />
	</form>
</body>
</html>

创建Controller类

import java.io.File;
import java.net.URLEncoder;
import java.util.List;
import java.util.UUID;
import javax.servlet.http.HttpServletRequest;

import org.apache.commons.io.FileUtils;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.multipart.MultipartFile;
/**
 * 文件上传
 */
@Controller
public class FileUploadController {
	/**
	 * 执行文件上传
	 */
	@RequestMapping("/fileUpload")
	// List<MultipartFile>集合类型用于接收用户上传得文件
	public String handleFormUpload(@RequestParam("name") String name,
			@RequestParam("uploadfile") List<MultipartFile> uploadfile,
			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";
		}
	}
}

文件下载

实现文件下载

文件下载就是将文件服务器中的文件下载到本机上。在Spring MVC环境中，实现文件下载大致可分为如下两个步骤。
1：在客户端页面使用一个文件下载的超链接，该链接要指定后台文件下载的方法以及文件名，具体代码示例如下：

<a href="${pageContext.request.contextPath }/download?filename=1.jpg">
	文件下载 
</a>

2：在后台Controller类中，使用Spring MVC提供的文件下载方法进行文件下载。Spring MVC提供了一个ResponseEntity类型的对象，使用它可以很方便地定义返回地HttpHeaders对象和HttpStatus对象，通过对这两个对象的设置，即可完成下载文件所需地配置信息。文件下载示例代码如下：

@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);
    // 使用Sring MVC框架的ResponseEntity对象封装返回下载数据
   return new ResponseEntity<byte[]>(FileUtils.readFileToByteArray(file),
   	                                                       headers,HttpStatus.OK);
}

中文名称的文件下载

当对中文名称的文件进行下载时，因为各个浏览器内部转码机制的不同，就会出现不同地乱码以及解析异常问题。为了解决浏览器中文件下载时中文名称的乱码，可以在前端页面发送请求前先对中文进行统一编码，然后在后台控制器类中对文件名称进行相应的转码。具体步骤如下：
1：在下载页面中对中文文件名编码，在download.jsp中采用

<%@ page language="java" contentType="text/html; charset=UTF-8"
     pageEncoding="UTF-8"%>
<%@page import="java.net.URLEncoder"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" 
     "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>下载页面</title>
</head>
<body>
	<%-- <a href="${pageContext.request.contextPath }/download?filename=1.jpg">
    	文件下载 
	</a> --%>
	
	<a href="${pageContext.request.contextPath }/download?filename=<%=
                                   URLEncoder.encode("壁纸.jpg", "UTF-8")%>">
		中文名称文件下载 
	</a>
</body>
</html>

2：修改控制器类FileUploadController中的fileDownload()方法，并增加对文件进行编码的方法，其代码如下所示：

@RequestMapping("/download")
	public ResponseEntity<byte[]> fileDownload(HttpServletRequest request,
	                                           String filename) throws Exception{
	    // 指定要下载的文件所在路径
	    String path = request.getServletContext().getRealPath("/upload/");
	    // 创建该文件对象(file.separator这个代表系统目录中的间隔符)
	    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);
	    // 使用Spring MVC框架的ResponseEntity对象封装返回下载数据
	   return new ResponseEntity<byte[]>(FileUtils.readFileToByteArray(file),
	                                           headers,HttpStatus.OK);
	}
	/**
	 * 根据浏览器的不同进行编码设置，返回编码后的文件名
	 */
	public String getFilename(HttpServletRequest request,
	                                            String filename) throws Exception { 
	    // IE不同版本User-Agent中出现的关键词
	    String[] IEBrowserKeyWords = {"MSIE", "Trident", "Edge"};  
	    // 获取请求头代理信息
	    String userAgent = request.getHeader("User-Agent");  
	    for (String keyWord : IEBrowserKeyWords) { 
	         if (userAgent.contains(keyWord)) { 
	              //IE内核浏览器，统一为UTF-8编码显示
	              return URLEncoder.encode(filename, "UTF-8");
	         }
	    }  
	    //火狐等其它浏览器统一为ISO-8859-1编码显示
	    return new String(filename.getBytes("UTF-8"), "ISO-8859-1");  
	}