文件上传插件SWFUpload的使用指南

前端之家收集整理的这篇文章主要介绍了文件上传插件SWFUpload的使用指南前端之家小编觉得挺不错的,现在分享给大家,也给大家做个参考。

SWFUpload是一个flash和js相结合而成的文件上传插件,其功能非常强大。以前在项目中用过几次,但它的配置参数太多了,用过后就忘记怎么用了,到以后要用时又得到官网上看它的文档,真是太烦了。所以索性就把它的用法记录下来,也方便英语拙计的同学查看,利人利己,一劳永逸。(ps:SWFUpload早就不再更新了,官网也打不开了,推荐大家使用Plupload来代替SWFUpload,Plupload以html5上传方式为主,在不支持html5的浏览器中会自动回退到flash的上传方式,功能灰常强大!使用方法可以看我写的《前端上传组件Plupload使用指南》)

SWFUpload的特点:

1、用flash进行上传页面无刷新,且可自定义Flash按钮的样式;

2、可以在浏览器端就对要上传文件进行限制;

3、允许一次上传多个文件,但会有一个上传队列,队列里文件上传是逐个进行的,服务器端接收文件时跟普通的表单上传文件是一样的;

4、提供了丰富的事件接口供开发者使用;

SWFUpload的文件上传流程是这样的:

1、引入相应的js文件

2、实例化SWFUpload对象,传入一个配置参数对象进行各方面的配置。

3、点击SWFUpload提供的Flash按钮,弹出文件选取窗口选择要上传文件

4、文件选取完成后符合规定的文件会被添加上传的队列里;

5、调用startUpload方法让队列里文件开始上传

6、文件上传过程中会触发相应的事件,开发者利用这些事件来更新ui、处理错误、发出提示等等;

SWFUpload包括三部分的内容:SWFUpload.js、swfupload.swf、初始化配置参数及各种事件处理函数。所以首先在页面引入SWFUpload.js

然后实例化一个SWFUpload对象:

PHP",flash_url : "http://www.swfupload.org/swfupload.swf",file_post_name : "Filedata",post_params : { "post_param_name_1" : "post_param_value_1","post_param_name_2" : "post_param_value_2","post_param_name_n" : "post_param_value_n" },use_query_string : false,requeue_on_error : false,http_success : [201,202],assume_success_timeout : 0,file_types : "*.jpg;*.gif",file_types_description: "Web Image Files",file_size_limit : "1024",file_upload_limit : 10,file_queue_limit : 2,debug : false,prevent_swf_caching : false,preserve_relative_urls : false,button_placeholder_id : "element_id",button_image_url : "http://www.swfupload.org/button_sprite.png",button_width : 61,button_height : 22,button_text : "Click ",button_text_style : ".redText { color: #FF0000; }",button_text_left_padding : 3,button_text_top_padding : 2,button_action : SWFUpload.BUTTON_ACTION.SELECT_FILES,button_disabled : false,button_cursor : SWFUpload.CURSOR.HAND,button_window_mode : SWFUpload.WINDOW_MODE.TRANSPARENT,swfupload_loaded_handler : swfupload_loaded_function,file_dialog_start_handler : file_dialog_start_function,file_queued_handler : file_queued_function,file_queue_error_handler : file_queue_error_function,file_dialog_complete_handler : file_dialog_complete_function,upload_start_handler : upload_start_function,upload_progress_handler : upload_progress_function,upload_error_handler : upload_error_function,upload_success_handler : upload_success_function,upload_complete_handler : upload_complete_function,debug_handler : debug_function,}; swfu = new SWFUpload(settings_object);//实例化一个SWFUpload,传入参数配置对象 }; /*定义各种事件监听函数*/ function swfupload_loaded_function(){} function file_dialog_start_function(){} ...等等

我们看到要实现一个swfupload上传功能很简单,就是实例化一个swfupload对象。但繁琐的地方就在于实例化实要用到的参数配置对象,以及各种事件的发生时机以和提供的参数。所以重点来了。下面几个表格对开发中要用到的东西列举了出来,虽然已经蛮多了,但并不是swfupload的全部,我列出来的只是常用的。要查看完整的文档,请到swfupload官网上查询

一、配置参数对象中的常用属性及说明

