前端多种方式实现文件下载

前端下载通常分为两种情形,一种是后端直接给一个文件地址,通过浏览器打开就可以下载,另外一种则需要发送请求,后端返回二进制流数据,前端解析流数据,生成URL,实现下载。

指定文件路径下载

该方式将下载逻辑放在后端处理,后端给出固定的url,前端使用window.location.herf下载

  window.location.herf = '/xxx/xxx/xxxx'

根据请求返回二进制数据流,生成流文件URL下载

该方式是发送请求后端返回二进制数据流,前端解析二进制流生成下载URL,再通过HTML5中<a>标签的download属性实现下载功能。

一、封装解析二进制流数据生成下载URL方法

根据二进制流数据生成下载URL可以有多种方式实现,具体实现如下:

1、将二进制数据封装为BLOB对象

// utils.js
export const download = (res, type, filename) => {
  // 创建blob对象,将二进制数据封装为BLOB对象
  const blob = new Blob([res], {
    // 如何后端没返回下载文件类型,则需要手动设置:type: 'application/pdf;chartset=UTF-8' 表示下载文档为pdf,如果是word则设置为msword,excel为excel
    type: type
  })
  const a = document.createElement('a')
  // 兼容webkix浏览器,处理webkit浏览器中herf自动添加blob前缀,默认在浏览器打开而不是下载
  const URL = window.URL || window.webkitURL
  // 根据blob对象创建URL 对象,生成本地URL
  const herf = URL.createObjectURL(blob)
  // 下载链接
  a.href = herf
  // 下载文件名,如果后端没有返回,可以自己写a.download = '文件.pdf'
  a.download = filename
  document.body.appendChild(a)
  a.click()
  document.body.removeChild(a)
  // 在内存中移除URL 对象
  window.URL.revokeObjectURL(herf)
}

2、将二进制数据封装为文件读取FileReader对象

// utils.js
export const download = (res) => {
  // 创建文件对象
  let reader = new FileReader()
  // 监听读取完毕
  reader.onloadend = function () {
    // 返回base64位的文件内容
    let url = reader.result
    // 下载
    window.location.href = url
  }
  // 开始读取指定的Blob中的内容。一旦完成,result属性中将包含一个data: URL格式的Base64字符串以表示所读取文件的内容。
  reader.readAsDataURL(res)
}

注意: 使用 FileReader对象封装二进制流之后没办法设置下载的文件名,默认文件名为下载,文件格式根据读取的是请求返回的content-type

3、使用插件file-saver

  • 下载插件
 npm install --save file-saver
  • 引入插件
 import { saveAs } from 'file-saver'
  • 封装下载方法,使用插件
 export const downloadFile = (res, type, filename) => {
   // 将二进制数据封装成blob对象
    const blob = new Blob([res], {
     type: type
   })
   /**
     这里也可以使用File对象封装二进制数据
     const file = new File([res], filename, {
       type: type
     });
   */
   // 调用插件方法
   saveAs(blob,filename)
 }

插件源码

4、使用插件downloadjs

  • 下载插件
 npm install --save downloadjs
  • 引入插件
 const download = require('downloadjs')

因为downloadjs源码中没有通过export导出download方法,而是通过return的方式返回download方法,因为需要使用require来引入文件。

  • 封装下载方法,使用插件
  export const downloadFile = (res, type, filename) => {
    // 将二进制流转成blob对象
    const blob = new Blob([res], {
      type: type
    })
    // 调用插件方法
    download(blob, filename, type);
  }

插件源码

二、发送请求,获取二进制流数据

// index.vue
<template>
  <div>
    <button @click='handleDownload'>下载</button>
  </div>
</template>
<script>
// 引入下载方法
import {download} from 'utils'
export default{
  methods: {
    async downloadFile () {
      let res = await axios.get(
        url: 'xxxx/xxxx',
        method: 'GET',
        // 设置返回数据类型,这里一定要设置,否则下载下来的文件会是空白,也可以是`arraybuffer`
        responseType: 'blob',
        params: {
          id: 'xxxxxx'
        }
      )
      // 获取在response headers中返回的下载文件类型
      let type = JSON.parse(res.headers)['content-type']
      
      /*获取在response headers中返回的下载文件名
        因为返回文件名是通过encodeURIComponent()函数进行了编码,因此需要通过decodeURIComponent()函数解码
      */
      let fileName = decodeURIComponent(JSON.parse(res.headers)['file-name'])
      // 调用封装好的下载函数
      download(res, type, fileName)
    },
    // 点击下载按钮下载
    handleDownload() {
      this.downloadFile()
    }
  }
}
</script>

注意:发送请求时一定要注意设置responseType: 'blob',否则后端返回的数据可能不是二进制流数据。

  • 后台返回的二进制数据文件流格式:


    文件流.png
  • 后端返回响应头:


    后端返回响应头.png

总结

以上通过了几种方式实现了前端文件下载功能,除了将下载逻辑放在后端处理,直接提供URL下载以外,后面几种方式都是通过前端发送请求,后端返回二进制流数据,然后封装流数据生成URL的方式,只是在打开方式上有所不同。最后使用的两个插件,查看源码也是围绕着a标签的download属性展开,只是做了兼容性处理。具体使用哪种可以根据自己的情况进行选择。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,189评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,577评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,857评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,703评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,705评论 5 366
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,620评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,995评论 3 396
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,656评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,898评论 1 298
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,639评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,720评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,395评论 4 319
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,982评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,953评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,195评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,907评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,472评论 2 342

推荐阅读更多精彩内容