jQuery上傳插件Uploadify使用幫助

時間 2019-11-24

標籤 jquery 上傳插件 uploadify 使用幫助欄目 JQuery 简体版

原文原文鏈接

Uploadify是JQuery的一個上傳插件，實現的效果很是不錯，帶進度顯示。它的功能特點總結以下：javascript

支持單文件或多文件上傳，可控制併發上傳的文件數
在服務器端支持各類語言與之配合使用，諸如PHP,.NET,Java……
經過參數可配置上傳文件類型及大小限制
經過參數可配置是否選擇文件後自動上傳
易於擴展，可控制每一步驟的回調函數（onSelect, onCancel……）
經過接口參數和CSS控制外觀

使用幫助：php

官網地址：http://www.uploadify.com/ css

官方參數配置文檔：http://www.uploadify.com/documentation/ html

官方下載地址：http://www.uploadify.com/download/java

使用方法：jquery

官網下載插件安裝包，添加必要文件（加紅點的）到項目中；若是是.net 可使用Nuget命令在項目中安裝：Install-Package Uploadfy
2. 主要文件介紹：jquery.uploadify.js（完成上傳功能的腳本文件，在調用頁面引用，min是壓縮版）、uploadify.css（外觀樣式表）、uploader.swf（上傳控件的主體文件，flash控件）、uploadify-cancel.png（關閉按鈕的小圖片），其餘的文件都不是必須的，能夠忽略。

頁面添加引用：

    <link href="~/Scripts/uploadify/uploadify.css" rel="stylesheet" />
    <script src="~/Scripts/jquery-1.8.2.min.js"></script>
    <script src="~/Scripts/uploadify/jquery.uploadify-3.2.min.js"></script>

頁面標籤： <input id="uploadfy" type="file" name="uploadfy"/>

調用Uploadfy綁定上傳事件：

    <script>
        $(function() {
            $("#uploadfy").uploadify({
                'swf': '/Scripts/uploadify/uploadify.swf',//uploadify.swf 文件的路徑（絕對路徑、相對路徑均可以）
                uploader: '/Home/File',//服務器響應地址
                cancelImg: '/Scripts/uploadify/uploadify-cancel.png',//關閉按鈕圖片路徑
                multi: true,//是否多文件
                auto:true,//是否自動上傳，true，選擇文件後上傳，false，點擊上傳開始上傳，默認true
                buttonText: "上傳文件",//空間名稱
                preventCaching: false,//是否緩存
                fileSizeLimit: 1024 * 1024 * 10,//單個文件限制大小
                fileTypeDesc: '*.jpg;*.png;*.doc;*.txt;*.zip;*.rar;',//文件後綴描述
                fileTypeExts: '*.jpg;*.png;*.doc;*.txt;*.zip;*.rar;',//文件後綴限制
                height: 20,//高度
                onUploadSuccess: function (file, data, response) {//上傳成功後事件
                    if (data == "success") {//data 返回值本身在後端自定義
                        //本身的代碼
                    }
                }
            });

        });
    </script>

服務端，和普通上傳文件同樣，沒什麼特別的，就略去了；後端

Uploadfy的屬性以、事件和方法介紹：瀏覽器

