前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >前端如何下载文件流

前端如何下载文件流

原创
作者头像
汤圆学Java
修改2021-10-25 09:57:50
3.2K0
修改2021-10-25 09:57:50
举报
文章被收录于专栏:汤圆学Java汤圆学Java

前言

如果后台返回的是文件地址,那么前端直接通过 window.location.href 加文件地址,就可以下载文件;

但是如果后台返回的是文件流,那么前端就需要做一些处理;

其实前端处理的核心:就是将文件流转为文件,然后再模拟点击,实现前者的效果。

步骤

1. 封装一个下载工具

这个工具的作用就是,将获取的文件流转为文件,并模拟点击该文件,实现下载

先贴代码,download.js(可直接复制使用)

代码语言:javascript
复制
export const download = (res, type, filename) => {
  // 创建blob对象,解析流数据
  const blob = new Blob([res], {
    // 设置返回的文件类型
    // type: 'application/pdf;charset=UTF-8' 表示下载文档为pdf,如果是word则设置为msword,excel为excel
    type: type
  })
  // 这里就是创建一个a标签,等下用来模拟点击事件
  const a = document.createElement('a')
  // 兼容webkix浏览器,处理webkit浏览器中href自动添加blob前缀,默认在浏览器打开而不是下载
  const URL = window.URL || window.webkitURL
  // 根据解析后的blob对象创建URL 对象
  const herf = URL.createObjectURL(blob)
  // 下载链接
  a.href = herf
  // 下载文件名,如果后端没有返回,可以自己写a.download = '文件.pdf'
  a.download = filename
  document.body.appendChild(a)
  // 点击a标签,进行下载 
  a.click()
  // 收尾工作,在内存中移除URL 对象
  document.body.removeChild(a)
  window.URL.revokeObjectURL(herf)
}

上面代码的重点是Blob对象,详情可参考:MDN文档:Blob对象

2. 获取文件流

这里就是调用后台接口,获取文件流

后台方法:

代码语言:javascript
复制
@GetMapping(value = "/download-file")
    public byte[] downloadFile(String contractNo){
        log.info("=== 下载合同文件 ===");
        byte[] bytes = service.downloadContract(Dict.create().set("contractNo", contractNo));
        return bytes;
    }

前端获取文件流的方法:

代码语言:javascript
复制
​
import { download } from '@/utils/download'
import { axios } from '@/utils/request'
​
async downloadFile (contractNo) {
    const res = await axios.get(this.downloadContractFilePath + contractNo, {
        // 设置返回数据类型,这里我设置的是"arraybuffer";如果不设置则下载下来的pdf会是空白
        responseType: 'arraybuffer'
    })
    // 调用封装好的下载函数
    download(res, 'application/pdf;charset=UTF-8', moment().format('YYYYMMDD') + '.pdf')
}

关于responseType可参考官网:XMLHttpRequest.responseType - Web API 接口参考 | MDN (mozilla.org)

3. 点击标签a

最后我们创建一个标签a,来点击下载文件

代码语言:javascript
复制
<a @click="downloadFile(contractNo)">点击下载</a>

总结

  • 如果后台返回的是文件地址,那么前端直接通过 window.location.href 加文件地址,就可以下载文件;
  • 如果后台返回的是文件流,那么前端就需要做一些处理:就是将文件流转为文件,然后再模拟点击,进行下载。

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 前言
  • 步骤
    • 1. 封装一个下载工具
      • 2. 获取文件流
        • 3. 点击标签a
        • 总结
        领券
        问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档