属性 upload_url上传文件的服务器端页面URL地址,可以是绝对地址,也可以是相对地址,当为相对地址时相对的是当前代码所在的文档地址preserve_relative_urls file_post_name 文件域上传文件时的name属性,服务器端接收页面通过该名称获取上传文件post_params 文件一起上传文件上传要附加一些信息时很有用use_query_string 属性定义的参数会以post方式上传;为true时,则会以get方式上传(即参数会以查询字符串的形式附加到url后面)file_types 属性指定了允许上传文件类型,当有多个类型时使用分号隔开,比如:*.jpg;*.png,允许所有类型时请使用 *.*file_types_description 文件选取窗口中显示文件类型描述,起一个提示和说明的作用吧file_size_limit 上传的文件的最大体积,可以带单位,合法的单位有:B、KB、MB、GB,如果省略了单位,则默认为KB。该属性为0时,表示不限制文件的大小。file_upload_limit 上传多少个文件,当上传成功的文件数量达到了这个最大值后,就不能再上传文件了,也不能往上传队列里添加文件了。把该属性设为0时表示不限制文件上传数量file_queue_limit 文件上传队列里最多能同时存放多少个文件。当超过了这个数目后只有当队列里有文件上传成功、上传出错或被取消上传后,等同数量的其他文件才可以被添加进来。当file_upload_limit的数值或者剩余的能上传文件数量小于file_queue_limit时,则取那个更小的值flash_url 文件的绝对或相对地址,相对地址是指相对于当前的页面地址。实例化swfupload后,就不能再改变该属性的值了。prevent_swf_caching 随机数在swfupload.swf地址的后面,以阻止flash影片被缓存,这是为了防止某些版本的IE浏览器在读取缓存的falsh影片时出现的bugbutton_placeholder_id button_placeholder button_image_url 图片,相对地址或绝对地址都可以。该地址会受到preserve_relative_urls属性的影响,遵从与upload_url一样的规则。 该背景图片必须是一个sprite图片,从上到下包含了Flash按钮的正常、鼠标悬停、按下、禁用这四种状态。因此该图片的高度应该是Flash按钮高度的四倍button_width button_height 图片高度的1/4button_text 文字,也可以是HTML代码button_text_style 文字的样式,使用方法见示例button_text_top_padding button_text_left_padding button_disabled button_cursor button_window_mode 属性,可用值为SWFUpload.WINDOW_MODE里定义的常量file_dialog_start_handler 函数file_queued_handler 函数file_queue_error_handler 函数file_dialog_complete_handler 函数upload_start_handler 函数upload_progress_handler 函数upload_error_handler 函数upload_success_handler 函数upload_complete_handler 函数

二、各种事件说明

要实现与用户的交互,靠的就是在这些事件上做文章

描述
fileDialogStart ( ) 文件选取窗口将要弹出时触发fileQueued (

file object

)文件被添加上传队列时会触发此事件,提供的唯一参数为包含该文件信息的file object对象fileQueueError (

file object,error code,message

)文件添加上传队列失败时触发此事件,失败的原因可能是文件大小超过了你允许的数值、文件是空的或者文件队列已经满员了等。 该事件提供了三个参数。第一个参数是当前出现问题的文件对象,第二个参数是具体的错误代码,可以参照SWFUpload.QUEUE_ERROR中定义的常量fileDialogComplete (

number of files selected,number of files queued,total number of files in the queued

)文件选取完毕且选取的文件经过处理后(指添加上传队列),会立即触发该事件。可以在该事件中调用this.startUpload()方法来实现文件自动上传 参数number of files selected指本次在文件选取框里选取的文件数量 参数number of files queued指本次被添加上传队列的文件数量 参数total number of files in the queued指当前上传队列里共有多少个文件包括了本次添加进去的文件)uploadStart (

file object

)文件即将上传时会触发该事件,该事件给了你在文件上传前的最后一次机会来验证文件信息、增加要随之上传的附加信息或做其他工作。可以通过返回false来取消本次文件上传 参数file object为当前要上传文件的信息对象uploadProgress (

file object,bytes complete,total bytes

)文件的上传过程中反复触发,可以利用该事件来实现上传进度条 参数file object为文件信息对象 参数bytes complete为当前已上传的字节数 参数total bytes为文件总的字节数uploadError (

file object,message

)文件上传被中断或是文件没有成功上传时会触发该事件。停止、取消文件上传或是在uploadStart事件中返回false都会引发这个事件,但是如果某个文件被取消了但仍然还在队列中则不会触发该事件 参数file object为文件信息对象 参数error code为错误代码,具体的可参照SWFUpload.UPLOAD_ERROR中定义的常量uploadSuccess (

file object,server data,received response

)文件上传成功后会触发该事件 参数file object为文件信息对象 参数server data为服务器端输出的数据uploadComplete(

file object

)文件上传的流程完成时(不管是成功的还是不成功的)会触发该事件,该事件表明本次上传已经完成,上传队列里的下一个文件可以开始上传了。该事件发生后队列中下一个文件上传将会开始

三、swfupload实例的方法

方法中大多数是动态改变参数配置对象的方法

