DIV CSS 佈局教程網

jQuery 上傳外掛 Uploadify 完整用法解析
編輯:關於JavaScript     

Uploadify 是一款以 jQuery 為基礎的檔案上傳元件,支援 AJAX 無刷新上傳、多檔同時上傳、上傳進度顯示,以及移除已上傳檔案。使用門檻是 jQuery 1.4 以上版本與 Flash Player 9.0.24 以上版本。

它有 Flash 與 HTML5 兩個版本,HTML5 版需要付費,因此以下說明以 Flash 版為主。

官方網站:https://www.uploadify.com/

基本用法

先載入樣式與程式檔,順序不可顛倒:

<link rel="stylesheet" type="text/css" href="uploadify.css">
<script type="text/javascript" src="https://code.jquery.com/jquery-1.7.2.min.js"></script>
<script type="text/javascript" src="jquery.uploadify-3.1.min.js"></script>

接著建立一個 file input(或任何帶 id 的元素)並完成初始化。請確認同目錄下有 uploadify.swf 與後端處理檔 uploadify.php,路徑依專案結構調整:

<input type="file" name="file_upload" id="file_upload" />
<script>
$(function(){
  $('#file_upload').uploadify({
    'swf': 'uploadify.swf',
    'uploader': 'uploadify.php'
    // 其他選項寫在這裡
  });
});
</script>

這樣就完成了一個最基礎的上傳元件。它的原理是:把原本的 file input 藏起來,改為產生一段 DOM 結構與一個 DIV 按鈕,按鈕樣式寫在 uploadify.css 的 .uploadify-button 中,再把 swf 絕對定位疊在按鈕上。所以你點的看似是按鈕,實際上點到的是 swf。

常用選項

$('#file_upload').uploadify({
  auto: false,
  // true 時選檔後自動上傳;false 時只加入佇列,需呼叫 upload 方法觸發。預設 true

  buttonClass: "some-class",
  buttonCursor: 'hand',
  // 游標移到按鈕上的樣式,可為 hand 或 arrow

  buttonImage: 'img/browse-btn.png',
  // 圖片按鈕的路徑。若使用預設樣式,還可以把滑鼠移入狀態的圖片疊在下方

  buttonText: '<div>選擇檔案</div>',
  // 按鈕文字,內容會被當 HTML 渲染

  checkExisting: '/uploadify/check-exists.php',
  // 指定一個後端路徑,用來檢查即將上傳的檔名是否已存在於目標目錄,存在回傳 1,否則回傳 0。預設 false

  debug: false,
  fileObjName: 'filedata',
  // 後端接收的檔案欄位名稱。例如設為 the_files,PHP 端可用 $_FILES['the_files'] 取得

  fileSizeLimit: '100MB',
  // 單檔大小上限。字串可帶單位(B/KB/MB/GB),純數字預設以 KB 計,設為 0 表示不限制

  fileTypeExts: '*.*',
  // 允許的副檔名,多個以分號分隔,如 '*.jpg;*.png;*.gif'。
  // 注意:手動輸入檔名可以繞過這個檢查,所以伺服器端仍必須再驗證一次

  fileTypeDesc: 'All Files',
  // 檔案選擇視窗中「檔案類型」下拉選單顯示的文字(Chrome 下可能顯示為自訂)

  formData: { timestamp: '...', token: '...' },
  // 隨上傳一起送出的額外資料,後端可用 $_GET / $_POST 取得。
  // 若要動態變更,需在 onUploadStart 事件中透過 settings 設定

  height: 30,   // 按鈕高度(px,整數,勿帶單位)
  width: 120,   // 按鈕寬度(px,整數,勿帶單位)

  itemTemplate: false,
  // 為佇列中的每一項指定自訂 HTML 模板

  method: 'post',   // 提交方式,post 或 get,預設 post
  multi: false,     // 是否允許一次選擇多個檔案
  overrideEvents: [], // 指定可被使用者覆寫的事件名稱陣列
  preventCaching: true,
  // 是否防止 swf 被瀏覽器快取(會在網址加上隨機參數)。
  // 部分瀏覽器快取 swf 後會導致內部事件無法觸發

  progressData: 'percentage', // 進度顯示方式:percentage(百分比)或 speed(速度)
  queueID: false,   // 佇列容器的元素 id;設為 false 時自動產生
  queueSizeLimit: 999, // 每次可加入佇列的檔案數(非總上傳數,那由 uploadLimit 控制)
  removeCompleted: true, // 是否移除佇列中已完成的項目
  removeTimeout: 3,   // 上傳完成後移除的延遲秒數,removeCompleted 為 false 時無效
  requeueErrors: false, // 失敗的檔案是否重新加入佇列
  successTimeout: 30, // 等待伺服器回應的秒數,逾時視為成功
  swf: 'uploadify.swf',   // swf 相對路徑(必填)
  uploader: 'uploadify.php', // 後端腳本路徑(必填)
  uploadLimit: 999  // 上傳數量上限,達到或超過會觸發 onUploadError
});

