欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

JavaScript实现多文件下载方法解析

程序员文章站 2022-06-09 22:51:26
对于文件的下载,可以说是一个十分常见的话题,前端的很多项目中都会有这样的需求,比如 highchart 统计图的导出,在线图片编辑中的图片保存,在线代码编辑的代码导出等等。而很多时候,我们只给了一个链...

对于文件的下载,可以说是一个十分常见的话题,前端的很多项目中都会有这样的需求,比如 highchart 统计图的导出,在线图片编辑中的图片保存,在线代码编辑的代码导出等等。而很多时候,我们只给了一个链接,用户需要右键点击链接,然后选择“另存为”,这个过程虽说不麻烦,但还是需要两步操作,倘若用户想保存页面中的多个链接文件,就得重复操作很多次,最常见的就是英语听力网站上的音频下载,手都要点麻!

本文的目的是介绍如何利用 javascript 进行多文件的下载,也就是当用户点击某个链接或者按钮的时候,同时下载多个文件。这里的“同时”用的不是很准确,在现代浏览器中可以实现多文件的并行下载,而在一些老版本浏览器,如ie8-,此类的浏览器就只能进行单个文件的下载,但是我们可以让多个文件依次保存下来,算是串行下载吧~

若要要无视实现细节,可以直接跳到第三部分,或者戳:

代码封装:

demo:(https,第三个有bug,具体原因下面有说明)

(http,测试正常)

一、文件类型介绍及其特点

1. 一般类型

平时比较常见的有 txt、png、jpg、zip、tar 等各种文件格式,这些文件格式中,一部分浏览器是会直接打开链接显示内容的,而另外一部分,浏览器不识别响应头,或者不能解析对应的格式,于是当做文件直接下载下来了。如:

<a href="http://barretlee.com/test.rar" rel="external nofollow" >file</a>

这句代码,若直接点开链接,浏览器将会直接下载该文件。

2. dataurl类型

dataurl 也是十分常见的类型,他可以作为 src 或者 url() 的参数送进去。比较常见的有如下几种:

文本: data:text/plain;这里是正文内容。
图片: data:image/jpg;base64,/9j/4aaqskzjrgabaqea....
  data:image/png;base64,/9j/4aaqskzjrgabaqea....

base64 是用的比较广泛的一种数据格式。

base64格式
data:[][;charset=][;base64],

base64 在css中的使用:
.demoimg{ background-image: url("data:image/jpg;base64,/9j/4qmzrxhpzgaasukqaagaaaal...."); }

base64 在html中的使用:
<img width="40" height="30" src="data:image/jpg;base64,/9j/4qmzrxhpzgaasukqaagaaaal...." />  

3. blob 流

blob 对象表示不可变的、包含原始数据的类文件对象。具体的内容可以参阅mdn文档

他的使用也是特别的方便,如:

var afileparts = ['<a id="a"><b id="b">hey!</b></a>'];
var omyblob = new blob(afileparts, {type : 'text/html'}); // the blob

blob 接收两个参数,一个是数组类型的数据对象,他可以是 arraybuffer、arraybufferview、blob、string 等诸多类型;第二个参数是 mine 类型设置。而本文我们要用到的是 urlcreateobjecturl() 这个函数,他的作用是将一个 url 所代表的内容转化成一个domstring,产生的结果是一个 文件对象 或者 blob 对象。

4. 二进制流

我们利用 file api 读取文件的时候,拿到的是数据的二进制流格式,这些类型可以直接被 arraybuffer 等接收,本文中没有用到,就不细说了。

二、javascript 多文件下载

html5 中 a 标签多了一个属性——download,用户点击链接浏览器会打开并显示该链接的内容,若在链接中加了 download 属性,点击该链接不会打开这个文件,而是直接下载。虽说是比较好用,但低版本浏览器不兼容,这个在本节的 2 和 3 中将会讲到解决方案。

在这里,我们可以利用属性检测ua 来判断浏览器类型:

h5down = document.createelement("a").hasownproperty("download");
var h5down = !/trident|msie/.test(navigator.useragent); // trident 标识 ie11

1. a 标签 download 属性的使用

注:ff5.0 / safari5.0 / opera11.1 / ie9.0 不支持 download 属性

利用 download 属性可以直接下载单个文件,若想点击一次下载多个文件,就得稍加处理下了:

function downloadfile(filename, content){
 var alink = document.createelement("a"),
  evt = document.createevent("htmlevents");

 evt.initevent("click");
 alink.download = filename;
 alink.href = content;

 alink.dispatchevent(evt);
}

download 属性的作用除了让浏览器忽略文件的 mime 类型之外,还会把该属性的值作为文件名。你可以在 chrome 控制台运行这句程序:

