萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 腳本程式專題 >> JavaScript

JavaScript 實現 JSON 數據自動綁定到頁面表單元素(約定 ID 對應屬性名)

核心思路

利用「約定優於配置」:**表單元素 `id` 與 JSON 對象屬性名一一對應**,遞歸遍歷 JSON,查找對應 DOM 元素並賦值。適合後端返回完整實體對象、前端表單字段固定的場景,極大減少手動賦值代碼。

前提條件

  1. 表單元素 `id` 唯一且與 JSON 屬性名**完全一致**(區分大小寫)。
  2. JSON 屬性名**不重複**(含巢狀對象內部)。
  3. 元素類型支持 `.value` 賦值(input、select、textarea 等)。

完整實現代碼

<!doctype html>
<html>
<head>
<title>JSON 自動綁定演示</title>
<script>
// 模擬後端返回的 JSON 數據
var data = {
    a: 'a1',
    b: 'b1',
    c: { c1: 'c1' },          // 巢狀對象
    d: 1,
    e: true,
    f: new Date("2012/12/24") // Date 對象 toString() 為字符串
};

/**
 * 遞歸綁定 JSON 到表單
 * @param {Object} jsonObj - 來源數據對象
 */
function bindJson(jsonObj) {
    for (var key in jsonObj) {
        if (!jsonObj.hasOwnProperty(key)) continue; // 僅自身屬性
        
        var val = jsonObj[key];
        var dom = document.getElementById(key); // 按屬性名查找元素
        
        if (dom) {
            // 統一轉字符串賦值
            dom.value = (val !== null && val !== undefined) ? val.toString() : '';
        }
        
        // 遞歸處理巢狀對象
        if (val !== null && typeof val === 'object' && !(val instanceof Date)) {
            bindJson(val);
        }
    }
}

function bindData() {
    bindJson(data);
}
</script>
<style>
input { width: 120px; height: 22px; margin: 0 10px 0 0; border: 1px solid #999; }
input:hover { border-color: #f00; }
input[type=button] { background: #efefef; height: 26px; }
</style>
</head>
<body>
<div>
    a: <input id="a" />
    b: <input id="b" />
    c.c1: <input id="c1" /> <!-- 巢狀屬性 c1 直接作為 id -->
    d: <input id="d" />
    e: <input id="e" />
    f: <input id="f" />
    <input type="button" value="綁定數據" id="btnBind" onclick="bindData()" />
</div>
</body>
</html>

關鍵點解析

  1. 遞歸遍歷:`for...in` + `hasOwnProperty` 確保只處理自身屬性。
  2. DOM 查找:`document.getElementById(key)` 利用 ID 唯一性快速定位。
  3. 值轉字符串**:`val.toString()` 統一處理數字、布爾、Date 等類型。`null/undefined` 轉為空串。
  4. 跳過 Date 對象遞歸**:`!(val instanceof Date)` 防止將 Date 視為普通對象遍歷其屬性(如 `getTime` 等方法)。
  5. 巢狀對象扁平化 ID**:示例中 `c.c1` 對應 `id="c1"`,要求後端/前端協商扁平化命名策略(如 `c_c1`、`c.c1` 不合法 ID)。

進階增強版(支持數組、自定義映射、類型轉換)

function bindForm(formSelector, data, options) {
    options = Object.assign({
        // 自定義屬性名 -> 元素選擇器 映射
        fieldMap: {},
        // 類型轉換器
        transformers: {
            date: function(v) { return v ? new Date(v).toLocaleDateString() : ''; },
            boolean: function(v) { return v ? '是' : '否'; }
        }
    }, options);
    
    var $form = $(formSelector);
    
    function setValue(el, value, key) {
        var $el = $(el);
        var tag = el.tagName.toLowerCase();
        var type = $el.attr('type');
        
        // 應用轉換器
        if (options.transformers[key] && typeof options.transformers[key] === 'function') {
            value = options.transformers[key](value);
        }
        
        if (tag === 'input') {
            if (type === 'checkbox') el.checked = !!value;
            else if (type === 'radio') $form.find('input[name="' + el.name + '"][value="' + value + '"]').prop('checked', true);
            else el.value = value;
        } else if (tag === 'select') {
            el.value = value;
        } else if (tag === 'textarea') {
            el.value = value;
        } else {
            $el.text(value); // span/div 等顯示用
        }
    }
    
    function bind(obj, prefix) {
        prefix = prefix || '';
        for (var key in obj) {
            if (!obj.hasOwnProperty(key)) continue;
            var fullKey = prefix + key;
            var val = obj[key];
            var selector = options.fieldMap[fullKey] || '#' + fullKey;
            var els = $form.find(selector);
            
            if (els.length) {
                els.each(function() { setValue(this, val, fullKey); });
            }
            
            if (val !== null && typeof val === 'object') {
                if (Array.isArray(val)) {
                    // 數組:可渲染列表、表格,這裡簡單跳過
                } else if (!(val instanceof Date)) {
                    bind(val, fullKey + '_'); // 巢狀對象加前綴避免 ID 衝突
                }
            }
        }
    }
    
    bind(data);
}

適用場景與局限

  • ✅ 後台管理系統:增/改詳情頁、數據回顯。
  • ✅ 固定字段表單、字段數較多(20+)時極大減少樣板代碼。
  • ❌ 高度動態表單、字段名不固定、複雜嵌套數組渲染 → 改用 Vue/React + 表單庫。
  • ❌ 大量只讀展示頁 → 直接模板渲染更簡潔。
copyright © 萬盛學電腦網 all rights reserved