[JavaScript] 文件下载

一、文件下载

业务中常用的下载类型有多种,其接口的responseType 也不同:
xlsx类型是application/vnd.msexcel,
zip类型application/x-zip-compressed,
其他类型application/octet-stream
在前端接受此数据进行处理时,可以 统一 转为Blob 数据,然后再生成文件下载。

实现如下:

const filename = response.headers['content-disposition'].match(
      /filename=(.*)/
)[1]
// 首先要创建一个 Blob 对象(表示不可变、原始数据的类文件对象)
const blob = new Blob([response.data], {type: 'application/zip'});
// or const blob = new File([response.data], fileName);

if (typeof window.navigator.msSaveBlob !== 'undefined') {
    // 兼容IE,window.navigator.msSaveBlob:以本地方式保存文件
    window.navigator.msSaveBlob(blob, decodeURI(filename))
} else {
    let elink = document.createElement("a"); // 创建一个<a>标签
    elink.style.display = "none"; // 隐藏标签
    elink.href = window.URL.createObjectURL(blob); // 配置href,指向本地文件的内存地址
    elink.download = filename;
    elink.click();
    URL.revokeObjectURL(elink.href); // 释放URL 对象
    document.body.removeChild(elink); // 移除<a>标签
}

几个相关的小知识:
1、Content-Type: application/octet-stream 等告诉客户端这是一个二进制文件,content-disposition 字段告诉客户端一个需要下载的附件并告诉浏览器该附件默认的文件名。

2、content-disposition字段正常情况下能在浏览器中看到, 但是js获取不到。 原因为:默认情况下,header 只有七种 simple response headers (简单响应首部)可以暴露给外部。

Cache-Control
Content-Language
Content-Length
Content-Type
Expires
Last-Modified
Pragma

如果想读取其值 可以如下进行设置:

response.setHeader("Access-Control-Expose-Headers", "Content-Disposition");
response.setHeader("content-disposition", "attachment; filename=" + filename);

3、如果直接在浏览器中打开Content-Type: application/octet-stream 等二进制类型的文件时,会直接下载, 原因是因为浏览器由于无法识别流数据。如果是浏览器可识别的格式,如 xml, image 等则不会下载,会以预览的形式存在。

4、ajax 本身无法触发浏览器的下载功能, 它的 response 会交由 JavaScript 处理,使用 ajax 下载完成后,response 以字符串的形式存储在内存中,所以可以在浏览器中preview中看到返回数据,但是却不可以下载。
但浏览器的 GET 请求(主要以 frame 加载, a 标签点击触发)或 POST请求(以 form 的形式存在)是可以下载文件的,因为这是浏览器的内置事件,下载的 response 会交由浏览器自己处理,浏览器如果识别到是二进制流数据则下载,上面文件下载也是使用的浏览器的此下载功能实现。

二、基础知识

1、 Blob

Blob对象表示一个不可变、原始数据的类文件对象。它的数据可以按文本或二进制的格式进行读取,也可以转换成 ReadableStream 来用于数据操作。 Blob 表示的不一定是JavaScript原生格式的数据。

  • 其他非blob对象和数据 构造Blob
   const data = { hello: 'world' };
   const blob = new Blob([JSON.stringify(data, null, 2)], {type : 'application/json'});
   console.log(blob)
blob 打印.png
  • Blob 对象的属性
    size:Blob对象中所包含数据的大小(字节);
    type: string,表明该 Blob 对象所包含数据的 MIME 类型。如果类型未知,则该值为空字符串。 看上图 size 为22, type为application/json
  • Blob对象转为其他格式
    即从Blob对象中读出其包含的数据。
    Blob.text(): 返回一个promise且包含blob所有内容的UTF-8格式的 USVString
  const data = { hello: 'world' };
   const blob = new Blob([JSON.stringify(data, null, 2)], {type : 'application/json'});
   blob.text().then( text => console.log(text))

image.png

注意: text为string类型。
除此之外还有Blob.arrayBuffer()Blob.stream()

  • responseType属性设置为“blob”
    将二进制文件读取为blob类型的数据

2、File API

File 接口基于Blob,继承了 blob 的功能并将其扩展使其支持用户系统上的文件, 提供有关文件的信息,并允许网页中的 JavaScript 访问其内容

  • File()
    返回一个新构建的文件对象(File)

更多File文件内容参见我的另一篇文档由浅入深了解文件操作

三、 其他方法

获取一张图片的宽高

export default function getUploadImgSize(file) {
  return new Promise(resolve => {
    const reader = new FileReader()
    reader.readAsDataURL(file)
    reader.onload = function(e) {
      const result = e.target.result
      const img = new Image()
      img.src = result
      img.onload = function() {
        resolve({
          width: img.width,
          height: img.height,
        })
      }
    }
  })
}

参考资料

1、MDN - Blob

hi~ 点赞了么~~

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