纯前端实现文件导出

一般情况下,想要实现文件下载/导出功能,需要在前端把数据发到服务端或者发送下载请求到服务端,然后由服务端通过获取数据 -> 生成数据 -> 生成文件三个步骤生成数据,在响应请求头中包含Content-disposition: attachment用于指定文件类型、文件名和文件编码等,浏览器接收到响应后就会触发下载行为。

但是有时候这种交互是一种多余的资源和带宽消耗,比如需要下载的是用户生成的内容(在线作图等)或者内容已经全部返回到客户端了。如果这时候能不经过服务端而直接生成下载任务,能节省不少的资源和时间开销。下面就说说实现的几种方法。

1 生成数据

导出的数据,必须先转换成浏览器支持的类型的值,然后再通过特定的方式导出。

1.1 data: URLs

data: URLs是前缀为data:的 URL 字符串,格式为

data:[<mediatype>][;base64],<data>

mediatype 是个 MIME 类型的字符串,例如 "image/jpeg" 表示 JPEG 图像文件。如果被省略,则默认值为 text/plain;charset=US-ASCII

如果数据是文本类型,你可以直接将文本嵌入 (根据文档类型,使用合适的实体字符或转义字符)。如果是二进制数据,你可以将数据进行base64编码之后再进行嵌入。

在浏览器一般可以这样�对字符串进行base64编码

var str = 'some file string';
var dataUrl = btoa(str);
// output => c29tZSBmaWxlIHN0cmluZw==

这种编码方式有一个非常大的缺点,就是每个浏览器对它的长度大小支持都不一样,尤其� chrome 只支持2MB大小,详细查看stackoverflow的回答data-protocol-url-size-limitations。其余缺点可以查看 MDN。

注:DataURLs 还有一个很常用的场景是在 css 中嵌入图片

浏览器兼容性

Feature Chrome Edge Firefox Internet Explorer Opera Safari
Basic support Yes 12 Yes 8 7.2 Yes
CSS files Yes 12 Yes 8,9 7.2 Yes
HTML files ? No ? No ? ?
JavaScript files Yes 12 Yes 9 7.2 Yes

1.2 blob:URLs

blob: URLsURL.createObjectURL() 静态方法创建的一个 DOMString,其中包含一个表示参数中给出的对象的URL。其中涉及到的File对象和Blob对象不再这里展开�,有兴趣可以去查阅 MDN。

�语法

var objectURL = URL.createObjectURL(blob);

注意
创建出来的BlobURLs需要手动调用URL.revokeObjectURL()销毁,否则会一直保留到页面关闭,为了获得最佳性能和内存使用状况,你应该在安全的时机主动释放掉它们。

浏览器兼容性

Chrome Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
23 4.0 10 15 7

1.3 FileReader

如果浏览器不支持下载 BlobURLs,则可以尝试使用�FileReaderBlob或者File对象转化成DataURLs

通过以下代码获取

var reader = new FileReader();
reader.onloadend = function() {
  var dataUrl = is_chrome_ios ? reader.result : reader.result.replace(/^data:[^;]*;/, 'data:attachment/file;');
  console.log(dataUrl);
};
reader.readAsDataURL(blob);

2 导出方式

2.1 HTML5 a.download

<a>标签的download是�HTML5标准新增的属性,作用是指示浏览器下载URL而不是导航到URL,因此将提示用户将其保存为本地文件。由于是�HTML5新增的属性,所以不是所有浏览器都支持,从 caniuse 中可以看到兼容性对比。使用此属性的�时候 href 属性支持 blob: URLsdata: URLs两种类型的值。download 属性的值用于指定文件名。

2.2 �location.href

这个方法是直接把 DataURLs 或者 BlogURLs 传到浏览器地址中触发下载。有两种方式:

window.location.href = urls; // 本窗口打开下载

window.open(urls, '_blank'); // 新开窗口下载

兼容性:

  • safari 不支持BlogURLs触发下载,所以一定要转成DataURLs

2.3 msSaveOrOpenBlob(IE10+)

这是 IE 特有的方法。

navigator.msSaveOrOpenBlob(blob, fileName);

2.4 iframe(IE <= 9)

�其他更现代的浏览器也支持此方法,不过此方法效率和安全性较低,所以一般只在 IE �<= 9 时使用。

// Internet Explorer (<= 9) workaround by Darryl (https://github.com/dawiong/tableExport.jquery.plugin)
// based on sampopes answer on http://stackoverflow.com/questions/22317951
// ! Not working for json and pdf format !
var frame = document.createElement("iframe");

if ( frame ) {
  document.body.appendChild(frame);
  frame.setAttribute("style", "display:none");
  frame.contentDocument.open("txt/html", "replace");
  frame.contentDocument.write(data); // data 是 string 类型
  frame.contentDocument.close();
  frame.focus();

  frame.contentDocument.execCommand("SaveAs", true, filename);
  document.body.removeChild(frame);
}

参考:

  1. FileSaver.js
  2. bootstrap-table 的 export 插件
  3. MDN

版权声明:本文为博主原创文章,未经博主允许不得转载,本文首发于xlaoyu

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

推荐阅读更多精彩内容

  • 点击查看原文 Web SDK 开发手册 SDK 概述 网易云信 SDK 为 Web 应用提供一个完善的 IM 系统...
    layjoy阅读 13,724评论 0 15
  • 点我查看本文集的说明及目录。 本项目相关内容包括: 实现过程: CH7 创建在线商店 CH8 管理支付和订单 CH...
    学以致用123阅读 3,536评论 0 6
  • 为自己唱首歌 文/诗酒年华 为了生活 经常在路上颠簸 为了赢得笑脸 经常给别人歌功颂德 为了他人的好感 常把委屈压...
    诗酒年华邢阅读 322评论 3 8
  • 今日份的心情很平淡。 还以为前两天可以下雪,可以堆在地上的那种雪,可是下着下着就没有了,大概就是那种只有稀有我们才...
    程么么阅读 301评论 0 7
  • 设计模式之单例模式:https://www.cnblogs.com/qiaoconglovelife/p/5851...
    久伴licy阅读 173评论 0 0