JavaScript中三种异步上传文件方式
异步上传文件是为了更好的用户体验,是每个前端必须掌握的技能。这里我提出三点有关异步文件上传的方式。
使用第三方控件,如Flash,ActiveX等浏览器插件上传。
使用隐藏的iframe模拟异步上传。
使用XMLHttpRequest2来实现异步上传。
第一种使用浏览器插件上传,需要一定的底层编码功底,在这里我就不讲了,以免误人子弟,提出这点大家可以自行百度。
第二种使用隐藏的iframe模拟异步上传。为什么在这里说的是模拟呢?因为我们其实是将返回结果放在了一个隐藏的iframe中,所以才没有使当前页面跳转,感觉就像是异步操作一样。
先贴出代码:
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-"> <title>隐藏的iframe上传文件</title> <script type="text/javascript" src="jquery路径..."></script> </head> <body> <iframe name="frm" style="display:none"></iframe> <form action="/upload" enctype="multipart/form-data" method="post" target="frm" onsubmit="loading(true);"> <p id="upfile">附件: <input type="file" name="myfile" style="display: inline"></p> <p id="upbtn"><input style="padding-left:px;padding-right: px;" type="submit" value="异步上传"> <span id="uptxt" style="display: none">正在上传...</span></p> </form> <div id="flist" style="border:px dotted darkgray;"></div> <script> // 上传完成后的回调 function uploadFinished(fileName) { addToFlist(fileName); loading(false); } function addToFlist(fname) { var temp = ["<p id='" + fname + "'>", fname, "<button onclick='delFile(\"" + fname + "\");'>删除</button>", "</p>" ]; $("#flist").append(temp.join("")); } function loading(showloading) { if (showloading) { $("#uptxt").show(); } else { $("#uptxt").hide(); } } </script> </body> </html>
这种技术有两个关键的地方:
1.form会指定target,提交的结果定向返回到隐藏的ifram中。(即form的target与iframe的name属性一致)。
2.提交完成后,iframe中页面与主页面通信,通知上传结果及服务端文件信息
如何与主页面通信呢?
我们用nodejs在接收完了文件后返回了一个window.parent.主页面定义的方法,执行后可以得知文件上传完成。代码很简单:
router.post('/upload', multipartMiddleware, function(req, res) { var fpath = req.files.myfile.path; var fname = fpath.substr(fpath.lastIndexOf('\\') + ); setTimeout(function() { var ret = ["<script>", "window.parent.uploadFinished('" + fname + "');", "</script>"]; res.send(ret.join("")); }, ); });
执行后可以打开开发人员选项,你会发现隐藏iframe中返回了服务器的一些数据。
第三种使用XMLHttpRequest2来进行真正的异步上传。
还是先贴出代码:
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-"> <title>xhr level 异步上传</title> <script type="text/javascript" src="jquery路径..."></script> </head> <body> <div> <p id="upfile">附件: <input type="file" id="myfile" style="display: inline"></p> <p id="upbtn"> <input style="padding-left:px;padding-right: px;" type="button" value="异步上传" onclick="upload();"> <span id="uptxt" style="display: none">正在上传...</span> <span id="upprog"></span> <button id="stopbtn" style="display:none;">停止上传</button> </p> </div> <div id="flist" style="border:px dotted darkgray;"></div> <script> function upload() { // .准备FormData var fd = new FormData(); fd.append("myfile", $("#myfile")[].files[]); // 创建xhr对象 var xhr = new XMLHttpRequest(); // 监听状态,实时响应 // xhr 和 xhr.upload 都有progress事件,xhr.progress是下载进度,xhr.upload.progress是上传进度 xhr.upload.onprogress = function(event) { if (event.lengthComputable) { var percent = Math.round(event.loaded * / event.total); console.log('%d%', percent); $("#upprog").text(percent); } }; // 传输开始事件 xhr.onloadstart = function(event) { console.log('load start'); $("#upprog").text('开始上传'); $("#stopbtn").one('click', function() { xhr.abort(); $(this).hide(); }); loading(true); }; // ajax过程成功完成事件 xhr.onload = function(event) { console.log('load success'); $("#upprog").text('上传成功'); console.log(xhr.responseText); var ret = JSON.parse(xhr.responseText); addToFlist(ret.fname); }; // ajax过程发生错误事件 xhr.onerror = function(event) { console.log('error'); $("#upprog").text('发生错误'); }; // ajax被取消 xhr.onabort = function(event) { console.log('abort'); $("#upprog").text('操作被取消'); }; // loadend传输结束,不管成功失败都会被触发 xhr.onloadend = function (event) { console.log('load end'); loading(false); }; // 发起ajax请求传送数据 xhr.open('POST', '/upload', true); xhr.send(fd); } function addToFlist(fname) { var temp = ["<p id='" + fname + "'>", fname, "<button onclick='delFile(\"" + fname + "\");'>删除</button>", "</p>" ]; $("#flist").append(temp.join("")); } function delFile(fname) { console.log('to delete file: ' + fname); // TODO: 请实现 } function loading(showloading) { if (showloading) { $("#uptxt").show(); $("#stopbtn").show(); } else { $("#uptxt").hide(); $("#stopbtn").hide(); } } </script> </body> </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标签的特性,可能是我们开发人员需要多思考的地方。