開發專案時常需要把前台表單的值整批送到後端。表單欄位少的時候還能逐一傳,欄位一多就不切實際。這時 jQuery 提供的序列化方法就能派上用場,而且可以進一步封裝成通用函式,讓不同的呼叫點各自傳入處理成功的回呼。
function queryUserInfo(actionUrl, formId, fun) {
var params = new Object();
// 把表單內容序列化後逐一收集
$.each($("#" + formId).serializeArray(), function (index, param) {
params[param.name] = param.value;
});
params['time'] = new Date(); // 加上時間戳記,避免快取
$.ajax({
url: basePath + actionUrl,
data: params, // 也可以直接寫 $("#" + formId).serialize()
type: 'POST',
dataType: 'json',
async: false, // 同步:等伺服器回應後才往下執行
success: function (obj) {
fun(actionUrl, formId, obj); // 呼叫外部傳入的回呼
},
error: function () {
alert("訪問異常");
}
});
}
function setUserInfo(actionUrl, userid, username, fun) {
var params = new Object();
params['user.id'] = userid;
params['user.name'] = username;
$.ajax({
url: actionUrl,
data: params,
type: 'POST',
dataType: 'json',
async: false,
success: function (obj) {
fun(actionUrl, userid, obj);
},
error: function () {
alert("訪問異常");
}
});
}
jQuery 提供了幾個相關方法,依需求選擇:
$("#form1").serialize(); // 回傳 query string:"a=1&b=2"
$("#form1").serializeArray(); // 回傳 [{name:'a',value:'1'}, ...] 陣列
$.param(obj); // 把任意物件轉成 query string
serialize 系列只會收集「成功控制項」:有 name 屬性、未被 disabled、且 checkbox/radio 處於勾選狀態的才會被包含。這一點和手動遍歷不同,通常正是我們想要的行為。
async: false 應該避免。同步的 AJAX 會凍結整個瀏覽器 UI,直到回應返回為止。使用者會覺得頁面當機,而且無法捲動、無法點擊。同時它也被主流瀏覽器標記為不建議使用,在頁面卸載時甚至可能直接被忽略。
正確做法是保持非同步,把「需要等資料回來才能做的事」全部放進 success 回呼:
function queryUserInfo(actionUrl, formId, fun) {
$.ajax({
url: basePath + actionUrl,
data: $("#" + formId).serialize(), // 直接傳字串即可
type: 'POST',
dataType: 'json',
success: function (obj) {
fun(obj); // 後續處理交給呼叫方
},
error: function (xhr, status, err) {
console.error(status, err);
alert("訪問異常,請稍後再試");
}
});
}
// 呼叫時
queryUserInfo("getUserInfo.do", "form1", function (data) {
$("#result").text(data.name);
// 其他依賴回應的處理都寫在這裡
});
回呼函式改成 Promise 更好用。當需要串接多個非同步步驟時,回呼巢狀很快就難以維護。改用 return $.ajax(...) 把 Deferred 物件往外傳,呼叫方就能用 then/await 串接:
async function load() {
try {
var data = await queryUserInfo("getUserInfo.do", "form1");
$("#result").text(data.name);
} catch (e) {
alert("載入失敗");
}
}
別忘了 CSRF 防護。POST 送出表單時,若後端有啟用 CSRF token 機制,記得把 token 一起送出去,否則會被中介軟體攔下。