前端上传组件Plupload使用指南（转发）

时间  2019-12-12
标签 前端 上传 组件 plupload 使用 指南 转发 繁體版
原文   原文链接

我以前写过一篇文章《文件上传利器SWFUpload使用指南》，里面介绍了上传组件SWFUpload的使用方法，但如今随着html5技术的逐渐推广和普及，再去使用以flash为上传手段的SWFUpload显然就有点过期了，毕竟html5原生的就给咱们提供了文件上传的API。Plupload是一款由著名的web编辑器TinyMCE团队开发的上传组件，简单易用且功能强大，咱们彻底可使用Plupload来代替之前的SWFUpload。php

Plupload有如下功能和特色：html

一、拥有多种上传方式：HTML五、flash、silverlight以及传统的<input type=”file” />。Plupload会自动侦测当前的环境，选择最合适的上传方式，而且会优先使用HTML5的方式。因此你彻底不用去操心当前的浏览器支持哪些上传方式，Plupload会自动为你选择最合适的方式。前端

二、支持以拖拽的方式来选取要上传的文件html5

三、支持在前端压缩图片，即在图片文件还未上传以前就对它进行压缩ios

四、能够直接读取原生的文件数据，这样的好处就是例如能够在图片文件还未上传以前就能把它显示在页面上预览git

五、支持把大文件切割成小片进行上传，由于有些浏览器对很大的文件好比几G的一些文件没法上传。github

 

Plupload的使用方法也与SWFUpload很是相似，能够分为如下几步：web

一、引入js文件，plupload的源文件能够到github上去下载api

二、实例化一个plupload对象，传入一个配置参数对象进行各方面的配置。数组

三、调用plupload实例对象的init()方法进行初始化

四、在plupload实例对象上注册各类你须要的事件。plupload从选取文件到文件上传完成这个过程当中，会触发不少事件。咱们能够经过这些事件来跟plupload进行交互。

五、实现你本身所注册的那些事件的监听函数，利用这些监听函数来进行更新UI、提示上传进度等工做。

你们能够到http://chaping.github.io/plupload/demo/看一下我写的关于plupload的几个上传demo。

下面用一段代码来讲明Plupload的使用方法。

首先看下个人目录结构

目录结构

index.html的代码以下：

复制代码

<!DOCTYPE html>
<html>
<head>
    <meta charset="UTF-8">
    <title>Plupload使用指南</title>
    <!-- 首先须要引入plupload的源代码 -->
    <script src="js/plupload.full.min.js"></script>
</head>
<body>
    <!-- 这里咱们只使用最基本的html结构：一个选择文件的按钮，一个开始上传文件的按钮(甚至该按钮也能够不要) -->
    <p>
        <button id="browse">选择文件</button>
        <button id="start_upload">开始上传</button>
    </p>
    <script>

    //实例化一个plupload上传对象
    var uploader = new plupload.Uploader({
        browse_button : 'browse', //触发文件选择对话框的按钮，为那个元素id
        url : 'upload.php', //服务器端的上传页面地址
        flash_swf_url : 'js/Moxie.swf', //swf文件，当须要使用swf方式进行上传时须要配置该参数
        silverlight_xap_url : 'js/Moxie.xap' //silverlight文件，当须要使用silverlight方式进行上传时须要配置该参数
    });    

    //在实例对象上调用init()方法进行初始化
    uploader.init();

    //绑定各类事件，并在事件监听函数中作你想作的事
    uploader.bind('FilesAdded',function(uploader,files){
        //每一个事件监听函数都会传入一些颇有用的参数，
        //咱们能够利用这些参数提供的信息来作好比更新UI，提示上传进度等操做
    });
    uploader.bind('UploadProgress',function(uploader,file){
        //每一个事件监听函数都会传入一些颇有用的参数，
        //咱们能够利用这些参数提供的信息来作好比更新UI，提示上传进度等操做
    });
    //......
    //......

    //最后给"开始上传"按钮注册事件
    document.getElementById('start_upload').onclick = function(){
        uploader.start(); //调用实例对象的start()方法开始上传文件，固然你也能够在其余地方调用该方法
    }

    </script>
