js-link下载文件

摘要:
下面的代码是一段在互联网上很容易找到的代码。我在前面添加了一个MouseEvent判断:/***考虑到兼容性,触发单击事件*@paramelem DOM对象以触发单击事件*/functionfireClickEvent{varevent;ifevent=newMouseEvent;else{event=document.createEvent;event.initMouseEvent元素。dispatchEvent;}2.2.HTML5的下载属性非常重要。它可以指定下载文件名,并告诉浏览器目标链接是下载链接,而不是普通链接。通过查看以下代码,我们可以看出区别:download 1download 2,下载1按钮可用于下载。单击下载2链接时,文件内容将直接在浏览器中打开。

1. 需求

JS要实现下载功能,一般都是这么几个过程:生成下载的URL,动态创建一个A标签,并将其href指向生成的URL,然后触发A标签的单击事件,这样就会弹出下载对话框,从而实现了一个下载的功能。

这里所说的下载,有时候也可以理解为保存。出于安全考虑,JS肯定无法直接调用FileAPI写文件到磁盘,但是却可以通过下载来变相实现保存功能。

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,测试下载纯文本" download="测试.txt" >下载1</a>
<a href="data:text/txt;charset=utf-8,测试下载纯文本">下载2</a>

可以发现,下载1按钮能够实现下载,点击下载2链接时直接在浏览器打开文件内容了。

补充说明:

  • file:///模式下貌似不生效;
  • 链接指向一些第三方链接时也不会生效,具体有待研究;

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);
}
JS实现常见文件类型的下载

3.1. JS生成CSV文件并下载

csv是一种逗号分隔的表格文件格式,可以很好的被Excel支持,由于其文件格式简单,所以经常用在简单的表格上面。最重要的是它是一种纯文本格式,可以很轻松地用JS来生成而不借助第三方库。

3.1.1. CSV格式示例

如下:

姓名,期中成绩,期末成绩
张三,58,95
李四,98,74
王二,47,38
刘能,15,100
黄五,87,68

3.1.2. 初次尝试

首先想到的是使用data:text/txt;来实现,先看一下下载纯文本:

<a download="测试.txt" href="data:text/txt;charset=utf-8,测试下载纯文本">下载</a>

以上代码没毛病,然后再换成csv。换csv的最大问题就是如何处理换行,很简单,用encodeURIComponent编码一下就可以了:

<button onclick="test()">下载CSV</button>
<script>
function test()
{
	var csv = '姓名,期中成绩,期末成绩
张三,58,95
李四,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 = '姓名,期中成绩,期末成绩
张三,58,95
李四,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 = '姓名,期中成绩,期末成绩
张三,58,95
李四,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.1.6. 20180115更新

今天碰到了一个CSV文件太长导致下载失败的问题(有1.6MB

经测试发现,直接采用拼接字符串的方法对于太大的csv文件可能会下载失败,换成blob对象就不会,所以,建议无论何时都采用blob方法最稳妥。

3.2. JS实现纯文本的下载保存

掌握了csv,再去下载纯文本基本上就没啥问题了,就是换一下文件类型而已:

var txt = '你好,我是小茗同学!
测试换行!';
var blob = new Blob([txt], {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);
}

免责声明:文章转载自《js-link下载文件》仅用于学习参考。如对内容有疑问,请及时联系本站处理。

上篇基于JQuery的浮动DIV显示提示信息并自动隐藏Android中app卡顿原因分析示例下篇

宿迁高防,2C2G15M,22元/月;香港BGP,2C5G5M,25元/月 雨云优惠码:MjYwNzM=

相关文章

兼容性测试、手工测试、自动化测试及探索性测试

兼容性测试、手工测试、自动化测试及探索性测试 版权声明:本文为博主原创文章,未经博主允许不得转载。 一、兼容性测试 兼容性测试概念: 兼容性测试依赖的因素:操作系统、浏览器、运行环境、硬件、插件等。 兼容性测试过程: Process of compatibility testing Understand the software that you wi...

低JAVA版本,高兼容性启动

低JAVA版本,高兼容性启动 背景:部分操作系统java环境低版本,暂时无法更新最新版本,新系统需要使用较高版本Java环境 1.JAVA低版本不兼容当前应用 2.解压安装JAVA,无需配置环境变量 3.新系统启动脚本中定义参考: JAVA_HOME="/home/java/jdk1.8.0_161" 4.JAR包启动命令参考: JAVA_OPTIONS=...

IE=EmulateIE7 标签的作用

对于 Web 开发人员来说,文本兼容性是一个要考虑的重要问题。Windows Internet Explorer 8 引入了文本兼容性模式,该模式允许 Web 开发人员将浏览器设置为以与旧版本相同的方式显示网页,从而允许开发人员选择更新时间。 本文档将介绍由 Windows Internet Explorer 8 支持的文本兼容性模式,以及如何使用自定义标...

Web前端测试要点

Web前端测试维度: 功能性:功能准确性、兼容性 易用性:易学性、易理解性、易操作性、吸引性 可靠性:成熟性、容错性、稳定性、可恢复性、安全性 可移植性:适应性、易安装性、兼容性 可维护性:易分析性、易测试性 效率:时间特性、资源利用性 调优点: 1. 减少http请求的数量 2. 用好浏览器缓存机制 3. 利用GZIP压缩机制:只针对文本类资源有效...

网页兼容性测试(工具使用IETESTER、Firefox、360安全浏览器)

网页兼容性测试主要是针对不同的浏览器进行的测试。由于用户浏览器的不同,往往都会使我们的网页发生页面样式错乱,图片无法显示等问题。对于前端开发工程师来说,确保代码在各种主流浏览器的各个版本中都能正常显示,因此要对编写出来的网页进行兼容性测试 点击【IETester】图标打开一个窗口,这个窗口跟浏览器类似。创建的浏览器页面默认展示的是IETester Ho...

CentOS 7下NFS Server作rootfs时的兼容性问题

最近新装CentOS 7,发现原先CentOS 6.3下可用的一块ARM Dev board不能用了,表现为VFS mount挂载rootfs失败。 使用WireShark发现,服务器对client发来的NFS RPC返回reply "Can't support version #2" (在reply的verifier字段中)。 man nfsd告诉我们,...