傳統的表單上傳只能等請求結束才知道結果,用戶在等待中完全沒有反饋。HTML5 帶來的 XMLHttpRequest 上傳事件與 FormData,讓我們可以在瀏覽器端真實監聽已上傳字節數,把進度條做出來。本文分享一套不依賴任何框架的實現思路。
關鍵只有三步:
FormData 封裝文件對象;xhr.upload.addEventListener('progress', ...) 監聽上傳進度;evt.loaded / evt.total 換算百分比,驅動頁面中的 <progress> 元素。為了讓業務代碼保持乾淨,我把常用能力按職責分組封裝:
get:DOM 與字符串工具,如 get.Id()、get.Tag()、get.filepath()(用 FileReader 讀取本地圖片預覽)。set:頁面動作,如 set.url()、set.reload()、set.html()。string:字符串與 JSON 互轉、忽略大小寫比較。is:類型判斷與環境檢測,包括是否支持 HTML5、變量是對象/字符串/整數/小數等。file:文件相關操作,上傳、進度、大小、類型、文件名。Call:通用 Ajax 封裝,支持 GET/POST、JSON 解析、加載動畫。Loading / add / del:動態創建節點、設置屬性、移除節點,以及請求中的遮罩動畫。
var file = {
// 異步文件上傳
upload: function (json) {
var post = new XMLHttpRequest();
var FILE = new Object();
var json = is.object(json) ? json : string.toJson(json);
var fileSize = 0;
if (!json.url && json.error) { json.error(404); return; }
if (!is.object(json.file)) {
FILE.id = get.Id(json.file);
// 大文件分片上傳
if (json.maxfile) {
fileSize = file.getSize(FILE.id);
var shardSize = 1024 * 1024 << 1; // 每片 2M
var shardCount = Math.ceil(fileSize / shardSize);
for (var i = 0; i < shardCount; ++i) {
var start = i * shardSize;
var end = Math.min(fileSize, start + shardSize);
var formData = new FormData();
formData.append(json.file, FILE.id.files[0].slice(start, end));
formData.append("total", shardCount); // 總片數
formData.append("index", i + 1); // 當前第幾片
post.upload.addEventListener('progress', callback, false);
post.open('post', json.url, true);
post.send(formData);
}
} else {
var formData = new FormData();
formData.append(json.file, FILE.id.files[0]);
if (json.progress) {
post.upload.addEventListener('progress', json.progress, false);
}
post.open('post', json.url, true);
post.send(formData);
post.onreadystatechange = function () {
if (post.readyState === 4) {
if (post.status == 200 || post.status == 0) {
json.success(string.toJson(post.responseText));
}
}
};
}
}
},
// 上傳進度百分比
getProgress: function (evt) {
var percentComplete = Math.round(evt.loaded * 100 / evt.total);
return percentComplete.toString();
},
// 文件大小(自動切換 KB / MB)
getSize: function (file) {
var f = get.Id(file).files[0];
var size = 0;
if (f.size > 1024 * 1024) {
size = (Math.round(f.size * 100 / (1024 * 1024)) / 100).toString();
} else {
size = (Math.round(f.size * 100 / 1024) / 100).toString();
}
return size;
},
getType: function (file) { return get.Id(file).files[0].type; },
getName: function (file) { return get.Id(file).files[0].name; }
};
頁面中需要三個關鍵元素:文件選擇框、進度條、以及用於展示文件信息的容器。進度條直接用 HTML5 原生標籤即可,無需自己畫:
<input id='files' type='file' class="file"> <progress id='progress' max="100" value='0' style='width:100%; height:22px; background:#30a5ff;'></progress> <div id='gress' style='color:#FFF; position:relative; bottom:28px; left:40%;'></div> <div id='fileSize'> <span></span> <span></span> </div> <img class='left' id='thmb' src=''>
選好文件後先展示預覽與基本信息,點擊上傳時把進度實時寫回 progress 元素:
get.Id('files').onchange = function () {
get.filepath(this, function (str) { get.Id('thmb').src = str; });
set.html(filetype, file.getName('files'));
get.Id('progress').value = 0;
set.html(get.Id('gress'), '');
set.html(get.Tag(get.Id('fileSize'), 'span')[0], file.getSize('files') + 'KB');
set.html(get.Tag(get.Id('fileSize'), 'span')[1], '/0kb');
};
get.Id('up').onclick = function () {
if (file.getSize('files') <= 0) { return false; }
file.upload({
file: 'files',
url: '{:U(\'Banner/add\', 0, 0)}',
dataType: 'json',
progress: function (ev) {
get.Id('progress').value = file.getProgress(ev);
set.html(get.Id('gress'), file.getProgress(ev) + '%');
},
success: function (e) {
set.html(get.Id('gress'), '上傳完成');
data.bannerWidth = e.bannerWidth;
data.bannerHeight = e.bannerHeight;
data.bannerImg = e.bannerImg;
}
});
};
第一,progress 事件只在 xhr.upload 上觸發,綁到 xhr 本身上是拿不到的,這是新手最常踩的坑。
第二,服務端必須返回 Access-Control-Allow-Origin 等 CORS 頭,跨域上傳才能拿到完整响应。
第三,大文件分片需要服務端配合做切片合併與秒傳校驗(通常基於文件 hash),前端只是把切片按序送上去。
第四,進度條的 loaded / total 是「已發送字節數」,並不代表服務端已處理完成,真正的完成節點應以 readyState === 4 且狀態碼為 2xx 為準。