DIV CSS 佈局教程網

拆解豆瓣的 jQuery 用法:約定式事件綁定機制
編輯:關於JavaScript     

豆瓣是 2.0 社區裡相當成功的一個產品,它的 Ajax 互動做得很細緻。把它的前端原始碼拿來研究,會發現頁面上大量使用 jQuery,而最有意思的是那套一體式的事件處理機制——不必為每個元素逐一寫綁定程式碼,只要依循特定的命名規則,就能自動為頁面元素掛上對應功能。搭配 jQuery 強大的選擇器,整份程式碼看起來相當簡潔清晰。

以下用 jQuery 1.2.3(壓縮後約 29KB)來看它的幾個核心部分。

事件監視器:把綁定集中管理

整套機制的起點是一個自建的命名空間與事件監視器:

// 定義命名空間
var Bowtech = new Object();

// 註冊全域的事件監視器
Bowtech.EventMonitor = function() {
    this.listeners = new Object();
}

// 廣播事件
Bowtech.EventMonitor.prototype.broadcast = function(widgetObj, msg, data) {
    var lst = this.listeners[msg];
    if (lst != null) {
        for (var o in lst) {
            lst[o](widgetObj, data);
        }
    }
}

// 綁定事件
Bowtech.EventMonitor.prototype.subscribe = function(msg, callback) {
    var lst = this.listeners[msg];
    if (lst) {
        lst.push(callback);
    } else {
        this.listeners[msg] = [callback];
    }
}

// 取消事件綁定
Bowtech.EventMonitor.prototype.unsubscribe = function(msg, callback) {
    var lst = this.listener[msg];
    if (lst != null) {
        lst = lst.filter(function(ele, index, arr) { return ele != callback; });
    }
}

// 頁面層級的事件監視器物件
var event_monitor = new Bowtech.EventMonitor();

這其實是一個手工打造的中介者(mediator)模式:訂閱、廣播、退訂三個方法各司其職,讓元件之間不必直接互相認識。

約定優於配置:靠 class 命名自動掛載

真正巧妙的是下一段。它約定:凡是 class="j a_xxx yyy"、id="xxx-123" 的元素,a_xxx 的部分用來標識要套用哪個功能(如 vote/review/blog),xxx-123 則用來取出元素自身的 ID(比如一篇帖子的編號)。對應要呼叫的,就是 Bowtech.init_vote、Bowtech.init_blog 這類函式。

function load_event_monitor(root) {
    var re = /a_(\w+)/;          // 用正則表達式取出功能名稱
    var fns = {};

    $(".j", root).each(function(i) {
        var m = re.exec(this.className);
        if (m) {
            var f = fns[m[1]];
            if (!f) {            // 若該功能尚未建立函式參照
                f = eval("Bowtech.init_" + m[1]);
                fns[m[1]] = f;   // 快取下來,下次不必再 eval
            }
            f && f(this);
        }
    });
}

// 文件載入完畢後執行
$(function() {
    load_event_monitor(document);
});

值得學的是那個 fns 快取表:同一個功能只解析一次函式參照,後續元素直接重用。用 eval 組字串取函式在今天看來並不理想,改用查表(Bowtech['init_' + m[1]])就能完全避開它,效果相同且安全得多。

還有一個實務細節:透過 Ajax 取回的內容裡如果也含動作按鈕,那批新元素並不會自動被綁定,必須針對該片段手動再呼叫一次 load_event_monitor(element)。這正是為什麼這個函式把 root 設計成參數,而不是寫死 document——這個設計讓同一套邏輯能重複套用於任何子樹上。

把 DOM 元素轉成 jQuery 物件

注意傳進 init_xxx 的 o 是原生 HTML 元素而非 jQuery 物件,所以呼叫 jQuery 方法前必須先用 $(o) 包裝一次。以「收合/展開」為例:

