用 Ajax 送出表單時,我們往往需要把一堆 input 拼成 key=value&key2=value2 的形式。手動一欄一欄取值既冗長又容易出錯,而 jQuery 的 serialize() 正好把這件事簡化成一行。
serialize() 會把表單元素集合序列化成一段標準 URL 編碼的字串,操作對象是代表表單元素集合的 jQuery 物件。你可以選取單個或多個表單元素(例如 input、textarea),也可以直接選 <form> 本身。序列化後的結果,最常見的用途就是放進 Ajax 請求的 query string 裡。
語法:
$(selector).serialize()
.serialize() 產生的是標準 URL 編碼格式的純文字字串。<input>、<textarea>、<select>;不過直接選 <form> 通常更省事。例如 length 就是一個容易踩雷的 name:
<form id="form1">
<input name="length" type="text" value="pipi" />
<input name="blog" type="text" value="blue submarine" />
</form>
// $("#form1").serialize();
上面這段程式碼會取不到值,把 name 改成其他名稱即可避開衝突。
$.ajax({
type: "POST",
dataType: "json",
url: ajaxCallBack,
data: $('#myForm').serialize(), // 要提交表單的 ID
success: function(msg) {
alert(msg);
}
});
<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
$.param() 才是 serialize() 的核心,負責把陣列或物件按 key/value 序列化。
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 );
});
// 否則視為 key/value 物件
else
for ( var j in a )
// 若值為陣列,key 名稱需重複出現
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, "+");
}
使用方式:
var obj = {a: 1, b: 2, c: 3};
var k = $.param(obj);
alert(k); // 輸出 a=1&b=2&c=3
serializeArray 會把表單中各欄位序列化成一個陣列,每個元素都是 {name, value} 的物件。
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, i){
return {name: elem.name, value: val};
}) :
{name: elem.name, value: val};
}).get();
}
輸出的資料結構長得像這樣:
[ { name: username, value: 中國 }, { name: password, value: xxx } ]
實務上的選擇很單純:要直接丟給 Ajax 的查詢字串就用 serialize(),需要自己加工處理資料就改用 serializeArray()。