|
本文主要介绍了文件上传插件SWFUpload使用指南,SWFUpload是一个flash和js相结合而成的文件上传插件，其功能非常强大。需要的朋友可以参考下
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
<script src='SWFUpload.js'></script>
然后实例化一个SWFUpload对象：
var swfu;
window.onload = function () {
var settings_object = {//定义参数配置对象
upload_url : "http://www.swfupload.org/upload.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 : "<b>Click</b> <span class="redText">here</span>",
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官网上查询。
一、配置参数对象中的常用属性及说明
二、各种事件说明
要实现与用户的交互，靠的就是在这些事件上做文章了
| 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, error code, 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 ( ) |
| 当不需要再使用SWFUpload了的时候,可以使用该方法来销毁它的实例和dom元素 |
| startUpload( file_id ) |
开始上传队列中指定的文件
参数file_id代表要上传的文件的id，如果未填写这个参数，则会上传队列中第一个文件 |
| cancelUpload ( file_id, trigger_error_event ) |
取消文件的上传
参数file_id为要取消的文件的id,如果该参数为undefined或者未填写，则会取消队列里的第一个文件
参数trigger_error_event接受一个布尔值，当为false时取消文件不会触发uploadError事件，默认为true |
| stopUpload ( ) |
| 终止当前正在上传的文件，会触发uploadError事件。如果当前没有文件在上传，则该方法什么都不会做 |
| getStats ( ) |
| 获取队列的stats object |
| setStats ( stats_object ) |
| 修改队列的stats_object，传入修改过的stats_object作为参数 |
| getFile ( file_id|index ) |
| 根据文件id或文件索引来获取一个File Object,当使用文件id时只能获得队列里的文件，当使用文件索引时所有文件（包括队列内和队列外）都可获得 |
| addPostParam ( name, value) |
| 往配置对象中post_params指定的附加信息对象中增加键/值对 |
| removePostParam ( name) |
| 移除置配置对象中的post_params包含的某一个键/值对，参数name为要移除的值的键名 |
| addFileParam ( file_id, name, value) |
为某个特定文件增加随之一起上传的附加信息。注意，只有在该指定的文件上传时，附加的信息才会一起上传。而配置对象中post_param设置的附加信息在任一文件上传时都会与之一起发送。
参数file_id为要指定的文件id,参数name和value分别为附加信息的名称和值 |
| removeFileParam ( file_id, name) |
| 移除通过addFileParam方法增加的附加信息，两个参数相信就不用我多讲了吧 |
| setUploadURL ( url) |
| 动态设置配置对象中upload_url的值 |
| setPostParams ( param_object) |
动态设置配置对象中post_params属性的值，新的值会覆盖旧的值。
参数param_object必须为一个对象直接量，且里面的属性和值都只能为字符串 |
| setFileTypes ( types, description) |
| 动态设置配置对象中file_types 和 file_types_description属性的值。两个参数都不能省略 |
| setFileSizeLimit ( file_size_limit) |
| 动态设置配置对象中file_size_limit属性的值 |
| setFileUploadLimit ( file_upload_limit) |
| 动态设置配置对象中file_upload_limit属性的值 |
| setFileQueueLimit ( file_queue_limit) |
| 动态设置配置对象中file_queue_limit属性的值 |
| setFilePostName ( file_post_name) |
| 动态设置配置对象中file_post_name属性的值 |
| setUseQueryString ( use_query_string) |
| 动态设置配置对象中use_query_string属性的值 |
| setButtonImageURL ( url) |
| 动态设置配置对象中button_image_url属性的值 |
| setButtonDimensions ( width, height) |
| 动态设置Flash按钮的宽度和高度，两个参数分别为宽度和高度的值，类型为数字，且不能带单位 |
| setButtonText ( text) |
| 动态设置配置对象中button_text属性的值 |
| setButtonTextStyle ( css_style_text) |
| 动态设置配置对象中button_text_style属性的值 |
| setButtonTextPadding ( left, top ) |
| 动态设置Flash按钮的左边内边距和顶部内边距 |
| setButtonDisabled ( isDisabled ) |
| 动态对Flash按钮进行禁用和不禁用的操作，参数为一个布尔值 |
| setButtonCursor ( buttonCursor ) |
| 动态设置配置对象中button_cursor的值 |
四、文件信息对象 File Object
在事件监听函数中，经常要用到文件信息对象来获取文件的信息以供下一步的操作
五、队列状态对象 Stats Object
用来获取当前队列的状况
六、一些常量
定义的一些常量，便于理解
内容太多了，感觉有点乱了，如果还不清楚怎么使用，建议看下官网的使用流程，明白怎么使用后再来看这些属性、事件、方法、常量什么的吧。
以上就是本文的全部内容，希望对大家有所帮助，同时也希望多多支持脚本之家！ |
发表于 2016-11-29 14:39:13
