Vue项目中遇到了大文件分片上传的问题,之前用过webuploader,索性就把Vue2.0与webuploader结合起来使用,封装了一个vue的上传组件,使用起来也比较舒爽。
上传就上传吧,为什么搞得那么麻烦,用分片上传?
分片与并发结合,将一个大文件分割成多块,并发上传,极大地提高大文件的上传速度。
当网络问题导致传输错误时,只需要重传出错分片,而不是整个文件。另外分片传输能够更加实时的跟踪上传进度。
实现后的界面:
主要是两个文件,封装的上传组件和具体的ui页面,上传组件代码下面有列出来。这两个页面的代码放到github上了:https://github.com/shady-xia/Blog/tree/master/vue-webuploader。
在项目中引入webuploader
- 先在系统中引入jquery(插件基于jq,坑爹啊!),如果你不知道放哪,那就放到
index.html
中。 - 在官网上下载
Uploader.swf
和webuploader.min.js
,可以放到项目静态目录static
下面;在index.html
中引入webuploader.min.js。
(无需单独再引入webuploader.css
,因为没有几行css,我们可以复制到vue组件中。)
需要注意的点:
- 在vue组件中,通过
import './webuploader';
的方式引入webuploader,会报''caller', 'callee', and 'arguments' properties may not be accessed on strict mode ...'的错, 这是因为你的babel使用了严格模式,而caller这些在严格模式下禁止使用。所以可以直接在index.html中引入webuploader.js,或者手动去解决babel中'use strict'的问题。
基于webuploader封装Vue组件
封装好的组件upload.vue如下,接口可以根据具体的业务进行扩展。
注意:功能和ui分离,此组建封装好了基本的功能,没有提供ui,ui在具体的页面上去实现。
使用封装好的上传组件
新建页面,使用例子如下:
ui需要自己去实现。大概的代码可以点这里。
分片的原理及流程
当我们上传一个大文件时,会被插件分片,ajax请求如下:
- 多个upload请求均为分片的请求,把大文件分成多个小份一次一次向服务器传递
- 分片完成后,即upload完成后,需要向服务器传递一个merge请求,让服务器将多个分片文件合成一个文件
分片
可以看到发起了多次upload
的请求,我们来看看upload
发送的具体参数:
第一个配置(
content-disposition
)中的guid
和第二个配置中的access_token
,是我们通过webuploader配置里的formData
,即传递给服务器的参数
后面几个配置是文件内容,id、name、type、size等
其中chunks
为总分片数,chunk
为当前第几个分片。图片中分别为12和9。当你看到chunk是11的upload请求时,代表这是最后一个upload请求了。
合并
分片后,文件还未整合,数据大概是下面这个样子:
做完了分片后,其实工作还没完,我们还要再发送个ajax请求给服务器,告诉他把我们上传的几个分片合并成一个完整的文件。
我怎么知道分片上传完了,我在何时做合并?
webuploader插件有一个事件是uploadSuccess
,包含两个参数,file
和后台返回的response
;当所有分片上传完毕,该事件会被触发,
我们可以通过服务器返回的字段来判断是否要做合并了。
比如后台返回了needMerge
,我们看到它是true
的时候,就可以发送合并的请求了。
存在的已知问题
在做单文件暂停与继续上传时,发现了这个插件的bug:
1、当设置的threads>1
,使用单文件上传功能,即stop方法传入file时,会报错Uncaught TypeError: Cannot read property 'file' of undefined
出错的源码如下:这是因为暂停时为了让下一个文件继续传输,会将当前的pool池中pop掉暂停的文件流。这里做了循环,最后一次循环的时候,v是undefined的。
2、设置的threads为1,能正常暂停,但是暂停后再继续上传是失败的。
原理和上一个一样,暂停时把当前文件流在pool
中全部pop
了,当文件开始upload
的时候,会检查当期pool
,而此时已经没有之前暂停的文件流了。
如果是针对所有文件整体的暂停和继续,功能是正常的。
如果想实现单文件的暂停和继续功能,需要修改源码(我改了下源码,发现耦合度较高,工程量比想象的大,遂放弃)
后记
因为单文件暂停的bug,我最后放弃了这个插件,而且官方已经不再维护这个插件,github上issue成群,所以不太推荐大家用这个插件
后来我用vue-uploader(simple-uploader)无痛实现了文件分片上传、秒传及断点续传,大家想看的话我可以重新写一篇文章
这篇文章没有把一些知识点写全,其实思路是共通的:
1 在“加入文件”的回调中,通过FileReader读取文件,生成MD5,发给后台
2.1 如果后台直接返回了“跳过上传”字段和文件的url,则跳过上传,这是秒传;
2.2 如果后台返回了分片信息,这是断点续传。后台会在每个分片中标识这个分片是否上传过,你需要在分片上传校验的回调中判断,如果true则跳过该分片。
3 每个分片上传成功,后台都会返回一个字段判断是否需要合并;在“上传完成”的回调中,如果这个字段为true,则需要给后台发一个请求合并的ajax请求