DIV CSS 佈局教程網

不寫一行初始化 JS:用 data-* 屬性直接啟動組件
編輯:關於JavaScript     

用 Bootstrap 時常有一種煩躁:明明只是要從後端取幾筆資料填進 select,卻得在 $(document).ready 裡寫一堆幾乎一樣的初始化程式碼。頁面一多,那些重複的片段看起來格外刺眼。Bootstrap Table 早就示範了另一條路——把設定寫在 HTML 的 data-* 屬性上。本文就來研究它是怎麼做到的。

先看 Bootstrap Table 的文件:

幾乎所有屬性與事件都能用 data-* 表達。那麼這個機制從哪裡來?

一、先認識 jQuery 的 data()

查了一圈才找到出處:這是 jQuery 與 HTML5 合作的成果。原始用法很樸素:

作用一目了然:幫元素掛上資料,或把資料取出來。而它與 HTML5 的 data-* 屬性能直接互通:

也就是說,寫在標籤上的 data-* 值,可以用 data() 讀出來。規則只有三條:

  • 屬性必須以 data- 開頭
  • 多個單字用 - 分隔
  • 用 jQuery 取值時,去掉 data- 前綴與分隔線,並轉成駝峰式命名

有了這個基礎,「在標籤上寫設定、在 JS 裡讀設定」就成立了。

二、讓 data-* 直接初始化 combobox

延續先前封裝的 combobox 組件(可透過 url 從後端取資料),這次讓它能靠 data-* 啟動。

1. 組件程式碼

 (function ($) {
    // 1. 定義 jQuery 擴展方法 combobox
    $.fn.combobox = function (options, param) {
        // 傳入字串代表呼叫方法
        if (typeof options == 'string') {
            return $.fn.combobox.methods[options](this, param);
        }

        // 2. 合併呼叫時傳入的參數與預設參數
        options = $.extend({}, $.fn.combobox.defaults, options || {});

        // 3. 套用預設值
        var target = $(this);
        target.attr('valuefield', options.valueField);
        target.attr('textfield', options.textField);
        target.empty();

        var option = $('<option></option>');
        option.attr('value', '');
        option.text(options.placeholder);
        target.append(option);

        // 4. 有 data 就直接用,沒有才發 ajax
        if (options.data) {
            init(target, options.data);
        } else {
            options.onBeforeLoad.call(target, options.param);
            if (!options.url) return;
            if (typeof options.param == "string") {
                options.param = JSON.parse(options.param);
            }
            $.getJSON(options.url, options.param, function (data) {
                init(target, data);
            });
        }

        function init(target, data) {
            $.each(data, function (i, item) {
                var option = $('<option></option>');
                option.attr('value', item[options.valueField]);
                option.text(item[options.textField]);
                target.append(option);
            });
            options.onLoadSuccess.call(target);
        }

        target.unbind("change");
        target.on("change", function (e) {
            if (options.onChange) return options.onChange(target.val());
        });
    };

    // 5. 傳入字串時代表呼叫方法
    $.fn.combobox.methods = {
        getValue: function (jq) {
            return jq.val();
        },
        setValue: function (jq, param) {
            jq.val(param);
        },
        load: function (jq, url) {
            $.getJSON(url, function (data) {
                jq.empty();
                var option = $('<option></option>');
                option.attr('value', '');
                option.text('請選擇');
                jq.append(option);
                $.each(data, function (i, item) {
                    var option = $('<option></option>');
                    option.attr('value', item[jq.attr('valuefield')]);
                    option.text(item[jq.attr('textfield')]);
                    jq.append(option);
                });
            });
        }
    };

    // 6. 預設參數
    $.fn.combobox.defaults = {
        url: null,
        param: null,
        data: null,
        valueField: 'value',
        textField: 'text',
        placeholder: '請選擇',
        onBeforeLoad: function (param) {},
        onLoadSuccess: function () {},
        onChange: function (value) {}
    };

    // 這段是新加的:頁面初始化完成後自動掃描並啟動
    $(document).ready(function () {
        $('.combobox').each(function () {
            var $combobox = $(this);
            $.fn.combobox.call($combobox, $combobox.data());
        });
    });
})(jQuery); 

其餘部分和前一版幾乎相同,重點只在最末尾這段:

 $(document).ready(function () {
    $('.combobox').each(function () {
        var $combobox = $(this);
        $.fn.combobox.call($combobox, $combobox.data());
    });
}); 

它在頁面就緒後,用樣式選擇器找出所有帶 .combobox 的元素,逐一初始化。若有十個下拉框,就初始化十次,完全不必為每一個寫一行 JS。而 $combobox.data() 取得的,正是該元素上所有的 data-* 屬性,直接當成參數物件傳進去。

2. HTML 端只剩標籤

 <select id="Search_" name="Search_province" class="form-control combobox"
        data-url="/Home/GetProvince"
        data-param='{"type":"0"}'
        data-text-field="Name"
        data-value-field="Id">
</select> 

這裡有個硬性約定:既然靠 .combobox 這個 class 來識別,那麼想使用 data-* 初始化的元素就必須帶上 class="combobox",否則掃描不到。

3. 後端提供資料

 public class HomeController : Controller
{
    public List<string> lstProvince = new List<string>() {
        "北京市", "天津市", "重慶市", "上海市", "河北省", "山西省", "遼寧省",
        "吉林省", "黑龍江省", "江蘇省", "浙江省", "安徽省", "福建省", "江西省",
        "山東省", "河南省", "湖北省", "湖南省", "廣東省", "海南省", "四川省",
        "貴州省", "雲南省", "陝西省", "甘肅省", "青海省", "台灣省",
        "內蒙古自治區", "廣西壯族自治區", "西藏自治區", "寧夏回自治區",
        "新疆維吾爾自治區", "香港特別行政區", "澳門特別行政區"
    };

    public JsonResult GetProvince(string type)
    {
        var lstRes = new List<Province>();
        for (var i = 0; i < 10; i++)
        {
            var oModel = new Province();
            oModel.Id = i;
            oModel.Name = lstProvince[i];
            lstRes.Add(oModel);
        }
        return Json(lstRes, JsonRequestBehavior.AllowGet);
    }
}

public class Province
{
    public int Id { get; set; }
    public string Name { get; set; }
} 

4. 除錯與結果

最終效果:

這套做法的價值與界線

它的價值很直接:宣告式的設定比命令式的初始化更接近 HTML 的本意,也讓「這個下拉框從哪裡取資料」變成一眼可見的資訊,而不是埋在幾百行 JS 裡的一行。

界線也要說清楚。第一,data-* 是 HTML5 特性,舊瀏覽器支援度有限。第二,data-param 裡塞 JSON 字串時,屬性值必須用單引號包住,否則雙引號會與 HTML 屬性打結——這個小細節很容易出錯。第三,它適合簡單組件,複雜設定還是留在 JS 裡更好讀。

但對於「從後端撈幾筆資料填進下拉框」這類需求,這個模式確實能把大量重複程式碼清空。

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