Spring MVC的文件下载

这篇文章介绍的方法在某些时候会有一些问题，小瑕疵，请大家看更好的方法

读取文件

要下载文件，首先是将文件内容读取进来，使用字节数组存储起来，这里使用spring里面的工具类实现

1import org.springframework.util.FileCopyUtils;
2
3    public byte[] downloadFile(String fileName) {
4        byte[] res = new byte[0];
5        try {
6            File file = new File(BACKUP_FILE_PATH, fileName);
7            if (file.exists() && !file.isDirectory()) {
8                res = FileCopyUtils.copyToByteArray(file);
9            }
10        } catch (IOException e) {
11            logger.error(e.getMessage());
12        }
13        return res;
14    }

这个数组就是文件的内容，后面将输出到响应，供浏览器下载

下载文件的响应

下载文件的响应头和一般的响应头是有所区别的，而这里面还要根据用户浏览器的不同区别对待

我把生成响应的代码封装成了一个方法，这样所有下载响应都可以调用这个方法了，避免重复代码到处写

1    protected ResponseEntity<byte[]> downloadResponse(byte[] body, String fileName) {
2        HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder
3                .getRequestAttributes()).getRequest();
4        String header = request.getHeader("User-Agent").toUpperCase();
5        HttpStatus status = HttpStatus.CREATED;
6        try {
7            if (header.contains("MSIE") || header.contains("TRIDENT") || header.contains("EDGE")) {
8                fileName = URLEncoder.encode(fileName, "UTF-8");
9                fileName = fileName.replace("+", "%20");    // IE下载文件名空格变+号问题
10                status = HttpStatus.OK;
11            } else {
12                fileName = new String(fileName.getBytes("UTF-8"), "ISO8859-1");
13            }
14        } catch (UnsupportedEncodingException e) {}
15
16        HttpHeaders headers = new HttpHeaders();
17        headers.setContentType(MediaType.APPLICATION_OCTET_STREAM);
18        headers.setContentDispositionFormData("attachment", fileName);
19        headers.setContentLength(body.length);
20
21        return new ResponseEntity<byte[]>(body, headers, status);
22    }

这里需要注意，一般来说下载文件是使用201状态码的，但是IE浏览器不支持，还得我花了很大力气才找出来是那个问题

其中对文件名的处理是为了防止中文以及空格导致文件名乱码

控制器方法

在控制器的那里需要对返回值进行处理

1    @RequestMapping(value = "/download-backup", method = RequestMethod.GET)
2    @ResponseBody
3    public ResponseEntity<byte[]> downloadBackupFile(@RequestParam String fileName) {
4        byte[] body = backupService.downloadFile(fileName);
5        return downloadResponse(body, fileName);
6    }