1、思考
以前使用J2EE时,都是直接使用Response进行流传输下载,现在使用了Spring MVC ,那么最好是尽量不要把Spring 的 API 和 J2EE API 混合使用,代码显得不友好,尤其是反感,JSP里面有Java代码还有JavaScript代码。
2、封装的代码
package com.hnust.common.controller;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.web.bind.annotation.RestController;import java.io.File;import java.io.IOException;import java.io.UnsupportedEncodingException;import java.net.URLEncoder;/** * Created by Heweipo on 2016/5/27. ** 下载通用控制器,业务类控制器只要继承该类,调用 export 方法进行下载。 */@RestControllerpublic class DownloadController extends BaseController { /** * 下载文件通用方法 * * @param file 文件对象 * @return 文件字节流 */ public ResponseEntity
export(File file) { return export(file.getName(), file); } /** * 下载文件通用方法 * * @param fileName 文件名称 * @param file 文件对象 * @return 文件字节流 */ public ResponseEntity export(String fileName, File file) { HttpHeaders headers = new HttpHeaders(); headers.setContentType(MediaType.APPLICATION_OCTET_STREAM); headers.setContentDispositionFormData("attachment", encodeFileName(fileName)); ResponseEntity rs = null; try { // 这里不能使用 HttpStatus.CREATED 201 是因为 IE Edge 无法识别,但是Firefox chrome 没问题 rs = new ResponseEntity<>(FileUtils.readFileToByteArray(file), headers, HttpStatus.OK); } catch (IOException e) { // throw new CommonException(ResponseStatusEnum.FILE_ERROR, e); } return rs; } /** * 下载文件的名称,这个是在浏览器那里显示的名称 * * @param fileName 文件名称 * @return 加码的文件名称 * * IE * Mozilla/5.0 (Windows NT 10.0; WOW64; Trident/7.0; rv:11.0) like Gecko *
* Edge * Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/46.0.2486.0 Safari/537.36 Edge/13.10586 *
* Firefox * Mozilla/5.0 (Windows NT 10.0; WOW64; rv:46.0) Gecko/20100101 Firefox/46.0 *
* Chrome * Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/47.0.2526.106 Safari/537.36 */ private String encodeFileName(String fileName) { String name = fileName; try { String agent = request.getHeader("USER-AGENT").toLowerCase(); if (null != agent && (agent.contains("msie") || agent.contains("edge"))) { // IE edge name = URLEncoder.encode(fileName, "UTF-8"); } else if (agent.contains("safari") || agent.contains("chrome") || agent.contains("firefox")) { // safari chrome firefox name = new String(fileName.getBytes("UTF-8"), "iso-8859-1"); } else { // IE10 IE11 name = URLEncoder.encode(fileName, "UTF-8"); } // 把加号还原为空格(IE Edge 有问题) name = name.replace("+", "%20"); } catch (UnsupportedEncodingException e) { // throw new CommonException(ResponseStatusEnum.FAILURE, e); } return name; }}
3、调用组件
@Controllerpublic class HelloController extends DownloadController { /** * * 下载组件调用 */ @RequestMapping(value = "/download", method = RequestMethod.GET) public ResponseEntitydownload() { File file = new File("c://1.txt"); return export(file); }
4、注意
1)rs = new ResponseEntity<>(FileUtils.readFileToByteArray(file),headers, HttpStatus.OK);
网上很多人使用这样的代码进行下载:
rs = new ResponseEntity<>(FileUtils.readFileToByteArray(file),headers, HttpStatus.CREATED);
这样在Chrome Firefox 浏览器中下载没有问题,但是在IE、Edge就无法下载,原因可能是IE、Edge无法识别 201 响应结果。
2)下载文件名称乱码,或者有+号
这个问题确实很常见了,在IE、Firefox下就必须这样设置,通过如下浏览器头信息解析加码方式。 另外,把加号还原为空格(IE Edge 有问题) ,这个jQuery也是一样把空格进行encode之后变为加号了。还原一下
name = name.replace("+", "%20");