destroy ( ) 方法来销毁它的实例和dom元素startUpload(

file_id

)上传队列中指定的文件 参数file_id代表要上传文件的id,如果未填写这个参数,则会上传队列中第一个文件cancelUpload (

file_id,trigger_error_event

)文件的上传 参数file_id为要取消的文件的id,如果该参数为undefined或者未填写,则会取消队列里的第一个文件 参数trigger_error_event接受一个布尔值,当为false时取消文件不会触发uploadError事件,默认为truestopUpload ( )上传的文件,会触发uploadError事件。如果当前没有文件上传,则该方法什么都不会做getStats ( )获取队列的stats objectsetStats (

stats_object

)修改队列的stats_object,传入修改过的stats_object作为参数getFile (

file_id|index

)文件id或文件索引来获取一个File Object,当使用文件id时只能获得队列里的文件,当使用文件索引时所有文件包括队列内和队列外)都可获得addPostParam (

name,value

)增加键/值对removePostParam (

name

)addFileParam (

file_id,name,value

)文件增加随之一起上传的附加信息。注意,只有在该指定的文件上传时,附加的信息才会一起上传。而配置对象中post_param设置的附加信息在任一文件上传时都会与之一起发送。 参数file_id为要指定的文件id,参数name和value分别为附加信息的名称和值removeFileParam (

file_id,name

)方法增加的附加信息,两个参数相信就不用我多讲了吧setUploadURL (

url

)setPostParams (

param_object

)属性的值,新的值会覆盖旧的值。 参数param_object必须为一个对象直接量,且里面的属性和值都只能为字符串setFileTypes (

types,description

)属性的值。两个参数都不能省略setFileSizeLimit (

file_size_limit

)属性的值setFileUploadLimit (

file_upload_limit

)属性的值setFileQueueLimit (

file_queue_limit

)属性的值setFilePostName (

file_post_name

)属性的值setUseQueryString (

use_query_string

)属性的值setButtonImageURL (

url

)属性的值setButtonDimensions (

width,height

)setButtonText (

text

)属性的值setButtonTextStyle (

css_style_text

)属性的值setButtonTextPadding (

left,top

)setButtonDisabled (

isDisabled

)setButtonCursor (

buttonCursor

)

四、文件信息对象 File Object

在事件监听函数中,经常要用到文件信息对象来获取文件的信息以供下一步的操作

属性 文件id,用来控制文件上传index 文件的索引,用在getFile(i)方法中name 文件的原始名称,不包括路径type 文件类型creationdate 文件的创建日期modificationdate 文件的最后修改日期filestatus 文件的状态,详细的请参照SWFUpload.FILE_STATUS中定义的常量

五、队列状态对象 Stats Object

用来获取当前队列的状况

id
属性 文件正在上传中files_queued 上传队列中的文件数量successful_uploads 上传(指触发了uploadSuccess事件)的文件数量upload_errors 上传失败的文件数量(包括被取消上传文件)upload_cancelled 上传的文件数量queue_errors 文件数量

六、一些常量

定义的一些常量,便于理解

in_progress
页面上所有的SWFUpload实例的引用的集合,用SWFUpload实例的movieName属性进行索引SWFUpload.movieCount 页面上存在的SWFUpload实例的数量 SWFUpload.QUEUE_ERROR.QUEUE_LIMIT_EXCEEDED 用户选取的文件超过了允许的数量SWFUpload.QUEUE_ERROR.FILE_EXCEEDS_SIZE_LIMIT 文件的体积超过了允许的大小SWFUpload.QUEUE_ERROR.ZERO_BYTE_FILE 文件是空的SWFUpload.QUEUE_ERROR.INVALID_FILETYPE 文件类型 SWFUpload.UPLOAD_ERROR.HTTP_ERROR SWFUpload.UPLOAD_ERROR.MISSING_UPLOAD_URL SWFUpload.UPLOAD_ERROR.IO_ERROR 文件时发生错误SWFUpload.UPLOAD_ERROR.SECURITY_ERROR 上传受到了安全方面的限制SWFUpload.UPLOAD_ERROR.UPLOAD_LIMIT_EXCEEDED 上传的文件数量超过了允许的最大值SWFUpload.UPLOAD_ERROR.UPLOAD_FAILED 上传出现错误SWFUpload.UPLOAD_ERROR.SPECIFIED_FILE_ID_NOT_FOUND 方法传入的文件id不存在SWFUpload.UPLOAD_ERROR.FILE_VALIDATION_FAILED 方法中返回了falseSWFUpload.UPLOAD_ERROR.FILE_CANCELLED 上传被取消了SWFUpload.UPLOAD_ERROR.UPLOAD_STOPPED 上传被终止了 SWFUpload.FILE_STATUS.QUEUED 文件正在队列中等待上传SWFUpload.FILE_STATUS.IN_PROGRESS 文件正在上传SWFUpload.FILE_STATUS.ERROR 文件在添加到队列或是上传的时候出现了错误SWFUpload.FILE_STATUS.COMPLETE 文件已上传成功SWFUpload.FILE_STATUS. 文件被取消上传 SWFUpload.CURSOR.ARROW 显示SWFUpload.CURSOR.HAND 显示 SWFUpload.WINDOW_MODE.WINDOW 显示在页面的所有dom元素上面SWFUpload.WINDOW_MODE.OPAQUE SWFUpload.WINDOW_MODE.TRANSPARENT 显示

内容太多了,感觉有点乱了,如果还不清楚怎么使用,建议看下官网的使用流程,明白怎么使用后再来看这些属性、事件、方法、常量什么的吧。

以上就是本文的全部内容,希望对大家有所帮助,同时也希望多多支持编程之家!

原文链接:https://www.f2er.com/js/44060.html

猜你在找的JavaScript相关文章

SWFUpload.instances