当前位置:   article > 正文

在springBoot下实现文件下载_springboot项目下载文件并返回数据

springboot项目下载文件并返回数据

1. 将文件以流的形式一次性读取到内存,通过响应输出流输出到前端

  1. /**
  2. * @param path 想要下载的文件的路径
  3. * @param response
  4. * @功能描述 下载文件:
  5. */
  6. @RequestMapping("/download")
  7. public void download(String path, HttpServletResponse response) {
  8. try {
  9. // path是指想要下载的文件的路径
  10. File file = new File(path);
  11. log.info(file.getPath());
  12. // 获取文件名
  13. String filename = file.getName();
  14. // 获取文件后缀名
  15. String ext = filename.substring(filename.lastIndexOf(".") + 1).toLowerCase();
  16. log.info("文件后缀名:" + ext);
  17. // 将文件写入输入流
  18. FileInputStream fileInputStream = new FileInputStream(file);
  19. InputStream fis = new BufferedInputStream(fileInputStream);
  20. byte[] buffer = new byte[fis.available()];
  21. fis.read(buffer);
  22. fis.close();
  23. // 清空response
  24. response.reset();
  25. // 设置response的Header
  26. response.setCharacterEncoding("UTF-8");
  27. //Content-Disposition的作用:告知浏览器以何种方式显示响应返回的文件,用浏览器打开还是以附件的形式下载到本地保存
  28. //attachment表示以附件方式下载 inline表示在线打开 "Content-Disposition: inline; filename=文件名.mp3"
  29. // filename表示文件的默认名称,因为网络传输只支持URL编码的相关支付,因此需要将文件名URL编码后进行传输,前端收到后需要反编码才能获取到真正的名称
  30. response.addHeader("Content-Disposition", "attachment;filename=" + URLEncoder.encode(filename, "UTF-8"));
  31. // 告知浏览器文件的大小
  32. response.addHeader("Content-Length", "" + file.length());
  33. OutputStream outputStream = new BufferedOutputStream(response.getOutputStream());
  34. response.setContentType("application/octet-stream");
  35. outputStream.write(buffer);
  36. outputStream.flush();
  37. } catch (IOException ex) {
  38. ex.printStackTrace();
  39. }
  40. }

2. 将输入流中的数据循环写入到响应输出流中,而不是一次性读取到内存,通过响应输出流输出到前端

  1. /**
  2. * @param path 指想要下载的文件的路径
  3. * @param response
  4. * @功能描述 下载文件:将输入流中的数据循环写入到响应输出流中,而不是一次性读取到内存
  5. */
  6. @RequestMapping("/downloadLocal")
  7. public void downloadLocal(String path, HttpServletResponse response) throws IOException {
  8. // 读到流中
  9. InputStream inputStream = new FileInputStream(path);// 文件的存放路径
  10. response.reset();
  11. response.setContentType("application/octet-stream");
  12. String filename = new File(path).getName();
  13. response.addHeader("Content-Disposition", "attachment; filename=" + URLEncoder.encode(filename, "UTF-8"));
  14. ServletOutputStream outputStream = response.getOutputStream();
  15. byte[] b = new byte[1024];
  16. int len;
  17. //从输入流中读取一定数量的字节,并将其存储在缓冲区字节数组中,读到末尾返回-1
  18. while ((len = inputStream.read(b)) > 0) {
  19. outputStream.write(b, 0, len);
  20. }
  21. inputStream.close();
  22. }

3. 下载网络文件到本地

  1. /**
  2. * @param path 下载后的文件路径和名称
  3. * @param netAddress 文件所在网络地址
  4. * @功能描述 网络文件下载到服务器本地
  5. */
  6. @RequestMapping("/netDownloadLocal")
  7. public void downloadNet(String netAddress, String path) throws IOException {
  8. URL url = new URL(netAddress);
  9. URLConnection conn = url.openConnection();
  10. InputStream inputStream = conn.getInputStream();
  11. FileOutputStream fileOutputStream = new FileOutputStream(path);
  12. int bytesum = 0;
  13. int byteread;
  14. byte[] buffer = new byte[1024];
  15. while ((byteread = inputStream.read(buffer)) != -1) {
  16. bytesum += byteread;
  17. System.out.println(bytesum);
  18. fileOutputStream.write(buffer, 0, byteread);
  19. }
  20. fileOutputStream.close();
  21. }

4. 网络文件获取到服务器后,经服务器处理后响应给前端

  1. /**
  2. * @param netAddress
  3. * @param filename
  4. * @param isOnLine
  5. * @param response
  6. * @功能描述 网络文件获取到服务器后,经服务器处理后响应给前端
  7. */
  8. @RequestMapping("/netDownLoadNet")
  9. public void netDownLoadNet(String netAddress, String filename, boolean isOnLine, HttpServletResponse response) throws Exception {
  10. URL url = new URL(netAddress);
  11. URLConnection conn = url.openConnection();
  12. InputStream inputStream = conn.getInputStream();
  13. response.reset();
  14. response.setContentType(conn.getContentType());
  15. if (isOnLine) {
  16. // 在线打开方式 文件名应该编码成UTF-8
  17. response.setHeader("Content-Disposition", "inline; filename=" + URLEncoder.encode(filename, "UTF-8"));
  18. } else {
  19. //纯下载方式 文件名应该编码成UTF-8
  20. response.setHeader("Content-Disposition", "attachment; filename=" + URLEncoder.encode(filename, "UTF-8"));
  21. }
  22. byte[] buffer = new byte[1024];
  23. int len;
  24. OutputStream outputStream = response.getOutputStream();
  25. while ((len = inputStream.read(buffer)) > 0) {
  26. outputStream.write(buffer, 0, len);
  27. }
  28. inputStream.close();
  29. }

常见异常和问题

(1)响应对象无需通过return返回

原因: 响应对象是可以不用作为方法返回值返回的,其在方法执行时已经开始输出,且其无法与@RestController配合,以JSON格式返回给前端

 解决办法:删除return语句

(2)返回前端的文件名必须进行URL编码

原因: 网络传输只能传输特定的几十个字符,需要将汉字、特殊字符等经过Base64等编码来转化为特定字符,从而进行传输,而不会乱码

 

(3)文件下载异常

有时候点击下载会出现在页面打开而没有去下载,导致此原因的是设置responseHeader位置不对。

当在如下位置设置时会出现一下问题:

 文件没有被下载,但是在浏览器页面直接出现了打开的文件,在windows默认下载的文件夹里未发现此文件

 

调整了下response.setContentType("application/octet-stream");的位置发现问题如下

 文件是下载了,但是下载的文件名、格式都不对

 

 

总结

文件下载对responseHeader设置要求很严格

  

   

 

声明:本文内容由网友自发贡献,不代表【wpsshop博客】立场,版权归原作者所有,本站不承担相应法律责任。如您发现有侵权的内容,请联系我们。转载请注明出处:https://www.wpsshop.cn/w/笔触狂放9/article/detail/815913
推荐阅读
相关标签
  

闽ICP备14008679号