學 jQuery 時如果只停留在「能用」,很容易在擴充環節卡住。最常見的困惑就是這兩行看起來幾乎一樣的程式碼,行為卻完全不同:
jQuery.extend(object); jQuery.fn.extend(object);
· jQuery.extend(object):擴充 jQuery 類本身,為類新增靜態方法。
· jQuery.fn.extend(object):為 jQuery 物件(實例)新增方法。
關鍵在於 jQuery.fn 是 jQuery.prototype 的別名。往 prototype 上掛東西,所有由 $() 產生的實例都能用;直接往 jQuery 上掛,則只有透過 $.xxx 這種靜態呼叫方式才能取用。
$.extend({
add: function(a, b){ return a + b; }
});
這行為 jQuery 加上一個名為 add 的「靜態方法」,之後在引入 jQuery 的地方都能呼叫:
$.add(3, 4); // 回傳 7
因為 jQuery.fn = jQuery.prototype,寫 $.fn.close 等同於為 jQuery 類新增一個成員函式,jQuery 實例可以使用它:
$.fn.close = function(){ /* ... */ }
而 $.close = function(){} 則是靜態版本。兩者最明顯的差異在呼叫方式:
$('#test').close(); // 實例方法:需要有選到的元素
$.close(); // 靜態方法:不綁定任何元素集合
寫自製插件時,判斷該用哪一種,取決於你的功能需不需要「作用在一組元素上」:
· 需要遍歷/操作選到的元素 → 用 $.fn.extend,並在裡面用 return this.each(...) 保持鏈式呼叫。
· 只是提供工具函式(格式化日期、驗證字串、AJAX 封裝)→ 用 $.extend,因為它跟具體選到的元素無關。
// 插件型:作用於元素集合,可鏈式呼叫
$.fn.highlight = function(color){
return this.each(function(){
$(this).css('background-color', color || '#ff0');
});
};
$('#box').highlight().addClass('active');
// 工具型:不綁元素
$.extend({
isEmail: function(str){
return /^[^\s@]+@[^\s@]+\.[^\s@]+$/.test(str);
}
});
$.isEmail('a@b.com'); // true
補充一個實作細節:$.extend() 若只傳一個物件參數,是把該物件的屬性合併進 jQuery;若傳入兩個以上參數 $.extend(target, obj1, obj2),則是把後者合併進前者並回傳 target。這個「深拷貝」行為(第一個參數傳 true 時遞迴合併)也是它常被拿來做物件合併的原因,與 plugin 擴充是兩種不同用途的同一支函式。