DIV CSS 佈局教程網

Ajax 非同步上傳表單與檔案:繞開 iframe 偽 Ajax 的正解
編輯:AJAX基礎知識     

要把表單連同檔案一起用 Ajax 送出去,很多人第一個想到的是 jQuery Form Plugin。但它其實是用 iframe 偽裝的假 Ajax,遇上檔案就問題叢生。本文記錄整個排查過程,並給出以原生 FormData + xhr 為基礎的解法。

一、需求

前台頁面需要呼叫 WebAPI 的 POST 介面,同時送出若干欄位與一個檔案(等同把整個表單非同步送出),再依回傳結果判斷成敗。

二、踩坑:jQuery Form Plugin

最直覺的做法是用 ajaxSubmit():

$("#view").submit(
    $("#view").ajaxSubmit({
        type: "post",
        url: "../api/Article/Add",
        dataType: "json",
        success: function (msg) {
            console.log(msg);
        },
        error: function (msg) {
            $("#resultBox").html("連接服務器失敗");
            console.log(msg);
        }
    })
);

結果有三個問題:

  1. 與 jQuery 1.9.2 相容性不佳,光是繞過 $.browser 已移除的問題就折騰了一陣。
  2. 只要表單中含有檔案,success 回呼收到的 msg 一定是 null(Chromium 下),而實際上後端是有回應的;不含檔案時反而正常。
  3. 在 IE / Edge 下,瀏覽器直接跳出「下載那段 JSON」,體驗極差。

翻 open source 原始碼就明白了——它是用 iframe 實作的偽 Ajax:

// are there files to upload?
var files = $('input:file', this).fieldValue();
var found = false;
for (var j = 0; j < files.length; j++) if (files[j]) found = true;

if (options.iframe || found)  // 有檔案就強制走 iframe 模式
    fileUpload();
else
    $.ajax(options);

有檔案與沒檔案走的是兩條完全不同的程式路徑,這也是行為不一致的根本原因。既然核心是 iframe 加上把回應寫進隱藏文件,那麼跨域、JSON 解析、Content-Type 判斷全都得靠 hack,不如換方案。

三、解法:原生 FormData + 取得原生 xhr

關鍵在於 $.ajax() 的 xhr 選項——它讓你能拿到 jQuery 底層的原生 XMLHttpRequest 物件,於是 upload.progress 這類進度事件都能掛上去。主流瀏覽器與手機瀏覽器均支援。

function AjaxForm(formID, options) {
    var form = $(formID);

    // 直接把 form 元素作為參數建立 FormData
    var formData = new FormData(form[0]);

    // 若表單未正確包含 file 欄位,可手動補上
    $("input[type='file']").each(function (i, item) {
        var domFile = item.files[0];      // 取得 File 物件
        if (domFile) {
            formData.append('file', domFile);
        }
    });

    if (!options) options = {};
    options.url  = options.url  ? options.url  : form.attr("action");
    options.type = options.type ? options.type : form.attr("method");
    options.data = formData;

    options.processData  = false;   // 不要讓 jQuery 把資料轉成字串
    options.contentType  = false;   // 不要讓 jQuery 設定 Content-Type(含 boundary)

    // 關鍵:取得原生 xhr 以掛載上傳進度事件
    options.xhr = options.xhr ? options.xhr : function () {
        var xhr = $.ajaxSettings.xhr();
        xhr.upload.onload = function () {
            console.log("onload");
        };
        xhr.upload.onprogress = function (ev) {
            if (ev.lengthComputable) {
                var percent = 100 * ev.loaded / ev.total;
                console.log(percent, ev);
            }
        };
        return xhr;
    };

    options.success = options.success ? options.success : function (data) {
        alert(data);
    };

    $.ajax(options);
}

// 呼叫
$("#sub").click(function (e) {
    AjaxForm("#myForm");
});

四、為什麼這三個設定缺一不可

  • processData: false:預設情況下 jQuery 會把 data 物件轉成查詢字串,而 FormData 一旦被序列化,檔案內容就全毀了。
  • contentType: false:FormData 需要瀏覽器自動產生 multipart/form-data; boundary=----WebKitFormBoundary... 標頭。若你手動指定 multipart/form-data 卻沒有 boundary,後端根本無從切割各段內容。
  • xhr 回呼:回傳原生 xhr 物件,才能存取 xhr.upload 這個只在/XMLHttpRequest Level 2 才有的屬性,進度條才有資料來源。

五、在 zepto 或不用 jQuery 時

如果專案用 zepto 或乾脆不用函式庫,原生寫法其實更短:

$("#sub").addEventListener("click", function (e) {
    e.preventDefault();

    var form   = document.getElementById("myForm");
    var data   = new FormData(form);
    var xhr    = new XMLHttpRequest();

    xhr.upload.addEventListener("progress", function (ev) {
        if (ev.lengthComputable) {
            document.getElementById("bar").style.width =
                (ev.loaded / ev.total * 100) + "%";
        }
    });

    xhr.addEventListener("load", function () {
        var resp = JSON.parse(xhr.responseText);
        console.log(resp);
    });

    xhr.open("POST", form.action);
    xhr.send(data);
});

六、幾點實務提醒

  • 若表單裡已有多個 file 欄位,用 formData.append('files', file) 傳同名鍵即可,後端以 request.Files.GetMultiple("files") 或 files 陣列接收。
  • 需要在送出前壓縮圖片,可用 canvas 轉成 Blob 後再 append,能大幅減少上傳量。
  • 記得在後端限制檔案大小與副檔名,並以伺服器產生的名稱存檔,避免覆寫與路徑穿越。
  • 若介面需要顯示進度百分比,別忘了在 load 完成後把進度條設為 100% 並隱藏,因為最後一段通常很快,progress 事件不一定會剛好觸發到 100。

以上就是 Ajax 表單非同步上傳檔案(含檔案欄位)的完整做法,希望對大家有所幫助。

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