JS实现弹出下载对话框及常见⽂件类型的下载
1.写在前⾯
JS要实现下载功能,⼀般都是这么⼏个过程:⽣成下载的URL,动态创建⼀个A标签,并将其href指向⽣成的URL,然后触发A 标签的单击事件,这样就会弹出下载对话框,从⽽实现了⼀个下载的功能。
这⾥所说的下载,有时候也可以理解为保存。出于安全考虑,JS肯定⽆法直接调⽤FileAPI写⽂件到磁盘,但是却可以通过下载来变相实现保存功能。
2.⼏个备⽤知识点
2.1. JS触发单击事件
既然是⽤A标签模拟,那么肯定要知道JS如何主动触发单击事件。
最简单的触发单击事件肯定是elem.click(),平时在不需要考虑兼容性的场合我都是这么⼲的,但是毕竟这个⽅法有兼容性(具体兼容性如何没做过测试),所以还是要掌握⼀个通⽤的⽅法。
以下代码是⽹上⽐较容易到的⼀段代码,我在前⾯加了⼀段MouseEvent的判断:
/
**
* 触发单击事件
* @param elem 需要触发事件的DOM对象
*/
function fireClickEvent(elem)
{
var event;
if(window.MouseEvent) event = new MouseEvent('click');
else
{
event = ateEvent('MouseEvents');
event.initMouseEvent('click', true, false, window, 0, 0, 0, 0, 0, false, false, false, false, 0, null);
}
elem.dispatchEvent(event);
}
2.2. HTML5的download属性
这个属性很重要,它可以指定下载⽂件名,并且可以告诉浏览器⽬标链接是⼀个下载链接,不是⼀个普通链接,我们看下⾯代码就能看出区别了:
<a href="data:text/txt;charset=utf-8,测试下载纯⽂本" rel="external nofollow" rel="external nofollow" rel="external nofollow" download="测试.txt" >下载1</a> <a href="data:text/txt;charset=utf-8,测试下载纯⽂本" rel="external nofollow" rel="external nofollow" rel="external nofollow" >下载2</a>
可以发现,下载1按钮能够实现下载,点击下载2链接时直接在浏览器打开⽂件内容了。
补充说明:
file:///模式下貌似不⽣效;
链接指向⼀些第三⽅链接时也不会⽣效,具体有待研究;
2.3. JS弹出下载对话框
假如给我们的不是⼀个下载地址⽽是⼀个blob对象,我们可以通过ateObjectURL来给blob对象⽣成临时URL,并且可以利⽤HTML5的download属性来指定下载的⽂件名,好家伙,有了这2个东西我们就可以实现⼀个“万能”的弹出下载对话框⽅
法了。
综上所述,我⼜在fireClickEvent的基础上继续简单封装了⼀个openDownloadDialog⽅法,使⽤如下:
openDownloadDialog(url, saveName)
openDownloadDialog(blob, saveName)
代码如下:
/**
* 通⽤的打开下载对话框⽅法,没有测试过具体兼容性
* @param url 下载地址,也可以是⼀个blob对象,必选
* @param saveName 保存⽂件名,可选
*/
function openDownloadDialog(url, saveName)
{
if(typeof url == 'object' && url instanceof Blob)
{
url = ateObjectURL(url); // 创建blob地址
}
var aLink = ateElement('a');
aLink.href = url;
aLink.download = saveName || ''; // HTML5新增的属性,指定保存⽂件名,可以不要后缀,注意,file:///模式下不会⽣效
var event;
if(window.MouseEvent) event = new MouseEvent('click');
else
{
event = ateEvent('MouseEvents');
event.initMouseEvent('click', true, false, window, 0, 0, 0, 0, 0, false, false, false, false, 0, null);
}
aLink.dispatchEvent(event);
}
3.JS实现常见⽂件类型的下载
3.1. JS⽣成CSV⽂件并下载
csv是⼀种逗号分隔的表格⽂件格式,可以很好的被Excel⽀持,由于其⽂件格式简单,所以经常⽤在简单的表格上⾯。最重要的是它是⼀种纯⽂本格式,可以很轻松地⽤JS来⽣成⽽不借助第三⽅库。
3.1.1. CSV格式⽰例
如下:
姓名,期中成绩,期末成绩
张三,58,95
李四,98,74
王⼆,47,38
刘能,15,100
黄五,87,68
excel打开效果如下:
3.1.2. 初次尝试
⾸先想到的是使⽤data:text/txt;来实现,先看⼀下下载纯⽂本:
<a download="测试.txt" href="data:text/txt;charset=utf-8,测试下载纯⽂本" rel="external nofollow" rel="external nofollow" rel="external nofollow" >下载</a>
以上代码没⽑病,然后再换成csv。换csv的最⼤问题就是如何处理换⾏,很简单,⽤encodeURIComponent编码⼀下就可以了:
<button onclick="test()">下载CSV</button>
<script>
function test()
{
var csv = '姓名,期中成绩,期末成绩\n张三,58,95\n李四,98,74';
var a = ateElement('a');
a.href = 'data:text/txt;charset=utf-8,'+encodeURIComponent(csv);
a.download = '测试.csv';
a.click(); // 这⾥偷个懒,直接⽤click模拟
}
</script>
3.1.3. 解决CSV乱码问题
虽然我们⽤的是UTF-8编码,下载后你会发现,⽤⽂本编辑器打开没问题,但是⽤Excel打开乱码:
别急,原因就是少了⼀个\ufeffBOM头,改成这样就没问题了:
<button onclick="test()">下载CSV</button>
<script>
function test()
{
var csv = '姓名,期中成绩,期末成绩\n张三,58,95\n李四,98,74';
var a = ateElement('a');
a.href = 'data:text/txt;charset=utf-8,\ufeff'+encodeURIComponent(csv);
a.download = '测试.csv';
a.click(); // 这⾥偷个懒,直接⽤click模拟
}
</script>
3.1.
4. 继续解决下载⽂件名的问题
⼤部分浏览器可能都没啥问题,但是⼀些⽐较⽼的Chrome可能下载的时候指定的download就是不⽣效,此时可以⽤blob来解决:
var csv = '姓名,期中成绩,期末成绩\n张三,58,95\n李四,98,74';
var blob = new Blob(['\ufeff' + data], {type: 'text/csv,charset=UTF-8'});
openDownloadDialog(blob, '测试.csv');
建议⼀般情况下都⽤这种⽅法,稳妥⼀点。
3.1.5. 最后总结
不考虑兼容性的保存CSV⽅法:
/**
* 保存CSV⽂件
* @params csv csv⽂件内容
* @params saveName 保存的⽂件名
*/
function saveCSV(csv, saveName)
{
var a = ateElement('a');
a.href = 'data:text/csv;charset=utf-8,\ufeff' + encodeURIComponent(csv);
a.download = saveName;
chrome直接下载a.click();
}
考虑兼容性的保存CSV⽅法:
/**
* 保存CSV⽂件
* @params csv csv⽂件内容
* @params saveName 保存的⽂件名
*/
function saveCSV(csv, saveName)
{
var blob = new Blob(['\ufeff' + csv], {type: 'text/csv,charset=UTF-8'});
openDownloadDialog(blob, saveName);
}
3.2. JS实现纯⽂本的下载保存
掌握了csv,再去下载纯⽂本基本上就没啥问题了,就是换⼀下⽂件类型⽽已:
var csv = '你好,我是⼩茗同学!\n测试换⾏!';
var blob = new Blob([data], {type: 'text/txt,charset=UTF-8'});
openDownloadDialog(blob, '测试.csv');
3.3. JS实现图⽚的下载保存
⽹页上⼀般要保存图⽚都是从canvas⾥⾯拿到的图⽚数据,通过toDataURL转换为base64数据:
/**
* 将某个canvas保存为图⽚
* @param canvasObj canvas对象
* @param saveName 保存的名称
* @param type 保存的图⽚格式,如 image/png
* @param quality 图⽚质量,可选0-1
*/
function saveImage(canvasObj, saveName, type, quality)
{
if(!canvasObj) return;
type = type || 'image/png';
quality = quality || 0.92;
var url = DataURL(type, quality).replace(/image\/.*?;/, 'image/octet-stream;');
openDownloadDialog(url, saveName);
}
扩展
以上所述是⼩编给⼤家介绍的JS实现弹出下载对话框及常见⽂件类型的下载,希望对⼤家有所帮助,如果⼤家有任何疑问请给我留⾔,⼩编会及时回复⼤家的。在此也⾮常感谢⼤家对⽹站的⽀持!
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论