常用事件

$('#file_upload').uploadify({
  onCancel: function (file) {
    // 檔案被移出佇列時觸發
  },
  onClearQueue: function (queueItemCount) {
    // 呼叫 cancel 並傳入 '*' 清空整個佇列時觸發
  },
  onDialogClose: function (queueData) {
    // 關閉檔案選擇視窗時觸發,queueData 含:
    // filesSelected、filesQueued、filesReplaced、filesCancelled、filesErrored
  },
  onInit: function (instance) {
    // 每次初始化佇列時觸發,可取 instance.settings.queueID
  },
  onQueueComplete: function (queueData) {
    // 佇列中全部檔案上傳完畢,queueData 含 uploadsSuccessful、uploadsErrored
  },
  onSelect: function (file) {
    // 每加入一個檔案到佇列時觸發
  },
  onSelectError: function (file, errorCode, errorMsg) {
    // 選擇檔案出錯時觸發,常見錯誤碼:
    // QUEUE_LIMIT_EXCEEDED: -100  超過數量上限
    // FILE_EXCEEDS_SIZE_LIMIT: -110  超過大小限制
    // INVALID_FILETYPE: -130  檔案類型不符
    // 完整訊息可用 this.queueData.errorMsg 取得
  },
  onUploadProgress: function (file, bytesUploaded, bytesTotal, totalBytesUploaded, totalBytesTotal) {
    // 進度更新時觸發,可即時更新畫面上的進度文字
  },
  onUploadStart: function (file) {
    // 每個檔案上傳前觸發,常用來動態帶入 formData
  },
  onUploadError: function (file, errorCode, errorMsg, errorString) {
    // 上傳完成但回傳錯誤時觸發
  },
  onUploadSuccess: function (file, data, response) {
    // 上傳成功後觸發,data 為後端回應內容,
    // file 物件含 id、index、name、size、type 等資訊
  }
});

方法呼叫

Uploadify 採用 jQuery 官方推薦的外掛模式,所有方法都收在同一個命名空間下。呼叫時把方法名稱當作第一個參數傳入,後續參數則會轉交給該方法。

$(el).uploadify('cancel', '*'); // 取消整個佇列;不帶 * 則只取消第一個
$(el).uploadify('upload', '*'); // 上傳整個佇列;不帶 * 則只上傳第一個
$(el).uploadify('destroy');     // 移除元件,回到瀏覽器預設的上傳方式
$(el).uploadify('disable', true);  // true 停用、false 啟用
$(el).uploadify('stop');        // 停止上傳中的檔案或佇列

// settings:取得或更新設定值
$(el).uploadify('settings', 'buttonText', 'BROWSE'); // 設定
$(el).uploadify('settings', 'buttonText');           // 取得

最後提醒一個安全觀念:不論前端把 fileTypeExts 設得多嚴格,都只能算使用者體驗層級的限制。真正的檔案類型與大小驗證,一定要在伺服器端再做一次。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved