現在使用者希望在瀏覽網頁時能一邊做別的事,不要被打斷,這通常靠 AJAX 達成。多數人會用 jQuery,但隨著瀏覽器進步,其實已經不需要了。本文示範如何在不離開頁面的情況下上傳檔案,並即時顯示進度、最後回傳檔案網址。
註:此做法不支援舊版 IE,僅適用於 IE10 以後的瀏覽器。
只需要一個 file 輸入框、一個 button,還有一個用來顯示進度的 div(透過改變寬度來呈現百分比)。
<!doctype html>
<html>
<head>
<meta charset="utf-8">
<title>JS File Upload with Progress</title>
<style>
.container { width: 500px; margin: 0 auto; }
.progress_outer { border: 1px solid #000; }
.progress { width: 20%; background: #DEDEDE; height: 20px; }
</style>
</head>
<body>
<div class='container'>
<p>
Select File:
<input type='file' id='_file'>
<input type='button' id='_submit' value='Upload!'>
</p>
<div class='progress_outer'>
<div id='_progress' class='progress'></div>
</div>
</div>
<script src='upload.js'></script>
</body>
</html>先取得要用的元素:
var _submit = document.getElementById('_submit'),
_file = document.getElementById('_file'),
_progress = document.getElementById('_progress');接著為按鈕掛上點擊事件,觸發 upload 方法:
_submit.addEventListener('click', upload);上傳流程拆成四步:檢查是否選檔 → 組出要送出的資料 → 建立 XMLHttpRequest → 送出。
步驟一:檢查選中的檔案
if (_file.files.length === 0) {
return;
}files 是 FileList,若 input 設了 multiple 就會有多筆。這裡簡化處理,只取索引 0 的第一個檔案。
步驟二:用 FormData 組裝資料
var data = new FormData();
data.append('SelectedFile', _file.files[0]);append() 的第一個參數對應輸入框的 name,第二個參數是值。稍後直接把這個 FormData 交給 send() 即可。
步驟三:建立請求並監聽狀態
var request = new XMLHttpRequest();
request.onreadystatechange = function () {
if (request.readyState == 4) { // 4 代表請求完成
try {
var resp = JSON.parse(request.response);
} catch (e) {
// 解析失敗時自建一個物件,讓後續程式不至于出錯
var resp = {
status: 'error',
data: 'Unknown error occurred: [' + request.responseText + ']'
};
}
console.log(resp.status + ': ' + resp.data);
}
};用 try...catch 包住解析,是因為伺服器可能回傳非 JSON 的錯誤頁面(例如 500 的 HTML),不保護的話整段腳本會中斷。
步驟四:掛上進度事件
request.upload.addEventListener('progress', function (e) {
_progress.style.width = Math.ceil(e.loaded / e.total * 100) + '%';
}, false);事件物件上有兩個關鍵屬性:loaded 是已上傳的位元組數,total 是總位元組數,兩者相除再乘 100 就是百分比。
(這裡修正了一個常見的寫法錯誤:原本是 Math.ceil(e.loaded/e.total) * 100,由於 loaded/total 必定小於 1,Math.ceil 的結果恆為 1,進度條會永遠停在 100%。括號必須放在相除之後、乘上 100 之前。)
最後送出
request.open('POST', 'upload.php');
request.send(data);完整 JavaScript:
var _submit = document.getElementById('_submit'),
_file = document.getElementById('_file'),
_progress = document.getElementById('_progress');
var upload = function () {
if (_file.files.length === 0) {
return;
}
var data = new FormData();
data.append('SelectedFile', _file.files[0]);
var request = new XMLHttpRequest();
request.onreadystatechange = function () {
if (request.readyState == 4) {
try {
var resp = JSON.parse(request.response);
} catch (e) {
var resp = {
status: 'error',
data: 'Unknown error occurred: [' + request.responseText + ']'
};
}
console.log(resp.status + ': ' + resp.data);
}
};
request.upload.addEventListener('progress', function (e) {
_progress.style.width = Math.ceil(e.loaded / e.total * 100) + '%';
}, false);
request.open('POST', 'upload.php');
request.send(data);
};
_submit.addEventListener('click', upload);後端沿用先前文章的做法,差別在於這次所有回應都統一輸出成 JSON。此版本僅適用於 500KB 以下的 PNG 圖片,成功時會回傳已上傳檔案的路徑。
<?php
// 統一以 JSON 格式輸出
function outputJSON($msg, $status = 'error') {
header('Content-Type: application/json');
die(json_encode(array(
'data' => $msg,
'status' => $status
)));
}
// 檢查上傳過程是否出錯
if ($_FILES['SelectedFile']['error'] > 0) {
outputJSON('上傳時發生錯誤。');
}
// 確認真的是圖片
if (!getimagesize($_FILES['SelectedFile']['tmp_name'])) {
outputJSON('請確認上傳的是圖片檔。');
}
// 檢查檔案類型
if ($_FILES['SelectedFile']['type'] != 'image/png') {
outputJSON('不支援的檔案格式。');
}
// 檢查檔案大小
if ($_FILES['SelectedFile']['size'] > 500000) {
outputJSON('檔案超過大小上限。');
}
// 檢查是否同名
if (file_exists('upload/' . $_FILES['SelectedFile']['name'])) {
outputJSON('已有相同名稱的檔案。');
}
// 搬移到正式目錄
if (!move_uploaded_file($_FILES['SelectedFile']['tmp_name'],
'upload/' . $_FILES['SelectedFile']['name'])) {
outputJSON('上傳失敗,請確認目的目錄可寫入。');
}
// 成功
outputJSON('檔案已成功上傳至 "upload/' . $_FILES['SelectedFile']['name'] . '".', 'success');
?>還有不少方式可以進一步改善體驗。把多個檔案逐一 append 進同一個 FormData,就能一次上傳多檔;進度條也可以加上 CSS transition 讓變化更平順。
要留意的是,如果你在本機測試,進度條可能瞬間就跳到底——這取決於本機的傳輸速度,並不代表程式有問題。建議改用較大的圖片、或部署到伺服器上測試,才能看出逐步遞增的效果。