downloadfile("barretlee.html", "./");

浏览器会提示是否保留(下载)该 html 文件。之前我们提到文件类型还可能是 dataurl 或者是 blob 流,为了让程序也支持这些数据类型,稍微修改下上面的函数:

function downloadfile(filename, content){
 var alink = document.createelement('a');
  , blob = new blob([content])
  , evt = document.createevent("htmlevents");

 evt.initevent("click");

 alink.download = filename;
 alink.href = url.createobjecturl(blob);
 alink.dispatchevent(evt);
}

new blob([content]),现将文件转换成一个 blog 流,然后,使用 url.createobjecturl() 将其转换成一个 domstring。这样我们就支持 data64 和其他数据类型的 content 了~

2. window.open 之后 execcommand("saveas")

上面也提到了,尽管 download 属性是十分便利的 h5 利器,但低版本 ie 根本不赏脸,要说方法,ie 还是有很多方式去转换的,比如 adobe.stream 的 activex 对象可以把文件转换成文件流,然后写入到一个要保存的文件中。这里要谈到的是略微方便一点的方式:先把内容写到一个新开的 window 对象中,然后利用 execcommand 执行保存命令,就相当于我们在页面上按下 ctrl+s,这样页面内的信息都会 down 下来。

// 将文件在一个 window 窗口中打开,并隐藏这个窗口。
var win = window.open("path/to/file.ext", "new window", "width=0,height=0");
// 在 win 窗口中按下 ctrl+s 保存窗口内容
win.document.execcommand("saveas", true, "filename.ext");
// 使用完了,关闭窗口
win.close();

这个过程十分明了,不过这里会存在一个问题,并不是程序的问题,而是浏览器的问题,如果我们用 搜狗浏览器 或者 360浏览器 打开新窗口的话,他会新开一个标签页,而不是新开一个窗口,更可恶的是部分浏览器拦截 window.open 的窗口(这个可以设置)。所以只好另觅他法了。

3. iframe 中操作

既然新开一个窗口那么麻烦,我就在本窗口下完成工作~

function iedownloadfile(filename, contentorpath){
 var ifr = document.createelement('iframe');

 ifr.style.display = 'none';
 ifr.src = contentorpath;

 document.body.appendchild(ifr);


 // 保存页面 -> 保存文件
 ifr.contentwindow.document.execcommand('saveas', false, filename);
 document.body.removechild(ifr);
}

一般的链接我们可以直接给 iframe 添加 src 属性,然后执行 saveas 命令,倘若我们使用的是 data64 编码的文件,这个怎么办?

var isimg = contentorpath.slice(0, 10) === "data:image";

// dataurl 的情况
isimg && ifr.contentwindow.document.write("<img src='" + 
  contentorpath + "' />");

这个也比较好处理,直接把文件写入到 iframe 中,然后在执行保存。

三、代码的封装与接口介绍

1. 代码的封装以及相关 demo

封装:

demo:(https,第三个有bug)

(http,测试正常)

bug 说明,经过一番细节处理之后,基本兼容各个浏览器,我把代码放在 https://raw.github.com 上托管,可能因为是 https 传输,第三个测试中报错了,报错的具体内容是:https 安全受到 http://rawgithub.com/barretlee/javascript-multiple-download/master/file/test.jpg 的威胁,而 test.txt 文件没有报错。放到 http 协议下测试运行结果是可观的。(这点我没有去深究,肯定是有深层安全方面原因的,难道就因为他是 jpg图片格式? 谢@屈屈提醒,跨协议传输存在安全问题)后面的 demo 我放在 bae 上,没有问题,不过没测试 safari 和 opera。

2. 接口的调用

提供了三个接口,支持单文件下载,多文件下载,多文件下载自定义命名。

1)单文件下载

downer("./file/test.txt");

2)多文件下载

downer(["./file/test.txt","./file/test.txt"]);

3)多文件下载自定义命名

downer({
 "1.txt":"./file/test.txt",
 "2.jpg":"./file/test.jpg"
}); 

文件的 url 如 ./file/test.jpg 都可以改成 base64 或者其他格式,如:

