简述三种异步上传文件方式
很久没写过博客了!
上次写已经是去年的12月了,离现在也有足足三个月了。这几个月因为要搭建个人网站以及准备个人简历,包括最近要准备最近的各大公司的实习春招,很难抽时间来写博客,这次的异步文件上传我觉得是很有必要了解的,笼络了很多知识点,因此准备写一篇博客来巩固下。
异步上传文件是为了更好的用户体验,是每个前端必须掌握的技能。这里我提出三点有关异步文件上传的方式。
使用第三方控件,如Flash,ActiveX等浏览器插件上传。
使用隐藏的iframe模拟异步上传。
使用XMLHttpRequest2来实现异步上传。
第一种使用浏览器插件上传,需要一定的底层编码功底,在这里我就不讲了,以免误人子弟,提出这点大家可以自行百度。
第二种使用隐藏的iframe模拟异步上传。为什么在这里说的是模拟呢?因为我们其实是将返回结果放在了一个隐藏的iframe中,所以才没有使当前页面跳转,感觉就像是异步操作一样。
先贴出代码:
1 <!DOCTYPE html> 2 <html lang="en"> 3 <head> 4 <meta charset="UTF-8"> 5 <title>隐藏的iframe上传文件</title> 6 <script type="text/javascript" src="jquery路径..."></script> 7 </head> 8 <body> 9 <iframe name="frm" style="display:none"></iframe> 10 <form action="/upload2" enctype="multipart/form-data" method="post" target="frm" onsubmit="loading(true);"> 11 <p id="upfile">附件: <input type="file" name="myfile" style="display: inline"></p> 12 <p id="upbtn"><input style="padding-left:50px;padding-right: 50px;" type="submit" value="异步上传"> 13 <span id="uptxt" style="display: none">正在上传...</span></p> 14 </form> 15 <div id="flist" style="border:1px dotted darkgray;"></div> 16 <script> 17 // 上传完成后的回调 18 function uploadFinished(fileName) { 19 addToFlist(fileName); 20 loading(false); 21 } 22 23 function addToFlist(fname) { 24 var temp = ["<p id='" + fname + "'>", 25 fname, 26 "<button onclick='delFile(\"" + fname + "\");'>删除</button>", 27 "</p>" 28 ]; 29 $("#flist").append(temp.join("")); 30 } 31 32 function loading(showloading) { 33 if (showloading) { 34 $("#uptxt").show(); 35 } else { 36 $("#uptxt").hide(); 37 } 38 } 39 </script> 40 </body> 41 </html>
这种技术有两个关键的地方:
1.form会指定target,提交的结果定向返回到隐藏的ifram中。(即form的target与iframe的name属性一致)。
2.提交完成后,iframe中页面与主页面通信,通知上传结果及服务端文件信息
如何与主页面通信呢?
我们用nodejs在接收完了文件后返回了一个window.parent.主页面定义的方法,执行后可以得知文件上传完成。代码很简单:
1 router.post('/upload2', multipartMiddleware, function(req, res) { 2 var fpath = req.files.myfile.path; 3 var fname = fpath.substr(fpath.lastIndexOf('\\') + 1); 4 setTimeout(function() { 5 var ret = ["<script>", 6 "window.parent.uploadFinished('" + fname + "');", 7 "</script>"]; 8 res.send(ret.join("")); 9 }, 3000); 10 11 });
执行后可以打开开发人员选项,你会发现隐藏iframe中返回了服务器的一些数据。
第三种使用XMLHttpRequest2来进行真正的异步上传。
还是先贴出代码:
1 <!DOCTYPE html> 2 <html lang="en"> 3 <head> 4 <meta charset="UTF-8"> 5 <title>xhr level2 异步上传</title> 6 <script type="text/javascript" src="jquery路径..."></script> 7 </head> 8 <body> 9 <div> 10 <p id="upfile">附件: <input type="file" id="myfile" style="display: inline"></p> 11 <p id="upbtn"> 12 <input style="padding-left:50px;padding-right: 50px;" type="button" value="异步上传" onclick="upload();"> 13 <span id="uptxt" style="display: none">正在上传...</span> 14 <span id="upprog"></span> 15 <button id="stopbtn" style="display:none;">停止上传</button> 16 </p> 17 </div> 18 19 <div id="flist" style="border:1px dotted darkgray;"></div> 20 21 <script> 22 function upload() { 23 // 1.准备FormData 24 var fd = new FormData(); 25 fd.append("myfile", $("#myfile")[0].files[0]); 26 27 // 创建xhr对象 28 var xhr = new XMLHttpRequest(); 29 30 31 // 监听状态,实时响应 32 // xhr 和 xhr.upload 都有progress事件,xhr.progress是下载进度,xhr.upload.progress是上传进度 33 xhr.upload.onprogress = function(event) { 34 if (event.lengthComputable) { 35 var percent = Math.round(event.loaded * 100 / event.total); 36 console.log('%d%', percent); 37 $("#upprog").text(percent); 38 } 39 }; 40 41 // 传输开始事件 42 xhr.onloadstart = function(event) { 43 console.log('load start'); 44 $("#upprog").text('开始上传'); 45 46 $("#stopbtn").one('click', function() { 47 xhr.abort(); 48 $(this).hide(); 49 }); 50 51 loading(true); 52 }; 53 54 // ajax过程成功完成事件 55 xhr.onload = function(event) { 56 console.log('load success'); 57 $("#upprog").text('上传成功'); 58 59 console.log(xhr.responseText); 60 var ret = JSON.parse(xhr.responseText); 61 addToFlist(ret.fname); 62 }; 63 64 // ajax过程发生错误事件 65 xhr.onerror = function(event) { 66 console.log('error'); 67 $("#upprog").text('发生错误'); 68 }; 69 70 // ajax被取消 71 xhr.onabort = function(event) { 72 console.log('abort'); 73 $("#upprog").text('操作被取消'); 74 }; 75 76 // loadend传输结束,不管成功失败都会被触发 77 xhr.onloadend = function (event) { 78 console.log('load end'); 79 loading(false); 80 }; 81 82 // 发起ajax请求传送数据 83 xhr.open('POST', '/upload3', true); 84 xhr.send(fd); 85 } 86 87 88 function addToFlist(fname) { 89 var temp = ["<p id='" + fname + "'>", 90 fname, 91 "<button onclick='delFile(\"" + fname + "\");'>删除</button>", 92 "</p>" 93 ]; 94 $("#flist").append(temp.join("")); 95 } 96 97 function delFile(fname) { 98 console.log('to delete file: ' + fname); 99 // TODO: 请实现 100 } 101 102 function loading(showloading) { 103 if (showloading) { 104 $("#uptxt").show(); 105 $("#stopbtn").show(); 106 } else { 107 $("#uptxt").hide(); 108 $("#stopbtn").hide(); 109 } 110 } 111 </script> 112 </body> 113 </html>
代码有点多,但是通俗易懂。使用过AJAX的人都知道,XHR对象提供了一个onreadystatechange的回调方法来监听整个请求/响应过程。在XMLHttpRequest2级规范中又多了几个进度事件。有以下6个事件:
1.loadstart: 在接收到响应数据的第一个字节时触发。
2.progress: 在接收响应期间持续不断地触发。
3.error: 在请求发生错误时触发。
4.abort: 在因为调用abort()方法而终止连接时触发。
5.load: 在接收到完整的响应数据时触发。
6.loadend: 在通信完成或者触发error,abort,load事件后触发。
这次我们可以解读代码:当传输事件开始后,我们便在停止传送按钮上添加点击事件,内置了abort方法可以停止传送。若不点则会正常上传直到传送完毕为止。其后台代码类似第二种方法。
三种方法各有优劣,做个简单的小结吧。
第三方控件交互性和可控性好,因为接近底层,其性能也是很优秀的。但是由于编写难度大通常需要自己安装插件,有时可能需要自己进行编写。
隐藏的iframe方法我个人觉得是非常有思想的一个方法,iframe可以帮我们做很多事。这种方式具有广泛的浏览器兼容性而且不需要安装插件。但是它交互性差,上传过程不可控,而且性能也是很一般的。
XHR2级的纯ajax上传,它必须要版本比较高一点的浏览器(ie9+)。但是它交互性特别好,可以看到上传进度并且是可控的。
开发可按需求来采用不同方法。个人觉得这些文件上传,特别是第二种提供的是一种思想,充分的利用了某些html标签的特性,可能是我们开发人员需要多思考的地方。