Bowtech.init_forder = function(o) {
    var eid = $(o).attr("id").split("-")[1];
    var fo = $("#f-" + eid);      // 收合鈕
    var unfo = $("#unf-" + eid);  // 展開鈕

    fo.click(function() {
        $(o).hide();
        unfo.show();
        fo.hide();
    });

    unfo.click(function() {
        $(o).show();
        fo.show();
        unfo.hide();
    });
}

這段程式碼把前面所有設計串了起來:從元素 id 取出編號,再用編號找到同一組的收合鈕與展開鈕,彼此不必透過全域變數溝通。

用外掛擴充 jQuery 物件

另一個值得參考的片段,是如何為文字框實作游標位置記錄與插入——這是自建編輯器時的經典難題,IE 與其他瀏覽器的 API 完全不同:

jQuery.fn.extend({
    set_caret: function() {
        if(!$.browser.msie) return;
        var initSetCaret = function() {
            this.caretPos = document.selection.createRange().duplicate()
        };
        this.click(initSetCaret).select(initSetCaret).keyup(initSetCaret);
    },

    insert_caret: function(textFeildValue) {
        var textObj = this[0];
        if(document.all && textObj.createTextRange && textObj.caretPos) {
            var caretPos = textObj.caretPos;
            caretPos.text = caretPos.text.charAt(caretPos.text.length-1) == ''
                          ? textFeildValue + '' : textFeildValue;
        } else if(textObj.setSelectionRange) {
            var rangeStart = textObj.selectionStart;
            var rangeEnd = textObj.selectionEnd;
            var tempStr1 = textObj.value.substring(0, rangeStart);
            var tempStr2 = textObj.value.substring(rangeEnd);
            textObj.value = tempStr1 + textFeildValue + tempStr2;
            textObj.focus();
            var len = textFeildValue.length;
            textObj.setSelectionRange(rangeStart + len, rangeStart + len);
            textObj.blur();
        } else {
            textObj.value += textFeildValue;
        }
    }
})

用 jQuery.fn.extend() 一次掛上多個方法,比逐個指派更整齊;三層分支則對應「IE 專用的 TextRange」、「標準的 selectionStart/selectionEnd」、以及「兩者皆無就附加到尾端」這三種情況。今天的瀏覽器環境已不需要第一段 IE 分支,標準 API 就足夠了。

前台只需遵循命名約定

整套機制寫好之後,前台要做的就只是照約定標記 class 與 id:

<div id="test2" class="mod">
    <h3>
        這裡可以放標題
    </h3>
    <div class="j modb a_forder" id="modb-1002">
        這裡是一些主要的內容
        <dl>
            <dt>Hello world</dt>
            <dd>hahaha</dd>
        </dl>
    </div>
    <div class="edit">
        <a id="f-1002" class="forder" href="javascript:void(0);">[收起]</a>
        <a id="unf-1002" class="unforder" href="javascript:void(0);">[展開]</a>
    </div>
</div>

樣式部分省略,你可以自己寫。最後附上兩張效果圖:

收起時的樣子

這套設計給我們的啟發

回頭看,豆瓣這套做法的價值不在程式碼本身,而在那個「約定優於配置」的選擇:a_xxx 這個命名約定,把「這個元素要做什麼」的資訊放進了 HTML,於是 JavaScript 不必知道頁面上有哪些元素,只要知道有哪些功能。新增一個功能模組時,前端工程師只要照約定標上 class,後端輸出 HTML 時也同樣不必改 JS。

這個思路在後來的框架裡被發揚光大——從 Angular 的 directive、React 的 data 屬性慣例,到各種以屬性驅動行為的函式庫,都能看到它的影子。而它唯一的代價是:約定一旦被破壞(拼錯 class、id 少了編號),元素就會靜默地失去功能,不會報錯。因此這類機制一定要搭配足夠的元件測試,否則出問題時會很難查。

開發環境:Windows、Visual Studio 2008、.NET Framework 2.0。

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