downer({
  //这是一个很长的 datauri,我用负的text-indent隐藏了,可直接复制
 "data64.jpg" : "data:image/jpg;base64,/9j/4aaqskzjrgabaqeayabgaad/2wbdaamcagmcagmdawmeawmebqgfbqqebqohbwyidaomdaskcwsndhiqdq4rdgslebyqermufruvda8xgbyugbiufrt/2wbdaqmebauebqkfbqkudqsnfbqufbqufbqufbqufbqufbqufbqufbqufbqufbqufbqufbqufbqufbqufbqufbqufbt/waarcaayadsdasiaahebaxeb/8qahwaaaqubaqebaqeaaaaaaaaaaaecawqfbgcicqol/8qatraaagedawieawufbaqaaaf9aqidaaqrbrihmuege1fhbyjxfdkbkaeii0kxwrvs0fakm2jyggkkfhcygroljicokso0nty3odk6q0rfrkdisuptvfvwv1hzwmnkzwznaglqc3r1dnd4exqdhiwgh4ijipktljwwl5izmqkjpkwmp6ipqrkztlw2t7i5usldxmxgx8jjytlt1nxw19jz2uhi4+tl5ufo6erx8vp09fb3+pn6/8qahweaawebaqebaqebaqaaaaaaaaecawqfbgcicqol/8qatreaagecbaqdbacfbaqaaqj3aaecaxeebsexbhjbuqdhcrmimoeifekrobhbcsmzuvavynlrchyknoel8rcygromjygpkju2nzg5okneruzhselku1rvvldywvpjzgvmz2hpann0dxz3ehl6gooehyahiimkkpoulzaxmjmaoqokpaanqkmqsro0tba3ulm6wspexcbhymnk0tpu1dbx2nna4upk5ebn6onq8vp09fb3+pn6/9oadambaairaxeapwd9ngkkk8w8beo/emvzgdj08w2jw2t2wnxgpldx+e7ppekii3ejgyj5mwsjfkzkquac3vfc0lff10/uolz1civo9h+lemrep7jw8mlbrlfpda6nc1y0cksx30z2t1hgchbecsjaqqvhojpcfjnxfc+hnu1rxppmh6vp9mt232i01wwxmgv0idxt0crhd8+45xnam4a00uz9rgtzcq3vb5noflxcfdz4j3vjbt9xm+hsabqdhtitwfxgswzcybtc28djjdakx7frjzi/qmv6zh8ldr1m6sp+ef12psprprpzkufssyxmwxebtfba5xg0oli2n/vwh+8auep1gflxgekhqmj+ftgmt9fvvtvvfwmc9w0vswvukui43wuevtaicnmyqggyi6hs6lqwk7ppunrkpehwn8n+knrkvdqh1bpzjy7ho7fvru3hawpbslmucqpvxyhd7d2vu54fffnnxd1upyjifhb4dt/ekouxwxy6hbnjpd/xnlryimkz5myhzplunkllc4j5iyaawp4w+gy7+/uzp7yy3sc8uitxc0kuazhdmio2cpdvplewfyetrrrd9wh6b8nnb8nyapjzx38kmpxrfepe6pdxbtkaqmmarjkakzhomdoakmbwlp9n8pp/cgkr/zmm/wbnyadbjls+qjiub+zstjpdsn1oopotfua91prdf1+hfrfhnwnb0hslctvrgoac6tbi+mxt323cwyrjtixzv3rzkxljjgz4pwuooopntkpwvkf/2q==" 
});

这里只做到了 chrome 兼容,ie 下懒得去看了,这个需求很少见!

四、服务器支持与后端实现

1. 后端实现

不使用前端,直接后端实现的原理,就是在响应头中加入一些特殊的标记,如前端发送这样的请求:

function download(path) {
 var ifrm = document.getelementbyid(frame);
 ifrm.src = "download.php?path="+path;
}

后端的响应为

<?php 
 header("content-type: application/octet-stream");
 header("content-disposition: attachment; filename=".$_get['path']);
 readfile($_get['path']);
?>

告诉浏览器这是一个流文件,作为附件方式发送给你,请忽略 mine type,直接保存。

2. 服务器配置

若后台是 apche 作为服务器,可以配置 htaccess 文件:

<filesmatch "\.(zip|rar)$"="">
header set content-disposition attachment
</filesmatch>

意思是只要请求的是 zip 或者 rar 类型的文件,那么就添加一个 content-disposition:attachment 的响应头。这样就可以在 php 代码中省略麻烦的操作。

五、小结

由于行文仓促,文中会有不少错误,对多文件下载有更好的提议,希望提出来共同分享!

实现多文件下载的方式肯定不止上面提到的几种,而且我这里封装的代码并没有在ff safari opera 中实现,因为他们还没兼容 download 属性,具体情况可以查看 。建议在项目中把这样的事情交给后端,几句代码可以搞定。

六、参考资料

在浏览器端用js创建和下载文件 alloyteam

starting file download with javascript ahzaz's blog

blob 流 mdn

到此这篇关于javascript实现多文件下载方法解析的文章就介绍到这了,更多相关javascript多文件下载内容请搜索以前的文章或继续浏览下面的相关文章希望大家以后多多支持!