我以前写过一篇文章《文件上传利器》SWFUpload使用指南介绍了上传组件SWFUpload使用方法,但现在html5.逐步推广和普及技术,然后使用flash上传手段SWFUpload显然有点过时了。毕竟有点过时了。html5.原生文件上传给我们API。Plupload是因名而出的web编辑器TinyMCE我们可以使用团队开发的上传组件,简单易用,功能强大Plupload取代以前的SWFUpload。
1.有多种上传方式:HTML5、flash、silverlight以及传统的<input type=”file” />。Plupload自动检测当前环境,选择最合适的上传方式,优先使用HTML5的方式。因此,您不必担心当前浏览器支持哪些上传方式,Plupload自动为您选择最合适的方式。
2.支持上传选择要上传的文件
3.支持前端压缩图片,即在图片文件上传前压缩图片
4.可以直接读取原始文件数据,其优点是可以在上传图片文件之前在页面上显示预览
5.支持将大文件切割成小片上传,因为一些浏览器无法上传大文件,如几G。
1、引入js文件,plupload可以到达源文件github上去下载
2.实例化一个plupload对象,输入配置参数对象进行各方面的配置。
3、调用plupload实例对象的init()方法初始化
4、在plupload在实例对象上注册你需要的各种事件。plupload从选择文件到上传文件会触发很多事件。我们可以跟随这些事件plupload进行交互。
5.实现您注册的事件的监控函数,并使用这些监控函数更新UI、提示上传进度等工作。
你可以最基本地使用它——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上,你可以到Plupload查阅文档。
目录:
一、配置参数
二、各种事件说明
三、Plupload实例的属性
四、Plupload实例的方法
五、文件对象的属性和方法
六、QueueProgress 对象的属性
七、plupload命名空间中的一些属性
实例化一个plupload对象,即new plupload.Uploader()
,需要输入一个对象作为配置参数。以下内容出现plupload实例均是指new plupload.Uploader()
实例对象
属性 | 类型 | 默认值 | 描述 |
---|---|---|---|
browse_button | String / DOM | 触发文件选择对话框DOM点击元素后,弹出文件选择对话框。这个值可以是DOM元素本身也可以是DOM元素的id | |
url | String | 服务器端接收和处理上传文件的脚本地址可以是相对路径(与当前调用相比)Plupload也可以是绝对路径 | |
filters | Object | { } | 上传文件的类型制上传文件的类型和大小。该参数以对象的形式传输,包括三个属性: 限制上传文件的类型是一个数组,该数组的每个元素都是另一个对象,该对象有title和extensions两个属性,title过滤器的名称,extensions为文件扩展名称,有多个时间用逗号隔开。该属性默认为空数组,即无限制。 限制上传文件的大小。如果文件体积超过该值,则不能选择。值可以是一个数字,单位是b,也可以是由数字和单位组成的字符串,如200kb' 重复文件是否允许选择?true时表示不允许,为false默间表示允许,默认为false。如果两个文件的文件名称和大小相同,则将被视为重复文件 filters完整的配置示例如下: filters: { mime_types : [ //只允许上传图片和zip文件 { title : "Image files", extensions : "jpg,gif,png" }, { title : "Zip files", extensions : "zip" } ], max_file_size : '400kb', ///最大只能上传4000kb的文件 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个属性: 指定压缩后图片的宽度,如果没有设置该属性则默认为原始图片的宽度 指定压缩后图片的高度,如果没有设置该属性则默认为原始图片的高度 是否裁剪图片 压缩后图片的质量,只对jpg格式的图片有效,默认为90。 压缩后是否保留图片的元数据, 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上传方式会用到该参数。 |
要了解plupload的运行状况,靠的就是在这些事件了
Init |
---|
当Plupload初始化完成后触发 监听函数参数:
|
PostInit |
当Init事件发生后触发 监听函数参数:
|
OptionChanged |
当使用Plupload实例的setOption()方法改变当前配置参数后触发 监听函数参数:
|
Refresh |
当调用plupload实例的refresh()方法后会触发该事件,暂时不清楚还有什么其他动作会触发该事件,但据我测试,把文件添加到上传队列后也会触发该事件。 监听函数参数:
|
StateChanged |
当上传队列的状态发生改变时触发 监听函数参数:
|
UploadFile |
当上传队列中某一个文件开始上传后触发 监听函数参数:
|
BeforeUpload |
当队列中的某一个文件正要开始上传前触发 监听函数参数:
|
QueueChanged |
当上传队列发生变化后触发,即上传队列新增了文件或移除了文件。QueueChanged事件会比FilesAdded或FilesRemoved事件先触发 监听函数参数:
|
UploadProgress |
会在文件上传过程中不断触发,可以用此事件来显示上传进度 监听函数参数:
|
FilesRemoved |
当文件从上传队列移除后触发 监听函数参数:
|
FileFiltered |
暂不清楚该事件的意义,但根据测试得出,该事件会在每一个文件被添加到上传队列前触发 监听函数参数:
|
FilesAdded |
当文件添加到上传队列后触发 监听函数参数:
|
FileUploaded |
当队列中的某一个文件上传完成后触发 监听函数参数:
服务器返回的文本 服务器返回的头信息 服务器返回的http状态码,比如200 |
ChunkUploaded |
当使用文件小片上传功能时,每一个小片上传完成后触发 监听函数参数:
该文件小片在整体文件中的偏移量 服务器返回的文本 服务器返回的头信息 服务器返回的http状态码,比如200 该文件(指的是被切割成了许多文件小片的那个文件)的总大小,单位为字节 |
UploadComplete |
当上传队列中所有文件都上传完成后触发 监听函数参数:
|
Error |
当发生错误时触发 监听函数参数:
错误代码,具体请参考plupload上定义的表示错误代码的常量属性 与该错误相关的文件对象 错误信息 |
Destroy |
当调用destroy方法时触发 监听函数参数:
|
属性 | 描述 |
---|---|
id | Plupload实例的唯一标识id |
state | 当前的上传状态,可能的值为plupload.STARTED 或plupload.STOPPED ,该值由Plupload实例的stop() 或statr() 方法控制。默认为plupload.STOPPED |
runtime | 当前使用的上传方式 |
files | 当前的上传队列,是一个由上传队列中的文件对象组成的数组 |
settings | 当前的配置参数对象 |
total | 表示总体进度信息的QueueProgress对象 |
方法 | 描述 |
---|---|
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实例 |
在很多事件监听函数中,都会提供文件对象给你
属性/方法 | 描述 |
---|---|
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() | 销毁文件对象 |
plupload实例的total属性是一个QueueProgress对象
属性 | 描述 |
---|---|
size | 上传队列中所有文件加起来的总大小,单位为字节 |
loaded | 队列中当前已上传文件加起来的总大小,单位为字节 |
uploaded | 已完成上传的文件的数量 |
failed | 上传失败的文件数量 |
queued | 队列中剩下的(也就是除开已经完成上传的文件)需要上传的文件数量 |
percent | 整个队列的已上传百分比,如50就代表50% |
bytesPerSec | 上传速率,单位为 byte/s,也就是 字节/秒 |
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所能处理的最大值时的错误代码 |