寫過一陣子 jQuery 之後,把常用邏輯沉澱成外掛是必經之路。本文從外掛的分類講到執行機制,再逐一動手實作。
把方法掛到 jQuery 物件上,用來操作由選擇器取得的元素集合,這是最常見的一種。它能充分發揮選擇器的威力,jQuery 內建的方法中有很大一部分正是用這種形式掛進核心的,例如 parent()、appendTo()。
把獨立函式掛到 jQuery 命名空間下,例如 jQuery.ajax()、用來去除前後空白的 jQuery.trim(),都屬於這一類。
jQuery 選擇器已經很強,但總有少數場景需要擴充自訂語法,這時就轮到選擇器外掛出場。
機制其實非常單純,靠的就是 jQuery 提供的兩個方法:
jQuery.fn.extend(object); jQuery.extend(object);
jQuery.fn.extend() 主要用來擴充第一類外掛,jQuery.extend() 則負責後兩類。兩者都只接受一個 Object 型別的參數,物件的「名稱/值」對分別代表「函式名稱/函式主體」。
jquery.[外掛名].js,避免與其他函式庫的外掛混淆。jQuery.fn 上,所有全域函式都掛在 jQuery 本體上。jQuery.extend() 設定預設參數,能明顯提升外掛可用性。
;(function($){
/* 外掛程式碼放這裡,可把 $ 當成 jQuery 的別名 */
})(jQuery);
功能:設定所選元素的顏色,或取得首個元素的顏色。
思路:設計一個 value 參數,有傳值就是設定,沒傳值就是取得,兩者都可交由 jQuery 的 css() 方法完成。
;(function($){
$.fn.extend({
"color":function(value){
if(value==undefined){
return this.css("color");
}
else{
return this.css("color",value);
}
}
});
})(jQuery);
由於 css() 在取值時本身已有「只取第一個元素」的判斷,這裡直接寫 this.css("color") 即可。
若一次要掛多個方法,用逗號串接即可:
;(function($){
$.fn.extend({
"color":function(value){
//外掛程式碼
},
"border":function(value){
//外掛程式碼
},
"background":function(value){
//外掛程式碼
}
});
})(jQuery);
測試頁:https://demo.jb51.net/js/2012/jquery_demo/封裝jQuery對象方法插件Demo.html
功能:單獨去除左側或右側空白。
;(function($){
$.extend({
ltrim:function(text){
return (text||"").replace(/^\s+/g,"");
},
rtrim:function(text){
return (text||"").replace(/\s+$/g,"");
}
});
})(jQuery);
這類外掛是在 jQuery 命名空間內新增函式,用正則表達式就能搞定。
測試頁:https://demo.jb51.net/js/2012/jquery_demo/封裝全局函數jQuery插件Demo.html
先理解 jQuery 選擇器的運作原理:解析器會先以一組正則表達式拆解選擇器字串,接著針對每個選擇符號執行對應的「選擇函式」,最後依函式回傳 true 或 false 決定是否保留該元素。
以 $("div:gt(1)") 為例,它會先取出所有 <div>,然後隱式遍歷,把每個元素連同括號內的參數一起丟給 gt 對應的選擇函式判斷,回傳 true 就保留,否則剔除。
選擇函式共接受三個參數:
function (a, i, m){
//...
}
m[3],在 $("div:gt(1)") 中即為括號內的內容。jQuery 已有 lt、gt、eq,於是這裡補一個「介於兩者之間」的 between。
思路:m[3] 是 "a,b" 的形式,用逗號切開後與索引 i 比較,落在範圍內就回傳 true。
;(function($){
$.extend($.expr[":"],{
between:function(a,i,m){
var temp=m[3].split(",");
return +temp[0]<i&&i<+temp[1];
}
});
})(jQuery);
這裡用 +temp[0]、+temp[1] 把字串形式的數字轉為真正的數字型別。
測試頁:https://demo.jb51.net/js/2012/jquery_demo/jQuery自定義選擇器插件DEMO.html
本文說明了 jQuery 外掛的分類與底層機制,並針對三種類型各做了一次實戰。掌握 jQuery.fn.extend() 與 jQuery.extend() 的差異,你就能把重複的樣板邏輯收攏成可重複使用的能力。
參考書籍:《銳利的 jQuery》(人民郵電出版社)