**1、屬性**
屬性名稱	默認值	說明
auto	true	設置爲true當選擇文件後就直接上傳了，爲false須要點擊上傳按鈕才上傳。
buttonClass	」	按鈕樣式
buttonCursor	‘hand’	鼠標指針懸停在按鈕上的樣子
buttonImage	null	瀏覽按鈕的圖片的路徑。
buttonText	‘SELECT FILES’	瀏覽按鈕的文本。
checkExisting	false	文件上傳重複性檢查程序，檢查即將上傳的文件在服務器端是否已存在，存在返回1，不存在返回0
debug	false	若是設置爲true則表示啓用SWFUpload的調試模式
fileObjName	‘Filedata’	文件上傳對象的名稱，若是命名爲’the_files’，PHP程序能夠用$_FILES['the_files']來處理上傳的文件對象。
fileSizeLimit	0	上傳文件的大小限制，若是爲整數型則表示以KB爲單位的大小，若是是字符串，緩存則可使用(B, KB, MB, or GB)爲單位，好比’2MB’；服務器若是設置爲0則表示無限制
fileTypeDesc	‘All Files’	這個屬性值必須設置fileTypeExts屬性後纔有效，用來設置選擇文件對話框中的提示文本，如設置fileTypeDesc爲「請選擇rar doc pdf文件」
fileTypeExts	‘.’	設置能夠選擇的文件的類型，格式如：’.doc;.pdf;*.rar’ 。
formData		JSON格式上傳每一個文件的同時提交到服務器的額外數據，可在’onUploadStart’事件中使用’settings’方法動態設置。
height	30	設置瀏覽按鈕的高度，默認值
itemTemplate	false	用於設置上傳隊列的HTML模版，可使用如下標籤： instanceID – Uploadify實例的ID fileID – 列隊中此文件的ID, 或者理解爲此任務的ID fileName – 文件的名稱 fileSize – 當前上傳文件的大小插入模版標籤時使用格式如：${fileName}
method	Post	提交方式Post或Get
multi	true	設置爲true時能夠上傳多個文件。
overrideEvents		設置哪些事件能夠被重寫，JSON格式，如：’overrideEvents’ : ['onUploadProgress']
preventCaching	true	若是爲true，則每次上傳文件時自動加上一串隨機字符串參數，防止URL緩存影響上傳結果
progressData	‘percentage’	設置上傳進度顯示方式，percentage顯示上傳百分比，speed顯示上傳速度
queueID	false	設置上傳隊列容器DOM元素的ID，若是爲false則自動生成一個隊列容器。
queueSizeLimit	999	隊列最多顯示的任務數量，若是選擇的文件數量超出此限制，將會出發onSelectError事件。注意此項並不是最大文件上傳數量，若是要限制最大上傳文件數量，應設置uploadLimit。
removeCompleted	true	是否自動將已完成任務從隊列中刪除，若是設置爲false則會一直保留此任務顯示。
removeTimeout	3	若是設置了任務完成後自動從隊列中移除，則能夠規定從完成到被移除的時間間隔。
requeueErrors	false	若是設置爲true，則單個任務上傳失敗後將返回錯誤，並從新加入任務隊列上傳。
successTimeout	30	文件上傳成功後服務端應返回成功標誌，此項設置返回結果的超時時間
swf	‘uploadify.swf’	uploadify.swf 文件的相對路徑。
uploader	uploadify.php	後臺處理程序的相對路徑。
uploadLimit	999	最大上傳文件數量，若是達到或超出此限制將會觸發onUploadError事件。
width	120	設置文件瀏覽按鈕的寬度。

