DIV CSS 佈局教程網

jQuery 表單序列化與資料回填:寫一個 formHelp 外掛
編輯:關於JavaScript     

表單是後台系統的骨幹。每次提交都要一筆一筆 $("#name").val() 取值,收到後端回傳的 JSON 又要一筆一筆填回去,資料欄位一多就非常痛苦。本文實作一個輕量的 jQuery 外掛 formHelp,把「表單 → JSON」與「JSON → 表單」兩個方向都包成一行呼叫。

使用方式

取得表單資料:$("#formid").serializeJson();

把資料綁定回表單:$("#formid").setForm(json);

外掛主體:jquery.formHelp.js

 /**
 * 將 form 裡面的內容序列化成 json
 * 相同的 checkbox 用分號拼接起來
 * @param {dom} 指定的選擇器
 * @param {obj} 需要拼接在後面的 json 物件
 * @method serializeJson
 */
$.fn.serializeJson = function(otherString) {
    var serializeObj = {}, array = this.serializeArray();
    $(array).each(function() {
        if (serializeObj[this.name]) {
            serializeObj[this.name] += ';' + this.value;   // 多選值用分號串接
        } else {
            serializeObj[this.name] = this.value;
        }
    });
    if (otherString != undefined) {
        var otherArray = otherString.split(';');
        $(otherArray).each(function() {
            var otherSplitArray = this.split(':');
            serializeObj[otherSplitArray[0]] = otherSplitArray[1];
        });
    }
    return serializeObj;
};

/**
 * 將 json 物件賦值給 form
 * @param {dom} 指定的選擇器
 * @param {obj} 需要給 form 賦值的 json 物件
 * @method setForm
 */
$.fn.setForm = function(jsonValue) {
    var obj = this;
    $.each(jsonValue, function(name, ival) {
        var $oinput = obj.find("input[name=" + name + "]");
        if ($oinput.attr("type") == "checkbox") {
            if (ival !== null) {
                var checkboxObj = $("[name=" + name + "]");
                var checkArray = ival.split(";");
                for (var i = 0; i < checkboxObj.length; i++) {
                    for (var j = 0; j < checkArray.length; j++) {
                        if (checkboxObj[i].value == checkArray[j]) {
                            checkboxObj[i].click();
                        }
                    }
                }
            }
        } else if ($oinput.attr("type") == "radio") {
            $oinput.each(function() {
                var radioObj = $("[name=" + name + "]");
                for (var i = 0; i < radioObj.length; i++) {
                    if (radioObj[i].value == ival) {
                        radioObj[i].click();
                    }
                }
            });
        } else if ($oinput.attr("type") == "textarea") {
            obj.find("[name=" + name + "]").html(ival);
        } else {
            obj.find("[name=" + name + "]").val(ival);
        }
    });
};

HTML 測試頁

 <!DOCTYPE html>
<html>
<head lang="en">
<meta charset="UTF-8">
<title>jQuery FormHelp 練習</title>
<script src="https://libs.baidu.com/jquery/2.0.0/jquery.js"></script>
<script src="jquery.formHelp.js"></script>
<script type="text/javascript">
$(function() {
    $("#form").setForm({
        a: '張三家的附近可考慮將',
        b: '王五',
        c: '王五',
        d: 'nishi yaldjlkfjal ',
        e: 7,
        f: '8;10',
        i: '王'
    });
});

function submitForm() {
    console.log($("#form").serializeJson('id:12;name:13;'));
}
</script>
</head>
<body>
<form id="form">
<div><input type="text" name="a" /></div>
<div><input type="text" name="b" id="b" /></div>
<div><input type="hidden" name="c" id="c" /></div>
<div>
<textarea name="d" rows="8" cols="40"></textarea>
<input type="checkbox" name="f" value="10"/>
</div>
<div><select name="e">
  <option value="5" selected="selected">5</option>
  <option value="6">6</option>
  <option value="7">7</option>
</select></div>
<div>
<input type="checkbox" name="f" value="8" />
<input type="checkbox" name="f" value="9"/>
</div>
<div>
<input name="i" type="radio" value="王" />王
<input name="i" type="radio" value="小" />小
</div>
<div><input type="button" name="g" value="Submit" id="g" onclick="submitForm()"/></div>
</form>
</body>
</html>

實作要點與可改進之處

序列化:核心是直接借用 jQuery 內建的 serializeArray(),它會自動處理 disabled、未勾選 checkbox、未選擇的 select 等規則,比自己遍歷 DOM 可靠。同名 checkbox 以分號串接,是為了讓多選值能在單一欄位裡往返傳遞;第二個參數則提供一個「補上不在表單內的欄位」的逃生口。

回填:依 control type 分四路處理——checkbox 比對 value 後勾選、radio 比對 value 後選中、textarea 用 html()、其餘用 val()。select 因為 val() 本身就支援,落在 else 分支即可。

不過這份程式碼有幾個地方值得在正式專案中調整:

一是回填 checkbox 時用了 .click()。click 會觸發 click 事件,如果該 checkbox 綁了其他行為,回填時就會被誤觸。改用 .prop('checked', true) 只改狀態、不觸發事件,語意更準確。

二是 $("[name=" + name + "]") 是全域搜尋。若同一頁面有多個表單,或存在同名的非表單元素,就會選錯。應該改為 obj.find("[name=" + name + "]"),把範圍鎖定在當前表單內。

三是 textarea 分支用 html() 是錯的。textarea 的值必須用 val() 設定,用 html() 在部分情境下不會反映到實際的表單值上。

四是 serializeJson 的 otherString 用「字串傳遞 key:value」的設計不太友善,直接改成接受一個物件參數會更好用。

這些並不影響範例的教學價值,但如果你打算把這個外掛放進實際專案,建議先照上面四點修一版。

以上就是 jQuery 取得表單內容與回填資料的完整實作,希望對你的學習有所幫助。

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