本文聚焦於前端 JS 程式碼,說明如何以 HTML5 搭配 jQuery 實作檔案上傳的進度條。
首先,HTML5 用 AJAX 提交資料需先學習一個 HTML5 新增的物件:FormData。FormData 物件可以使用 append 方法進行 key-value 的資料添加,與我們常用的 JSON 不同的是,它可以非同步上傳二進位檔案。
1. FormData 物件的建立
var formData = new FormData();
2. 向 FormData 物件添加資料
formData.append("catname", "我是一隻喵");
formData.append("age", 1); // 數字型別會轉為字串型別
// 可以增加上傳的二進位檔案,比如 fileInputElement 物件中已經包含了使用者所選擇的檔案
formData.append("userfile", fileInputElement.files[0]);
// 也可以將一個 Blob 物件添加到 formData 中
var oFileBody = "<a id='a'><b id='b'>hey!</b></a>";
var oBlob = new Blob([oFileBody], { type: "text/xml" });
formData.append("webmasterfile", oBlob);
3. 使用 FormData 物件
var xhr = new XMLHttpRequest();
xhr.open("POST", "upload");
xhr.send(formData);
HTML 部分
簡單介紹完 FormData 物件後,我們來看看頁面的 HTML 程式碼怎麼寫:
<img width="400" height="250"/><br /> <input type="file" id="pic" name="pic" onchange="showPic()"/> <input type="button" value="上傳圖片" onclick="uploadFile()" /><br /> <div id="parent"> <div id="son"></div> </div>
最下面的 div 是用來顯示進度條的,所以需要對應的 CSS 樣式。樣式如下,顏色不好看,自己改吧:
<style type="text/css">
#parent { width: 550px; height: 10px; border: 2px solid #09F; }
#son { width: 0; height: 100%; background-color: #09F; text-align: center; line-height: 10px; font-size: 20px; font-weight: bold; }
</style>
JS 部分
重頭戲來了,在頁面上加載 jQuery 後,我們來看 JavaScript 是怎麼寫的。首先是 file 元件的 onchange 事件方法:
function showPic() {
var pic = $("#pic").get(0).files[0];
$("img").prop("src", window.URL.createObjectURL(pic));
}
showPic 的第一行是從 file 物件得到上傳檔案,第二行則為 img 設定了 src 屬性,可以在頁面中得到即時預覽的效果。
在看 uploadFile 方法之前,我們先簡單學習一下進度事件(Progress Events)的 progress。Progress Events 規範是 W3C 的一個工作草案,定義了與客戶端伺服器通訊有關的事件,這些事件最早其實是針對 XHR 操作,但目前也被其他 API 借鑒,有以下 6 個進度事件:
loadstart:在接收到相應資料的第一個位元組時觸發。
progress:在接收相應期間持續不斷觸發。(我們就只看這一個)
error:在請求發生錯誤時觸發。
abort:在因為呼叫 abort() 方法而終止連結時觸發。
load:在接收到完整的相應資料時觸發。
loadend:在通訊完成或者觸發 error、abort 或 load 事件後觸發。
progress 事件會在瀏覽器接收新資料期間週期性地觸發,而 onprogress 事件處理常式會接收到一個 event 物件,其 target 屬性是 XHR 物件,但包含著三個額外的屬性:
lengthComputable:表示進度資訊是否可用的布林值。
position:表示已經接收的位元組數。
totalSize:表示根據 Content-Length 回應標頭確定的預期位元組數。
有了這些資訊,我們就可以為使用者建立一個進度指示器了。但問題又來了:jQuery 的 ajax 方法沒有關於 progress 事件的操作,這怎麼辦?好在透過查閱資料發現,jQuery 的 ajax 方法呼叫的 XMLHttpRequest 物件是可以指定的!!!

於是 uploadFile 方法的 ajax 部分程式碼就變成了這樣。
最重要的部分程式碼:
function uploadFile() {
// 取得上傳檔案,放到 formData 物件裡面
var pic = $("#myhead").get(0).files[0];
var formData = new FormData();
formData.append("file", pic);
$.ajax({
type: "POST",
url: "upload",
data: formData,
processData: false, // 必須 false 才會自動加上正確的 Content-Type
contentType: false,
// 先拿到 jQuery 產生的 XMLHttpRequest 物件,為其增加 progress 事件綁定,然後再返回交給 ajax 使用
xhr: function () {
var xhr = $.ajaxSettings.xhr();
if (onprogress && xhr.upload) {
xhr.upload.addEventListener("progress", onprogress, false);
return xhr;
}
}
});
}
最後加上 onprogress 方法,為整個功能畫上句號。
/**
* 偵查附件上傳情況,這個方法大概 0.05-0.1 秒執行一次
*/
function onprogress(evt) {
var loaded = evt.loaded; // 已經上傳大小情況
var tot = evt.total; // 附件總大小
var per = Math.floor(100 * loaded / tot); // 已經上傳的百分比
$("#son").html(per + "%");
$("#son").css("width", per + "%");
}
最後附上整個頁面的程式碼,方便對比。
<!DOCTYPE html>
<html>
<head>
<title>html5_2.html</title>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<style type="text/css">
#parent { width: 550px; height: 10px; border: 2px solid #09F; }
#son { width: 0; height: 100%; background-color: #09F; text-align: center; line-height: 10px; font-size: 20px; font-weight: bold; }
</style>
<script type="text/javascript" src="js/jquery-1.9.1.js"></script>
<script type="text/javascript">
function showPic() {
var pic = $("#pic").get(0).files[0];
$("img").prop("src", window.URL.createObjectURL(pic));
uploadFile();
}
function uploadFile() {
var pic = $("#pic").get(0).files[0];
var formData = new FormData();
formData.append("file", pic);
/**
* 必須 false 才會避開 jQuery 對 formdata 的預設處理
* XMLHttpRequest 會對 formdata 進行正確的處理
*/
$.ajax({
type: "POST",
url: "upload",
data: formData,
processData: false, // 必須 false 才會自動加上正確的 Content-Type
contentType: false,
xhr: function () {
var xhr = $.ajaxSettings.xhr();
if (onprogress && xhr.upload) {
xhr.upload.addEventListener("progress", onprogress, false);
return xhr;
}
}
});
}
/**
* 偵查附件上傳情況,這個方法大概 0.05-0.1 秒執行一次
*/
function onprogress(evt) {
var loaded = evt.loaded; // 已經上傳大小情況
var tot = evt.total; // 附件總大小
var per = Math.floor(100 * loaded / tot); // 已經上傳的百分比
$("#son").html(per + "%");
$("#son").css("width", per + "%");
}
</script>
</head>
<body>
<img width="400" height="250"/><br />
<input type="file" id="pic" name="pic" onchange="showPic()"/>
<input type="button" value="上傳圖片" onclick="uploadFile()" /><br />
<div id="parent">
<div id="son"></div>
</div>
</body>
</html>