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 = document.createevent('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链接时直接在浏览器打开文件内容了。

补充说明：

模式下貌似不生效；

链接指向一些第三方链接时也不会生效，具体有待研究；

2.3. js弹出下载对话框

假如给我们的不是一个下载地址而是一个blob对象，我们可以通过url.createobjecturl来给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 = url.createobjecturl(url); // 创建blob地址
 }
 var alink = document.createelement('a');
 alink.href = url;
 alink.download = savename || ''; // html5新增的属性，指定保存文件名，可以不要后缀，注意，file:///模式下不会生效
 var event;
 if(window.mouseevent) event = new mouseevent('click');
 else
 {
  event = document.createevent('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 = document.createelement('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 = document.createelement('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 = document.createelement('a');
 a.href = 'data:text/csv;charset=utf-8,\ufeff' + encodeuricomponent(csv);
 a.download = savename;
 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 = canvasobj.todataurl(type, quality).replace(/image\/.*?;/, 'image/octet-stream;');
 opendownloaddialog(url, savename);
}

扩展

关于文件保存，不嫌麻烦的话，github上面有个比较出名的库：https://github.com/eligrey/filesaver.js/

demo：https://eligrey.com/demos/filesaver.js/

以上所述是小编给大家介绍的js实现弹出下载对话框及常见文件类型的下载，希望对大家有所帮助