用 jQuery UI 的 widget 工廠開發元件寫久了,會累積出一批不成文的慣例。以下七點都是實作中踩過或想通之後才回頭調整的細節,對效能與可維護性都有實際幫助。
同一個 jQuery 物件上可能同時掛載兩個 widget,如果兩者都綁了名稱相同的事件(例如兩者都監聽 click),就會互相干擾。解法是替事件加上以 widget 名稱組成的命名空間:
this.element
.bind("click.mywidget", $.proxy(this._onClick, this))
.bind("mouseover.mywidget", $.proxy(this._onHover, this));
好處在銷毀時特別明顯——不需要逐一記得每個事件名,一句話就能全部解除:
this.element.unbind(".mywidget");
jQuery 物件支援連寫,能省下大量重複的 selector 查詢:
$(obj).css("height", "20px").attr("title", "abc").addClass("active");
JavaScript 的函式本身就是物件的值,因此可以拿屬性名稱動態組出方法名,把冗長的 switch 壓成一行:
// 原本
switch (a) {
case "aa": this._set_aa(); break;
case "bb": this._set_bb(); break;
case "cc": this._set_cc(); break;
}
// 之後
this["_set_" + a]();
這種寫法在分支數量多、且每個分支都是呼叫對應方法時特別清爽。要注意的是若 a 可能出現未預期的值,得先加上存在性檢查,否則會丟出 TypeError。
每次 $("#id") 都要走一遍 selector 引擎。在 widget 的 _create 階段把常用節點存成 this 的屬性,後續直接取用,是最基本的效能優化:
_create: function(){
this.$title = this.element.find(".title");
this.$body = this.element.find(".body");
}
程式碼壓縮工具在面對 this 時通常無法最佳化,因為它的語意由呼叫方式決定。把 this 存進區域變數(慣例是 var self = this;)後,壓縮器就能一併處理這個變數名,讓最小化後的體積更小。
_refresh: function(){
var self = this;
setTimeout(function(){ self._update(); }, 100);
}
類名字串散落在程式各處時,一旦設計稿調整命名,就得全域搜尋取代。把它集中定義成一個變數或常數物件,日後只改一處:
var CLS = {
wrapper: "mywidget-wrapper",
active: "mywidget-active",
hidden: "mywidget-hidden"
};
// 使用處
this.element.addClass(CLS.active);
附带的好處是字串重複利用後,最小化時能進一步縮小檔案。
這是最容易出錯的一點。當某個 option 的值是物件而非單純的數值時,直接指派會把整個舊值覆蓋掉:
var a = { width: 120, height: 200 };
var c = { width: 200 };
a = c; // a 變成 {width: 200},height 當場消失
a = $.extend(a, c); // 這裡 a 已經是 c 本身,同樣會遺失 height
正確做法是先保留原值再合併:
_setOption: function(key, value){
if (key === "style" && $.isPlainObject(value)) {
this.options.style = $.extend({}, this.options.style, value);
} else {
this.options[key] = value;
}
this._refresh();
}
關鍵在 $.extend({}, 舊值, 新值):第一個參數給空物件作為目標,才不會污染到原本的設定,同時新值會覆蓋舊值的同名鍵、保留舊值的其他鍵。
雖然不在此次七點之列,但實務上同樣關鍵。destroy 時應該解除所有事件綁定、移除動態產生的節點、刪掉存在 element 上的資料,最後呼叫原型上的 destroy,否則元件反覆建立與銷毀會造成 DOM 節點與記憶體的持續累積。