DIV CSS 佈局教程網

用 jQuery 搭配 HTML5 FormData 實作檔案上傳與進度顯示
編輯:JavaScript綜合知識     

HTML5 之前,要做有進度條的檔案上傳往往得靠 Flash。HTML5 帶來 FormData 與 XMLHttpRequest 的 upload 事件之後,純 JavaScript 就能完成,しかも能即時取得上傳百分比。本文把完整實作封裝成一個 jQuery 外掛。

注意:FormData 是 HTML5 的 API,使用前請確認瀏覽器版本已支援。

HTML 頁面

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<title>使用 HTML5 FormData 實作檔案上傳</title>
<link rel="stylesheet" href="../css/fileUpload.css" />
</head>
<body>
<table id="uploadTable" style="border: 1px;"></table>
<br/>
<a href="javascript:void(0);" class="input-file">
  添加文件
  <input type="file" id="txtFile" style="width:200px;" />
</a>

<script type="text/javascript" src="../js/jquery-1.7.1-min.js"></script>
<script type="text/javascript">
$(function () {
  $('#uploadTable').SalesMOUNDUpload({
    saveUrl: '/Test/Save',
    jqInput: $('#txtFile'),
    fnRemove: removeFile,
    fnComplete: function (d) { console.log('complete ' + d); }
  });
});

function removeFile(d) {
  $.post('/Test/Remove', { "filename": d }, function (r) { });
}
</script>
</body>
</html>

CSS

body {
  font-family: "微軟雅黑";
  font-size: 12px;
}
.input-file {
  overflow: hidden;
  position: relative;
}
.input-file input {
  opacity: 0;
  filter: alpha(opacity=0);
  font-size: 100px;
  position: absolute;
  top: 0;
  right: 0;
}
#uploadTable {
  width: 500px;
  border-collapse: collapse;
  border: 1px solid Silver;
}

這裡有個常用技巧:把真正的 <input type="file"> 設為透明並鋪滿整個連結區域,使用者點到的其實是原生檔案選擇器,但視覺上呈現的是你設計好的按鈕樣式。

JavaScript 外掛

(function ($) {
  $.fn.SalesMOUNDUpload = function (options) {
    var defaults = {
      saveUrl    : '',
      jqInput    : '',
      maxSize    : 1024 * 1024 * 100,   // 100M
      fnRemove   : '',                  // 移除檔案,參數為檔名
      fnComplete : ''                   // 單一檔案完成,參數為伺服器回應
    };
    var opt = $.extend(defaults, options);

    function getByteToM(val) {
      if (isNaN(val)) return val;
      val = val / (1024 * 1024);
      return Math.round(val * 100) / 100;
    }

    return this.each(function () {
      var $this = $(this);
      $this.empty();

      if (typeof FormData == 'undefined') {
        alert('瀏覽器版本太低,不支援此上傳方式!');
        return;
      }

      // 建立表頭
      if ($this.find('thead').length == 0) {
        var $thead = $('<thead>'), $th_tr = $('<tr>');
        $th_tr.append('<th>檔名</th>');
        $th_tr.append('<th>類型</th>');
        $th_tr.append('<th>大小</th>');
        $th_tr.append('<th>狀態</th>');
        $th_tr.append('<th>操作</th>');
        $th_tr.appendTo($thead);
        $this.append($thead);
      }

      opt.jqInput[0].addEventListener('change', function (e) {
        var file = this.files[0];
        if (!file) return;
        if (file.size > opt.maxSize) {
          window.alert('檔案超過大小上限');
          return;
        }

        var fd = new FormData();
        var $table = $this;
        fd.append("uploadFile", file);

        var xhr = new XMLHttpRequest();
        xhr.open('POST', opt.saveUrl, true);
        xhr.upload.addEventListener("progress",   uploadProgress, false);
        xhr.addEventListener("load",   uploadComplete, false);
        xhr.addEventListener("error",  uploadFailed,   false);
        xhr.addEventListener("abort",  uploadCanceled, false);

        // 在表格中新增一列
        var $tr = $('<tr>');
        $tr.append('<td class="upload_name">'   + file.name + '</td>');
        $tr.append('<td class="upload_type">'   + file.type + '</td>');
        $tr.append('<td class="upload_size">'   + getByteToM(file.size) + 'M</td>');
        $tr.append('<td class="upload_status">' + 0 + '</td>');
        $tr.append('<td class="upload_action"><a href="javascript:void(0);">取消</a></td>');
        $tr.find('.upload_action a').on('click', function () { xhr.abort(); });
        $table.append($tr);

        function uploadProgress(evt) {
          if (evt.lengthComputable) {
            var percent = Math.round(evt.loaded * 100 / evt.total);
            $tr.find('.upload_status').html(percent + '%');
          } else {
            $tr.find('.upload_status').html('無法計算進度');
          }
        }

        function uploadComplete(evt) {
          if (evt.target.status == 200) {
            $tr.find('.upload_status').html('已完成');
            $tr.find('.upload_action a').html('刪除');
            if (typeof opt.fnComplete == 'function') {
              opt.fnComplete(evt.target.response);
            }
            $tr.find('.upload_action a').off('click').on('click', removeFile);
          }
        }

        function uploadFailed() {
          $tr.find('.upload_status').html('<a href="javascript:void(0);">刪除此行</a>');
          $tr.find('.upload_action a').html('重試');
          $tr.find('.upload_action a').off('click').on('click', function () { xhr.send(fd); });
        }

        function uploadCanceled() { $tr.remove(); }

        function removeFile() {
          $tr.remove();
          if (typeof opt.fnRemove == 'function') { opt.fnRemove(file.name); }
        }

        xhr.send(fd);
      }, false);
    });
  };
}(jQuery));

關鍵 API 說明

FormData:把 File 物件 append 進去後直接交給 XHR 送出,瀏覽器會自動產生 multipart/form-data 的標頭與 boundary,不需要手動拼字串。注意:不要自己設定 Content-Type,否則 boundary 會出錯。

xhr.upload.addEventListener('progress', ...):上傳進度事件掛在 xhr.upload 而不是 xhr 本身,這是很多人卡住的地方。evt.lengthComputable 用來確認伺服器有提供 Content-Length,否則無法算出百分比。

xhr.abort():即時取消上傳,並觸發 abort 事件,可藉此移除該列。

可再強化的部分

範例一次只處理 files[0],若要支援多檔,改成迴圈遍歷 this.files 即可;把 multiple 加在 input 上就能多選。

另外,檔名直接以 innerHTML 拼接進表格有 XSS 風險(檔名可以包含標籤字元),正式環境請改用 .text() 設定文字內容。伺服器端也務必驗證副檔名與 MIME、限制大小,前端檢查永遠只是第一道防線。

完整程式碼可參考作者的 GitHub 專案:https://github.com/kencery/Common。

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