</body>
</html>

复制代码

 

使用Plupload的关键是了解它众多的配置参数、事件以及属性和方法。我把它官网上的文档翻译成了中文并整理以下。我也把它放到了github上，你能够到http://chaping.github.io/plupload/doc/去查阅。

目录：

1、配置参数

2、各类事件说明

3、Plupload实例的属性

4、Plupload实例的方法

5、文件对象的属性和方法

6、QueueProgress 对象的属性

7、plupload命名空间上的一些属性

1、配置参数

实例化一个plupload对象时，也就是 new plupload.Uploader()，须要传入一个对象做为配置参数。后面内容中出现的plupload实例均是指new plupload.Uploader()获得的实例对象

属性 类型 默认值 描述
browse_button String / DOM   触发文件选择对话框的DOM元素，当点击该元素后便后弹出文件选择对话框。该值能够是DOM元素对象自己，也能够是该DOM元素的id
url String   服务器端接收和处理上传文件的脚本地址，能够是相对路径(相对于当前调用Plupload的文档)，也能够是绝对路径
filters Object { } 可使用该参数来限制上传文件的类型，大小等，该参数以对象的形式传入，它包括三个属性：

mime_types：用来限定上传文件的类型，为一个数组，该数组的每一个元素又是一个对象，该对象有title和extensions两个属性，title为该过滤器的名称，extensions为文件扩展名，有多个时用逗号隔开。该属性默认为一个空数组，即不作限制。

max_file_size：用来限定上传文件的大小，若是文件体积超过了该值，则不能被选取。值能够为一个数字，单位为b,也能够是一个字符串，由数字和单位组成，如'200kb'

prevent_duplicates：是否容许选取重复的文件，为true时表示不容许，为false时表示容许，默认为false。若是两个文件的文件名和大小都相同，则会被认为是重复的文件

filters完整的配置示例以下(固然也能够只配置其中的某一项)：

filters: {
  mime_types : [ //只容许上传图片和zip文件
    { title : "Image files", extensions : "jpg,gif,png" }, 
    { title : "Zip files", extensions : "zip" }
  ],
  max_file_size : '400kb', //最大只能上传400kb的文件
  prevent_duplicates : true //不容许选取重复文件
}
headers Object   设置上传时的自定义头信息，以键/值对的形式传入，键表明头信息属性名，键表明属性值。html4上传方式不支持设置该属性。
multipart Boolean true 为true时将以multipart/form-data的形式来上传文件，为false时则以二进制的格式来上传文件。html4上传方式不支持以二进制格式来上传文件，在flash上传方式中，二进制上传也有点问题。而且二进制格式上传还须要在服务器端作特殊的处理。通常咱们用multipart/form-data的形式来上传文件就足够了。
multipart_params Object   上传时的附加参数，以键/值对的形式传入，服务器端但是使用$_POST来获取这些参数(以php为例)。好比： 
multipart_params: {
  one: '1',
  two: '2',
  three: { //值还能够是一个字面量对象
    a: '4',
    b: '5'
  },
  four: ['6', '7', '8']  //也能够是一个数组
}
max_retries Number 0 当发生plupload.HTTP_ERROR错误时的重试次数，为0时表示不重试
chunk_size Number/String 0 分片上传文件时，每片文件被切割成的大小，为数字时单位为字节。也可使用一个带单位的字符串，如"200kb"。当该值为0时表示不使用分片上传功能
resize Object   可使用该参数对将要上传的图片进行压缩，该参数是一个对象，里面包括5个属性：

width：指定压缩后图片的宽度，若是没有设置该属性则默认为原始图片的宽度

height：指定压缩后图片的高度，若是没有设置该属性则默认为原始图片的高度

crop：是否裁剪图片

quality：压缩后图片的质量，只对jpg格式的图片有效，默认为90。quality能够跟width和height一块儿使用，但也能够单独使用，单独使用时，压缩后图片的宽高不会变化，但因为质量下降了，因此体积也会变小

preserve_headers：压缩后是否保留图片的元数据，true为保留，false为不保留,默认为true。删除图片的元数据能使图片的体积减少一点点

resize参数的配置示例以下：

resize: {
  width: 100,
  height: 100,
  crop: true,
  quality: 60,
  preserve_headers: false
}
drop_element DOM/String/Array   指定了使用拖拽方式来选择上传文件时的拖拽区域，便可以把文件拖拽到这个区域的方式来选择文件。该参数的值能够为一个DOM元素的id,也但是DOM元素自己，还能够是一个包括多个DOM元素的数组。若是不设置该参数则拖拽上传功能不可用。目前只有html5上传方式才支持拖拽上传。
multi_selection Boolean true 是否能够在文件浏览对话框中选择多个文件，true为能够，false为不能够。默认true，便可以选择多个文件。须要注意的是，在某些不支持多选文件的环境中，默认值是false。好比在ios7的safari浏览器中，因为存在bug，形成不能多选文件。固然，在html4上传方式中，也是没法多选文件的。
required_features Mix   可使用该参数来设置你必须须要的一些功能特征，Plupload会根据你的设置来选择合适的上传方式。由于，不一样的上传方式，支持的功能是不一样的，好比拖拽上传只有html5上传方式支持，图片压缩则只有html5,flash,silverlight上传方式支持。该参数的值是一个混合类型，能够是一个以逗号分隔的字符串，
unique_names Boolean false 当值为true时会为每一个上传的文件生成一个惟一的文件名，并做为额外的参数post到服务器端，参数明为name,值为生成的文件名。
runtimes String html5,flash,
silverlight,
html4		 用来指定上传方式，指定多个上传方式请使用逗号隔开。通常状况下，你不须要配置该参数，由于Plupload默认会根据你的其余的参数配置来选择最合适的上传方式。若是没有特殊要求的话，Plupload会首先选择html5上传方式，若是浏览器不支持html5，则会使用flash或silverlight，若是前面二者也都不支持，则会使用最传统的html4上传方式。若是你想指定使用某个上传方式，或改变上传方式的优先顺序，则你能够配置该参数。
file_data_name String file 指定文件上传时文件域的名称，默认为file,例如在php中你可使用$_FILES['file']来获取上传的文件信息
container DOM/String   用来指定Plupload所建立的html结构的父容器，默认为前面指定的browse_button的父元素。该参数的值能够是一个元素的id,也能够是DOM元素自己。
flash_swf_url String js/Moxie.swf flash上传组件的url地址，若是是相对路径，则相对的是调用Plupload的html文档。当使用flash上传方式会用到该参数。
silverlight_xap_url String js/Moxie.xap silverlight上传组件的url地址，若是是相对路径，则相对的是调用Plupload的html文档。当使用silverlight上传方式会用到该参数。

2、各类事件说明

要了解plupload的运行情况，靠的就是在这些事件了

Init
当Plupload初始化完成后触发

监听函数参数：(uploader)

uploader为当前的plupload实例对象
PostInit
当Init事件发生后触发

监听函数参数：(uploader)

uploader为当前的plupload实例对象
OptionChanged
当使用Plupload实例的setOption()方法改变当前配置参数后触发

监听函数参数：(uploader,option_name,new_value,old_value)

uploader为当前的plupload实例对象，option_name为发生改变的参数名称，new_value为改变后的值，old_value为改变前的值
Refresh
当调用plupload实例的refresh()方法后会触发该事件，暂时不清楚还有什么其余动做会触发该事件，但据我测试，把文件添加到上传队列后也会触发该事件。

监听函数参数：(uploader)

uploader为当前的plupload实例对象
StateChanged
当上传队列的状态发生改变时触发

监听函数参数：(uploader)

uploader为当前的plupload实例对象
UploadFile
当上传队列中某一个文件开始上传后触发

监听函数参数：(uploader,file)

uploader为当前的plupload实例对象，file为触发此事件的文件对象
BeforeUpload
当队列中的某一个文件正要开始上传前触发

监听函数参数：(uploader,file)

uploader为当前的plupload实例对象，file为触发此事件的文件对象
QueueChanged
当上传队列发生变化后触发，即上传队列新增了文件或移除了文件。QueueChanged事件会比FilesAdded或FilesRemoved事件先触发

监听函数参数：(uploader)

uploader为当前的plupload实例对象
UploadProgress
会在文件上传过程当中不断触发，能够用此事件来显示上传进度

监听函数参数：(uploader,file)

uploader为当前的plupload实例对象，file为触发此事件的文件对象
FilesRemoved
当文件从上传队列移除后触发

监听函数参数：(uploader,files)

uploader为当前的plupload实例对象，files为一个数组，里面的元素为本次事件所移除的文件对象
FileFiltered
暂不清楚该事件的意义，但根据测试得出，该事件会在每个文件被添加到上传队列前触发

监听函数参数：(uploader,file)

uploader为当前的plupload实例对象，file为触发此事件的文件对象
FilesAdded
当文件添加到上传队列后触发

监听函数参数：(uploader,files)

uploader为当前的plupload实例对象，files为一个数组，里面的元素为本次添加到上传队列里的文件对象
FileUploaded
当队列中的某一个文件上传完成后触发

监听函数参数：(uploader,file,responseObject)

uploader为当前的plupload实例对象，file为触发此事件的文件对象，responseObject为服务器返回的信息对象，它有如下3个属性：

response：服务器返回的文本

responseHeaders：服务器返回的头信息

status：服务器返回的http状态码，好比200
ChunkUploaded
当使用文件小片上传功能时，每个小片上传完成后触发

监听函数参数：(uploader,file,responseObject)

uploader为当前的plupload实例对象，file为触发此事件的文件对象，responseObject为服务器返回的信息对象，它有如下5个属性：

offset：该文件小片在总体文件中的偏移量

response：服务器返回的文本

responseHeaders：服务器返回的头信息

status：服务器返回的http状态码，好比200

total：该文件(指的是被切割成了许多文件小片的那个文件)的总大小，单位为字节
UploadComplete
当上传队列中全部文件都上传完成后触发

监听函数参数：(uploader,files)

uploader为当前的plupload实例对象，files为一个数组，里面的元素为本次已完成上传的全部文件对象
Error
当发生错误时触发

监听函数参数：(uploader,errObject)

uploader为当前的plupload实例对象，errObject为错误对象，它至少包含如下3个属性(由于不一样类型的错误，属性可能会不一样)：

code：错误代码，具体请参考plupload上定义的表示错误代码的常量属性

file：与该错误相关的文件对象

message：错误信息
Destroy
当调用destroy方法时触发

监听函数参数：(uploader)

uploader为当前的plupload实例对象

3、Plupload实例的属性

属性 描述
id Plupload实例的惟一标识id
state 当前的上传状态，可能的值为plupload.STARTED或plupload.STOPPED，该值由Plupload实例的stop()或statr()方法控制。默认为plupload.STOPPED
runtime 当前使用的上传方式
files 当前的上传队列，是一个由上传队列中的文件对象组成的数组
settings 当前的配置参数对象
total 表示整体进度信息的QueueProgress对象

4、Plupload实例的方法

方法 描述
init() 初始化Plupload实例
setOption(option, [value]) 设置某个特定的配置参数,option为参数名称，value为要设置的参数值。option也能够为一个由参数名和参数值键/值对组成的对象，这样就能够一次设定多个参数，此时该方法的第二个参数value会被忽略。
getOption([option]) 获取当前的配置参数，参数option为须要获取的配置参数名称，若是没有指定option，则会获取全部的配置参数
refresh() 刷新当前的plupload实例，暂时还不明白何时须要使用
start() 开始上传队列中的文件
stop() 中止队列中的文件上传
disableBrowse(disable) 禁用或启用plupload的文件浏览按钮,参数disable为true时为禁用，为false时为启用。默认为true
getFile(id) 经过id来获取文件对象
addFile(file, [fileName]) 向上传队列中添加文件，若是成功添加了文件，会触发FilesAdded事件。参数file为要添加的文件,能够是一个原生的文件,或者一个plupload文件对象,或者一个input[type="file"]元素,还能够是一个包括前面那几种东西的数组；fileName为给该文件指定的名称
removeFile(file) 从上传队列中移除文件，参数file为plupload文件对象或先前指定的文件名称
splice(start, length) 从上传队列中移除一部分文件，start为开始移除文件在队列中的索引，length为要移除的文件的数量，该方法的返回值为被移除的文件。该方法会触发FilesRemoved 和QueueChanged事件
trigger(name, Multiple) 触发某个事件。name为要触发的事件名称，Multiple为传给该事件监听函数的参数，是一个对象
hasEventListener(name) 用来判断某个事件是否有监听函数，name为事件名称
bind(name, func, scope) 给某个事件绑定监听函数，name为事件名，func为监听函数，scope为监听函数的做用域，也就是监听函数中this的指向
unbind(name, func) 移除事件的监听函数，name为事件名称，func为要移除的监听函数
unbindAll() 移除全部事件的全部监听函数
destroy() 销毁plupload实例

