傳統表單上傳有一個繞不開的問題:整個頁面被提交、刷新、重新渲染,用戶上下文丟失。改用 jQuery 發起異步請求的好處有兩方面:一方面 JS 在交互控制上比原生表單靈活得多,可以做進度條、預覽、分片;另一方面避免了上傳大文件時頁面長時間卡死無響應。
一個 type="file" 的 input 就能讓用戶瀏覽並選擇文件,通常會放進 form 裡。
<form> <input type="file" id="avatar" name="avatar"> <button type="button">保存</button> </form>
想支持多選,加上 multiple 屬性即可:
<input type="file" id="avatar" name="avatar" multiple>
該 input 會擁有一個名為 files 的 DOM 屬性,是包含所選文件的 FileList。
$('button').click(function () {
var $input = $('#avatar');
// 以下三種寫法等價:$input[0].files、$input.get(0).files
var files = $input.prop('files');
console.log(files);
});
列表裡每一項都是一個 File 對象,主要屬性有三個:name(文件名,只讀字符串,不含路徑信息)、size(文件大小,單位字節,只讀整數)、type(MIME 類型,未知時為空字符串)。更多細節可參考 MDN 的 File API 文檔。
文件內容是二進制數據,而 HTTP 默認的表單編碼 application/x-www-form-urlencoded 是基於文本的,無法承載。因此上傳文件必須採用 multipart/form-data。其消息體大致如下:
------WebKitFormBoundaryrGKCBY7qhFd3TrwA Content-Disposition: form-data; name="title" harttle ------WebKitFormBoundaryrGKCBY7qhFd3TrwA Content-Disposition: form-data; name="avatar"; filename="harttle.png" Content-Type: image/png ... content of harttle.png ... ------WebKitFormBoundaryrGKCBY7qhFd3TrwA--
每個字段由一段 boundary 字符串分隔,瀏覽器保證該字符串不會與內容重複,於是二進制數據得以安全編碼。
XMLHttpRequest Level 2 提供的 FormData 對象可以幫我們自動完成上述編碼:
$('button').click(function () {
var files = $('#avatar').prop('files');
var data = new FormData();
data.append('avatar', files[0]);
$.ajax({
url: '/api/upload',
type: 'POST',
data: data,
cache: false,
processData: false,
contentType: false
});
});
url、type、data 大家都熟,重點在後三個參數——它們少寫任何一個都會導致上傳失敗。
禁止瀏覽器對該 URL 的緩存,jQuery 的實現方式是給 URL 追加一個多餘參數。該選項只對 GET 和 HEAD 生效,但 IE8 會緩存之前的 GET 結果來響應 POST 請求,所以這裡設置它是為了兼容 IE8。
jQuery 中 content-type 的默認值是 application/x-www-form-urlencoded,因此傳給 data 的對象會被轉換成 query string。我們不希望它做這個轉換,否則會破壞 multipart/form-data 的編碼格式,包括 boundary 的生成。設為 false 就是讓 jQuery 別插手,由瀏覽器自行填充正確的 Content-Type。
jQuery 默認會把 data 對象轉成字符串再發送。我們傳入的已經是編碼完好的 FormData,不需要也不允許二次轉換,設為 false 關閉該流程。
這套做法依賴 FormData 對象,屬於 XMLHttpRequest Level 2 接口,需要 IE 10+、Firefox 4.0+、Chrome 7+、Safari 5+、Opera 12+。
對於更老的瀏覽器,只能退回直接提交文件表單的方式,但提交大文件時頁面會長時間無響應。若必須在低版本瀏覽器中兼顧體驗,歷史上常見的方案是使用支持多文件與進度顯示的 Flash 插件;而在今天,更現實的選擇是引進成熟的文件上傳組件,它們通常自帶降級策略、分片與斷點續傳能力。
如果想加進度條,需要繞過 jQuery 直接拿原生 xhr:使用 xhrFields: { onprogress: function (e) { ... } } 或自行創建 XMLHttpRequest,監聽 upload.onprogress 事件,用 e.loaded / e.total 計算百分比。這是異步上傳相對傳統表單最直觀的體驗優勢,值得一併實現。