**2、事件**
事件名稱	說明
onCancel(file)	當點擊文件隊列中文件的關閉按鈕或點擊取消上傳時觸發，file參數爲被取消上傳的文件對象
onClearQueue(queueItemCount)	當調用函數cancel方法時觸發，queueItemCount參數爲被取消上傳的文件數量。
onDestroy()	當destory方法被調用時觸發
onDialogClose(queueData)	當文件瀏覽框關閉時觸發，若是將此事件被重寫，則當向隊列添加文件上傳出錯時不會彈出錯誤消息提示。 queueData對象包含以下屬性： filesSelected 文件選擇對話框中共選擇了多少個文件 filesQueued 已經向隊列中添加了多少個文件 filesReplaced 已經向隊列中替換了多少個文件 filesCancelled 取消了多少個文件 filesErrored 出錯了多少個文件
onDialogOpen()	當文件選擇對話框彈出時當即出發，但可能在文件選擇對話框被關閉以前並不能所有執行。
onDisable()	當disable方法禁用Uploadify上傳按鈕時被調用時觸發。
onEnable()	當disable方法啓用Uploadify上傳按鈕時被調用時觸發。
onFallback()	當Uploadify初始化過程當中檢測到當前瀏覽器不支持flash時觸發。
onInit()	首次初始化Uploadify結束時觸發。
onQueueComplete(queueData)	文件上傳隊列處理完畢後觸發。 queueData對象包含以下屬性： uploadsSuccessful – 上傳成功的文件數量 uploadsErrored – 上傳失敗的文件數量
onSelect(file)	選擇文件後向隊列中添加每一個上傳任務時都會觸發。
onSelectError(file, errorCode, errorMsg)	選擇文件後向隊列中添加每一個上傳任務時若是失敗都會觸發。 file – 文件對象 errorCode – 錯誤代碼以下： QUEUE_LIMIT_EXCEEDED – 任務數量超出隊列限制； FILE_EXCEEDS_SIZE_LIMIT – 文件大小超出限制； ZERO_BYTE_FILE – 文件大小爲0 INVALID_FILETYPE – 文件類型不符合要求 errorMsg – 錯誤提示，可經過’this.queueData.errorMsg’定製
onSWFReady()	Flash文件載入成功後觸發。
onUploadComplete(file)	每一個文件上傳完畢後不管成功與否都會觸發。
onUploadError(file, errorCode, errorMsg, errorString)	文件上傳出錯時觸發，參數由服務端程序返回。
onUploadProgress(file, bytesUploaded, bytesTotal, totalBytesUploaded, totalBytesTotal)	處理上傳隊列的過程當中會屢次觸發此事件，每當任務狀態有更新時都會觸發。 file – 文件對象 bytesUploaded – 已上傳的字節數 bytesTotal – 文件總字節數 totalBytesUploaded – 當前任務隊列中所有文件已上傳的總字節數 totalBytesTotal – 當前任務隊列中所有文件的總字節數
onUploadStart(file)	當文件即將開始上傳時當即觸發
onUploadSuccess(file, data, response)	當文件上傳成功時觸發 file – 文件對象 data – 服務端輸出返回的信息 response – 有輸出時爲true,若是無響應爲false，若是返回的是false,當超過successTimeout設置的時間後假定爲true

**3、方法**
方法名稱	說明	應用舉例
cancel(fileID, suppressEvent)	取消隊列中的任務，無論此任務是否已經開始上傳 fileID – 要取消的文件ID，若是爲空則取消隊列中第一個任務，若是爲’*'則取消全部任務 suppressEvent – 是否阻止觸發onUploadCancel事件，當清空隊列時很是實用。	<a href="javascript:$(‘#file_upload’).uploadify(‘cancel’)">取消第一個</a> <a href="javascript:$(‘#file_upload’).uploadify(‘cancel’, ‘’)">清空隊列</a> <a href="javascript:$(‘#file_upload’).uploadify(‘upload’, ‘’)">開始上傳全部任務</a>
destroy()	銷燬Uploadify實例並將文件上傳按鈕恢復到原始狀態	<a href="javascript:$(‘#file_upload’).uploadify(‘destroy’)">銷燬Uploadify實例</a>
disable(setDisabled)	禁用或啓用文件瀏覽按鈕 setDisabled – 設置爲true表示禁用，false爲啓用	<a href="javascript:$(‘#file_upload’).uploadify(‘disable’, true)">禁用按鈕</a> <a href="javascript:$(‘#file_upload’).uploadify(‘disable’, false)">啓用按鈕</a>
settings(name, value, resetObjects)	獲取或設置Uploadify實例參數 name – 屬性名稱，若是隻提供屬性名稱則表示獲取其值 value – 屬性值 resetObjects – 設置爲true時，更新postData對象將清空現有的值。不然，新的值將被添加到其末尾。	$(‘#file_upload’).uploadify(‘settings’,'buttonText’,'BROWSE’); $(‘#file_upload’).uploadify(‘settings’,'buttonText’));
stop()	中止當前正在上傳的任務	<a href="javascript:$(‘#file_upload’).uploadify(‘upload’, ‘*’)">開始上傳</a> <a href="javascript:$(‘#file_upload’).uploadify(‘stop’)">中止上傳</a>
upload(fileID)	當即上傳指定的文件，若是fileID爲’*'表示上傳全部文件，要指定上傳多個文件，則將每一個文件的fileID做爲一個參數	<a href="javascript:$(‘#file_upload’).uploadify(‘upload’,'*’)">開始上傳所