用 AJAX 送出表單時,最惱人的一步通常是把畫面上那一堆 input 的值整理成 key=value 的字串。jQuery 提供的 serialize() 就是為了省掉這份手工作業而生:一行程式就能把整份表單打包成標準 URL 編碼格式,直接放進 data 裡送出。
這個方法會讀取一組表單元素的值,輸出一段符合 URL 查詢字串規範的編碼文字,也就是 key1=value1&key2=value2 這樣的樣子。它的操作對象是代表表單元素集合的 jQuery 物件,你可以指定單一元素,也可以直接丟整個 form 進去。
$(selector).serialize();
序列化後的字串,最常見的用途就是當成 AJAX 請求的 query string。
所謂成功的控制項,指的是具備 name 屬性、且未被 disabled 的元素。這也是為什麼表單欄位一定要寫 name,否則序列化結果裡完全不會出現它。
如果使用者不是透過 submit 按鈕送表單,那顆按鈕的值就不會被帶進結果中。
雖然 <input>、<textarea>、<select> 都能各自序列化,但實務上直接針對 form 操作最省事。
例如把欄位命名成 length,取值時就會拿不到預期結果:
<form id="form1">
<input name="length" type="text" value="pipi" />
<input name="blog" type="text" value="blue submarine" />
</form>
// $("#form1").serialize(); 取不到 length 的值
$.ajax({
type: "POST",
dataType: "json",
url: ajaxCallBack,
data: $('#myForm').serialize(), // 直接丟表單 ID
success: function (msg) {
alert(msg);
}
});
開發階段想確認序列化出來長什麼樣子,用 alert 印一下最快:
<script src="jquery-1.7.min.js"></script>
<script>
$(function () {
$("#submit").click(function () {
alert($("#myForm").serialize());
});
});
</script>
<form id="myForm">
暱稱 <input type="text" name="username" value="admin" /><br />
密碼 <input type="password" name="password" value="admin123" /><br />
<input type="button" id="submit" value="序列化表單" />
</form>
點下按鈕後會跳出:
username=admin&password=admin123
jQuery 內部的 serialize() 基本上就是 $.param() 對 serializeArray() 的一層簡化包裝,理解這層關係,你就能自己動手改寫序列化規則。
param 是序列化的核心,負責把陣列或物件按 key/value 組字串,並處理 URL 編碼:
param: function (a) {
var s = [];
function add(key, value) {
s[s.length] = encodeURIComponent(key) + '=' + encodeURIComponent(value);
};
// 傳入陣列或 jQuery 物件時,視為表單元素集合
if (jQuery.isArray(a) || a.jquery) {
jQuery.each(a, function () {
add(this.name, this.value);
});
} else {
// 否則視為 key/value 物件
for (var j in a) {
if (jQuery.isArray(a[j])) {
// 值為陣列時,鍵名要重複出現
jQuery.each(a[j], function () {
add(j, this);
});
} else {
add(j, jQuery.isFunction(a[j]) ? a[j]() : a[j]);
}
}
}
return s.join("&").replace(/%20/g, "+");
}
單獨使用 param 的效果如下:
var obj = { a: 1, b: 2, c: 3 };
var k = $.param(obj);
alert(k); // 輸出 a=1&b=2&c=3
serializeArray 做的是同一件事的中間階段:把表單各欄位序列化成陣列結構,而不是字串。
serializeArray: function () {
return this.map(function () {
return this.elements ? jQuery.makeArray(this.elements) : this;
})
.filter(function () {
return this.name && !this.disabled &&
(this.checked || /select|textarea/i.test(this.nodeName) ||
/text|hidden|password|search/i.test(this.type));
})
.map(function (i, elem) {
var val = jQuery(this).val();
return val == null ? null :
jQuery.isArray(val) ?
jQuery.map(val, function (val) {
return { name: elem.name, value: val };
}) :
{ name: elem.name, value: val };
}).get();
}
得到的資料結構長這樣:
[{ name: 'username', value: '中國' }, { name: 'password', value: 'xxx' }]
需要的時候,你可以拿這個陣列自行加工(例如過濾掉某些欄位、加上額外參數),再交給 $.param() 轉回字串,彈性比直接用 serialize() 大得多。