zoukankan      html  css  js  c++  java
  • Vue2.0结合webuploader实现文件分片上传

    Vue项目中遇到了大文件分片上传的问题,之前用过webuploader,索性就把Vue2.0与webuploader结合起来使用,封装了一个vue的上传组件,使用起来也比较舒爽。

    上传就上传吧,为什么搞得那么麻烦,用分片上传?

    分片与并发结合,将一个大文件分割成多块,并发上传,极大地提高大文件的上传速度。
    当网络问题导致传输错误时,只需要重传出错分片,而不是整个文件。另外分片传输能够更加实时的跟踪上传进度。

    实现后的界面:

    主要是两个文件,封装的上传组件和具体的ui页面,上传组件代码下面有列出来。这两个页面的代码放到github上了:https://github.com/shady-xia/Blog/tree/master/vue-webuploader。

    在项目中引入webuploader

    1. 先在系统中引入jquery(插件基于jq,坑爹啊!),如果你不知道放哪,那就放到index.html中。
    2. 官网上下载Uploader.swf webuploader.min.js,可以放到项目静态目录static下面;在index.html中引入webuploader.min.js。
      (无需单独再引入webuploader.css,因为没有几行css,我们可以复制到vue组件中。)
    <script src="/static/lib/jquery-2.2.3.min.js"></script>
    <script src="/static/lib/webuploader/webuploader.min.js"></script>
    

    需要注意的点:

    1. 在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在具体的页面上去实现。

    <template>
        <div class="upload">
        </div>
    </template>
    
    <script>
    
        export default {
            name: 'vue-upload',
            props: {
                accept: {
                    type: Object,
                    default: null,
                },
                // 上传地址
                url: {
                    type: String,
                    default: '',
                },
                // 上传最大数量 默认为100
                fileNumLimit: {
                    type: Number,
                    default: 100,
                },
                // 大小限制 默认2M
                fileSingleSizeLimit: {
                    type: Number,
                    default: 2048000,
                },
                // 上传时传给后端的参数,一般为token,key等
                formData: {
                    type: Object,
                    default: null
                },
                // 生成formData中文件的key,下面只是个例子,具体哪种形式和后端商议
                keyGenerator: {
                    type: Function,
                    default(file) {
                        const currentTime = new Date().getTime();
                        const key = `${currentTime}.${file.name}`;
                        return key;
                    },
                },
                multiple: {
                    type: Boolean,
                    default: false,
                },
                // 上传按钮ID
                uploadButton: {
                    type: String,
                    default: '',
                },
            },
            data() {
                return {
                    uploader: null
                };
            },
            mounted() {
                this.initWebUpload();
            },
            methods: {
                initWebUpload() {
    
                    this.uploader = WebUploader.create({
                        auto: true, // 选完文件后,是否自动上传
                        swf: '/static/lib/webuploader/Uploader.swf',  // swf文件路径
                        server: this.url,  // 文件接收服务端
                        pick: {
                            id: this.uploadButton,     // 选择文件的按钮
                            multiple: this.multiple,   // 是否多文件上传 默认false
                            label: '',
                        },
                        accept: this.getAccept(this.accept),  // 允许选择文件格式。
                        threads: 3,
                        fileNumLimit: this.fileNumLimit, // 限制上传个数
                        //fileSingleSizeLimit: this.fileSingleSizeLimit, // 限制单个上传图片的大小
                        formData: this.formData,  // 上传所需参数
                        chunked: true,          //分片上传
                        chunkSize: 2048000,    //分片大小
                        duplicate: true,  // 重复上传
                    });
    
                    // 当有文件被添加进队列的时候,添加到页面预览
                    this.uploader.on('fileQueued', (file) => {
                        this.$emit('fileChange', file);
                    });
    
                    this.uploader.on('uploadStart', (file) => {
                        // 在这里可以准备好formData的数据
                        //this.uploader.options.formData.key = this.keyGenerator(file);
                    });
    
                    // 文件上传过程中创建进度条实时显示。
                    this.uploader.on('uploadProgress', (file, percentage) => {
                        this.$emit('progress', file, percentage);
                    });
    
                    this.uploader.on('uploadSuccess', (file, response) => {
                        this.$emit('success', file, response);
                    });
    
                    this.uploader.on('uploadError', (file, reason) => {
                        console.error(reason);
                        this.$emit('uploadError', file, reason);
                    });
    
                    this.uploader.on('error', (type) => {
                        let errorMessage = '';
                        if (type === 'F_EXCEED_SIZE') {
                            errorMessage = `文件大小不能超过${this.fileSingleSizeLimit / (1024 * 1000)}M`;
                        } else if (type === 'Q_EXCEED_NUM_LIMIT') {
                            errorMessage = '文件上传已达到最大上限数';
                        } else {
                            errorMessage = `上传出错!请检查后重新上传!错误代码${type}`;
                        }
    
                        console.error(errorMessage);
                        this.$emit('error', errorMessage);
                    });
    
                    this.uploader.on('uploadComplete', (file, response) => {
    
                        this.$emit('complete', file, response);
                    });
                },
    
                upload(file) {
                    this.uploader.upload(file);
                },
                stop(file) {
                    this.uploader.stop(file);
                },
                // 取消并中断文件上传
                cancelFile(file) {
                    this.uploader.cancelFile(file);
                },
                // 在队列中移除文件
                removeFile(file, bool) {
                    this.uploader.removeFile(file, bool);
                },
    
                getAccept(accept) {
                    switch (accept) {
                        case 'text':
                            return {
                                title: 'Texts',
                                exteensions: 'doc,docx,xls,xlsx,ppt,pptx,pdf,txt',
                                mimeTypes: '.doc,docx,.xls,.xlsx,.ppt,.pptx,.pdf,.txt'
                            };
                            break;
                        case 'video':
                            return {
                                title: 'Videos',
                                exteensions: 'mp4',
                                mimeTypes: '.mp4'
                            };
                            break;
                        case 'image':
                            return {
                                title: 'Images',
                                exteensions: 'gif,jpg,jpeg,bmp,png',
                                mimeTypes: '.gif,.jpg,.jpeg,.bmp,.png'
                            };
                            break;
                        default: return accept
                    }
                },
    
            },
        };
    </script>
    
    <style lang="scss">
    // 直接把官方的css粘过来就行了
    </style>
    
    

    使用封装好的上传组件

    新建页面,使用例子如下:

    ui需要自己去实现。大概的代码可以点这里

    <vue-upload
            ref="uploader"
            url="xxxxxx"
            uploadButton="#filePicker"
            multiple
            @fileChange="fileChange"
            @progress="onProgress"
            @success="onSuccess"
    ></vue-upload>
    

    分片的原理及流程

    当我们上传一个大文件时,会被插件分片,ajax请求如下:

    1. 多个upload请求均为分片的请求,把大文件分成多个小份一次一次向服务器传递
    2. 分片完成后,即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请求

  • 相关阅读:
    Hibernate Criteria用法大全
    hibernate数据库操作基础
    Hibernate中Session.get()方法和load()方法的详细比较
    3hibernate核心对象关系映射 xxx.hbm.xml
    2.Hibernate的主配置文件hibernate.cfg.xml
    PHP Switch 语句判断成绩
    PHP页面显示中文字符出现乱码
    windows7下GithubDesktop和极域学生客户端冲突导致无法正常打开解决方案
    关于js特效轮播图练习
    Docker报错总结
  • 原文地址:https://www.cnblogs.com/xiahj/p/8529545.html
Copyright © 2011-2022 走看看