把表單資料整理成一段 URL 查詢字串,是前端開發裡再熟悉不過的需求。本文以實例方式梳理 jQuery serialize() 的功能定位、語法結構,以及實務上最容易踩到的幾個細節。
serialize() 會依標準 URL 編碼規則,把表單值序列化成一段文字字串,它的操作對象是代表表單元素集合的 jQuery 物件。你可以選取一個或多個表單元素(例如 input、textarea),也可以直接選取 form 元素本身。序列化後的結果,最常見的用途就是放進 AJAX 請求的查詢字串裡。
語法:
$(selector).serialize()
1. 產出的是標準 URL 編碼字串。操作對象必須是代表表單元素集合的 jQuery 物件。
2. 可以只序列化部分元素。動對象可以是 <input>、<textarea>、<select> 等個別元素,不過直接選 <form> 標籤通常更省事。
3. 只序列化「成功的控制項」。如果沒有按下提交按鈕,提交按鈕的值不會被序列化;此外,元素必須具備 name 屬性,值才會被收進字串中。
4. name 不要取 JavaScript/jQuery 的關鍵字。例如 length 就是典型的地雷。
<form id="form1"> <input name="length" type="text" value="pipi" /> <input name="blog" type="text" value="blue submarine" /> </form>
使用 $("#form1").serialize(); 時,上面這段寫法就取不到值。
$.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
說白了,serialize() 就是 $.param() 對 serializeArray() 的一層簡便封裝。
$.param() 是整個序列化機制的核心,負責把陣列或物件按 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 )
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() 會把表單中的各個欄位序列化成一個陣列。
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"
}]
理解這三層關係之後,就能依需求選擇:要字串就用 serialize(),要結構化資料就用 serializeArray(),要序列化任意物件則直接用 $.param()。