SpringMVC文件上传与下载

朱雀 2022-05-14 08:34 236阅读 0赞

**1.文件上传**

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

form表单的method属性设置为post；

form表单的enctype属性设置为multipart/form-data；

提供<input type="file" name="filename" />的文件上传输入框;

multiple属性是HTML5中新属性,可实现多文件上传

**当form表单的enctype属性为multipart/form-data时,浏览器就会采用二进制流来处理表单数据,服务器端就会对文件上传的请求进行解析处理。Spring MVC通过MultipartResolver实现文件上传功能。MultipartResolver是一个接口对象,需要通过它的实现类CommonsMultipartResolver来完成文件上传工作。**

设置请求编码格式,必须与JSP中的pageEncoding属性一致,默认为ISO-8859-1

设置允许上传文件的最大值（2M）,单位为字节

maxUploadSize：上传文件最大长度（以字节为单位）；

maxInMemorySize：缓存中的最大尺寸；

defaultEncoding：默认编码格式；

resolveLazily：推迟文件解析,以便在Controller中捕获文件大小异常。

**注意：因为MultipartResolver接口的实现类CommonsMultipartResolver内部**

**是引用multipartResolver字符串获取该实现类对象并完成文件解析的,所以在**

**配置CommonsMultipartResolver时必须指定该Bean的id为multipartResolver。**

**要导入的jar包**

**\*  commons-fileupload-1.3.2.jar**  
\*  **commons-io-2.5.jar**

@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接口中提供了获取上传  
文件、文件名称等方法,如下表所示：**

![70][]

**2.文件下载**

文件下载就是将文件服务器中的文件下载到本机上。在Spring MVC环境中,实现文件下载大致可分为如下两个步骤：

**（1）在客户端页面使用一个文件下载的超链接,该链接的href属性要指定后台文件下载的方法以及文件名**

**（2）在后台使用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);
                return new ResponseEntity<byte[]>    
                (FileUtils.readFileToByteArray(file),headers,HttpStatus.OK);
                                        
    }

![70 1][]

**文件下载中的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编码。**

<%@ 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>

**需要在jsp文件中导入java.net.URLEncoder包**

**使用Encoder类的encoder()方法对中文名进行编码**

在控制器类中 写对中文名文件下载时进行转码编码的方法

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");
    }

**处理器最终代码**

package com.itcx.controller;
    
    import java.io.File;
    import java.net.URLEncoder;
    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;
    
    @Controller
    public class FileDownloadController {
    
    	@RequestMapping("/download.do")
    	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);
    	}
    	/**
    	 * 根据浏览器的不同进行编码设置，返回编码后的文件名
    	 */
    	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");  
    	}  
    }

[70]: /images/20220514/9acd525ad039499c832c8f32d58de7c6.png
[70 1]: /images/20220514/f3a9237d184f498c800ceba72df5fa5d.png