幫 jQuery 擴充自訂方法時,若想同時維護一個狀態變數,會發現「值怎麼存都不對」。這篇文章用三段遞進的程式碼說明原因與正解。
jQuery.fn.extend({
myOwnMember: 3,
getMyOwnMember: function () { return this.myOwnMember; },
setMyOwnMember: function (v) { this.myOwnMember = v; return this.myOwnMember; }
});
$("body").myOwnMember; // 3
$("body").getMyOwnMember(); // 3
$("body").setMyOwnMember(4);// 4
$("body").getMyOwnMember(); // 3 ← 竟然還是 3!
setMyOwnMember 明明回傳了 4,再一次取值卻是初始的 3。原因在於:$("body") 每次執行都會建立一個全新的 jQuery 物件。第二次呼叫時是一個從未被設值過的新物件,myOwnMember 自然還是原型上的 3。
jQuery.fn.extend({
myOwnMember: 3,
getMyOwnMember: function () { return this.myOwnMember; },
setMyOwnMember: function (v) { this.myOwnMember = v; return this.myOwnMember; }
});
var body = $("body");
body.myOwnMember; // 3
body.getMyOwnMember(); // 3
body.setMyOwnMember(4); // 4
body.getMyOwnMember(); // 4 ← 這次對了
因為 $("body") 只建立了一次,後續都是透過 body 這個變數參考同一個物件,狀態才留得住。
問題是,實務上不總能拿到同一個變數。很多時候程式各處都在呼叫 $("body"),狀態就又分家了。真正的解法是不要把狀態存在 jQuery 物件上,而是存在 DOM 元素上——因為無論你建立多少個 jQuery 物件包裝它,底層指向的都是同一個 DOM 節點。
jQuery.fn.extend({
getMyOwnMember: function () {
return this[0].myOwnMember;
},
setMyOwnMember: function (v) {
this[0].myOwnMember = v;
return this[0].myOwnMember;
}
});
$("body").getMyOwnMember(); // undefined
$("body").setMyOwnMember(4);// 4
$("body").getMyOwnMember(); // 4 ← 無論呼叫幾次都一致
this[0] 就是這個 jQuery 物件包裝的第一個原生 DOM 元素。把值掛在它上面,狀態就跟元素綁在一起了。
直接往 DOM 元素上掛自訂屬性雖然可行,但有兩個缺點:可能與他人或其他程式庫的命名衝突,以及在多元素集合上 this[0] 只會作用到第一個。jQuery 早就提供了專門的資料儲存機制:
jQuery.fn.extend({
getMyOwnMember: function () {
return this.data('myOwnMember');
},
setMyOwnMember: function (v) {
return this.data('myOwnMember', v);
}
});
.data() 內部維護的是一個全域的資料表,用元素的唯一標識(uid)當索引,因此不會污染 DOM 元素本身,也能對集合中的每一個元素各自保存狀態。同時它還能自動把 "4" 這種字串轉型成數字,取出時型別較符合預期。
把上面學到的整合起來,一個可重複初始化、狀態獨立的插件長得像這樣:
(function($){
var DATA_KEY = 'myPlugin';
var defaults = { speed: 400 };
function Plugin(el, options){
this.el = el;
this.$el = $(el);
this.opts = $.extend({}, defaults, options);
this.count = 0; // 狀態存在「每一個實例」上
}
Plugin.prototype.increment = function(){
this.count++;
return this.count;
};
$.fn.myPlugin = function(option){
return this.each(function(){
var $this = $(this);
var inst = $this.data(DATA_KEY);
if (!inst) {
inst = new Plugin(this, typeof option === 'object' ? option : {});
$this.data(DATA_KEY, inst); // 實例存進 data
}
if (typeof option === 'string' && typeof inst[option] === 'function') {
inst[option]();
}
});
};
})(jQuery);
這樣一来,$('#el').myPlugin('increment') 永遠作用在同一個實例上,狀態不會因為重新選取而遺失——這也是官方在〈Basic Plugin Creation〉教學裡推薦的寫法。