5、文件对象的属性和方法

在不少事件监听函数中，都会提供文件对象给你

属性/方法 描述
id 文件id
name 文件名，例如"myfile.gif"
type 文件类型，例如"image/jpeg"
size 文件大小，单位为字节，当启用了客户端压缩功能后，该值可能会改变
origSize 文件的原始大小，单位为字节
loaded 文件已上传部分的大小，单位为字节
percent 文件已上传部分所占的百分比，如50就表明已上传了50%
status 文件的状态，可能为如下几个值之一：plupload.QUEUED, plupload.UPLOADING, plupload.FAILED, plupload.DONE
lastModifiedDate 文件最后修改的时间
getNative() 获取原生的文件对象
getSource() 获取mOxie.File 对象，想了解mOxie是什么东西，能够看下https://github.com/moxiecode/moxie/wiki/API
destroy() 销毁文件对象

6、QueueProgress 对象的属性

plupload实例的total属性是一个QueueProgress对象

属性 描述
size 上传队列中全部文件加起来的总大小，单位为字节
loaded 队列中当前已上传文件加起来的总大小,单位为字节
uploaded 已完成上传的文件的数量
failed 上传失败的文件数量
queued 队列中剩下的(也就是除开已经完成上传的文件)须要上传的文件数量
percent 整个队列的已上传百分比，如50就表明50%
bytesPerSec 上传速率，单位为 byte/s，也就是 字节/秒

7、plupload命名空间上的一些属性

plupload的命名空间上有一些属性，用来表示一些常量。记住，不是plupload实例的属性，而是plupload的属性

属性名称 描述
VERSION 当前plupload的版本号
STOPPED 值为1，表明上传队列还未开始上传或者上传队列中的文件已经上传完毕时plupload实例的state属性值
STARTED 值为2，表明队列中的文件正在上传时plupload实例的state属性值
QUEUED 值为1，表明某个文件已经被添加进队列等待上传时该文件对象的status属性值
UPLOADING 值为2，表明某个文件正在上传时该文件对象的status属性值
FAILED 值为4，表明某个文件上传失败后该文件对象的status属性值
DONE 值为5，表明某个文件上传成功后该文件对象的status属性值
GENERIC_ERROR 值为-100，发生通用错误时的错误代码
HTTP_ERROR 值为-200，发生http网络错误时的错误代码，例如服务气端返回的状态码不是200
IO_ERROR 值为-300，发生磁盘读写错误时的错误代码，例如本地上某个文件不可读
SECURITY_ERROR 值为-400，发生由于安全问题而产生的错误时的错误代码
INIT_ERROR 值为-500，初始化时发生错误的错误代码
FILE_SIZE_ERROR 值为-600，当选择的文件太大时的错误代码
FILE_EXTENSION_ERROR 值为-601，当选择的文件类型不符合要求时的错误代码
FILE_DUPLICATE_ERROR 值为-602，当选取了重复的文件而配置中又不容许有重复文件时的错误代码
IMAGE_FORMAT_ERROR 值为-700，发生图片格式错误时的错误代码
IMAGE_MEMORY_ERROR 当发生内存错误时的错误代码
IMAGE_DIMENSIONS_ERROR 值为-702，当文件大小超过了plupload所能处理的最大值时的错误代码
相关文章
相关标签/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公众号
   欢迎关注本站公众号,获取更多信息
联系我们 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程