標籤:creation 網站 tar 本質 query ddc 擷取 全域對象 用法
在實際開發工作中,總會碰到像滾動,分頁,日曆等展示效果的業務需求,對於接觸過jQuery以及熟悉jQuery使用的人來說,首先想到的肯定是尋找現有的jQuery外掛程式來滿足相應的展示需求。目前頁面中常用的一些組件,都有多種jQuery外掛程式可供選擇,網路上也有很多專門收集jQuery外掛程式的網站。利用jQuery外掛程式確實可以給我們的開發工作帶來便捷,但是如果只是會簡單使用,而對其中的原理不甚瞭解,那麼在使用過程中碰到問題或者對外掛程式進行定製開發時就會有諸多疑惑。本文的目的就是可以快速瞭解jQuery外掛程式的開發原理以及掌握jQuery開發的基本技能。
進行jQuery外掛程式開發前,首先要知道兩個問題:什麼是jQuery外掛程式?jQuery外掛程式如何使用?
第一個問題,jQuery外掛程式就是用來擴充jQuery原型對象的一個方法,簡單來說就是jQuery外掛程式是jQuery對象的一個方法。其實回答了第一個問題,也就知道第二個問題的答案了,jQuery外掛程式的使用方式就是jQuery對象方法的調用。
我們先看個例子:$("a").css("color","red")。我們知道每個jQuery對象都會包含jQuery中定義的DOM操作方法,這裡使用$方法來選擇a元素,返回一個a元素的jQuery對象,這個對象就可以使用jQuery中定義的DOM操作方法。那麼jQuery對象是如何擷取這些方法的呢?其實jQuery內部定義了一個jQuery.fn對象,查看jQuery源碼可以發現jQuery.fn=jQuery.prototype,也就是說jQuery.fn對象是jQuery的原型對象,jQuery的DOM操作方法都在jQuery.fn對象上定義的,然後jQuery對象就可以通過原型繼承這些方法。
基礎版jQuery外掛程式
知道了上面這些知識,我們就可以來寫一個簡單的jQuery外掛程式。假如我現在需要一個jQuery外掛程式用來改變標籤內容顏色,就可以按下面的方式來實現這個外掛程式:
1 $.fn.changeStyle = function(colorStr){2 this.css("color",colorStr);3 }
然後按下面的方式來使用外掛程式:
$("p").changeStyle("red");
外掛程式調用的時候,外掛程式內部的this就是當前調用外掛程式的jQuery對象,這樣的話每個使用$()方法選擇的標籤,在調用changeStyle()外掛程式時都會使用css()方法重設color樣式。
滿足鏈式調用的jQuery外掛程式
鏈式調用時jQuery的一大特色,一個通用的外掛程式應該遵循jQuery風格,滿足鏈式調用要求。實現鏈式調用的方式也很簡單:
1 $.fn.changeStyle = function(colorStr){2 this.css("color",colorStr);3 return this;4 }
然後使用的時候就可以鏈式調用其他方法了:
$("p").changeStyle("red").addClass("red-color");
實現鏈式調用的關鍵點就一行代碼return this,外掛程式中加了這行代碼,那麼在外掛程式執行完之後,就會把當前的jQuery對象返回,然後就可以在外掛程式方法後面繼續調用其它jQuery方法。
防止$符號汙染的jQuery外掛程式
有很多js庫都會使用$符號,雖然jQuery可以使用jQuery.noConflict()方法交出$符號的使用權,但是如果定義外掛程式的時候,使用$.fn對象來定義的,那麼這些外掛程式使用的時候就會受到其它使用$變數的js庫的影響。對於這種情況,我們可以使用立即執行函數通過傳參的方式封裝外掛程式。形式如下:
1 (function($){2 $.fn.changeStyle = function(colorStr){3 this.css("color",colorStr); 4 return this;5 }6 }(jQuery));
因為使用了立即執行函數,所以此時的$只屬於這個立即執行函數的函數範圍,這樣就可以避免$符號的汙染。
可以接受參數的jQuery外掛程式
繼續上面的例子,假如我還想為這個外掛程式添加一個設定標籤元素內容文字大小的功能,那麼我可以這麼來實現:
(function($){ $.fn.changeStyle = function(colorStr,fontSize){ this.css("color",colorStr).css("fontSize",fontSize+"px"); return this; }}(jQuery));
上面這種外掛程式傳參方式適用於參數比較少的情況,如果需要傳給外掛程式內部的參數比較多,我們可以定義一個參數對象,然後把需要傳給外掛程式的參數放在參數對象中。外掛程式定義時如下:
1 (function($){2 $.fn.changeStyle = function(option){3 this.css("color",option.colorStr).css("fontSize",option.fontSize+"px"); 4 return this;5 }6 7 }(jQuery));
使用方式:$("p").changeStyle({colorStr:"red",fontSize:14});
把參數放到一個對象中傳給外掛程式還有一個好處就是我們可以在外掛程式內部為一些參數定義一些預設值,例如:
(function($){ $.fn.changeStyle = function(option){ var defaultSetting = { colorStr:"green",fontSize:12}; var setting = $.extend(defaultSetting,option); this.css("color",setting.colorStr).css("fontSize",setting.fontSize+"px"); return this; }}(jQuery));
上面的代碼用到了$.extend方法,這個方法在這裡的用法就是合并兩個對象,即把後面一個對象的存在的屬性值賦值給第一個對象,具體用法可以參考這裡。$.extend方法還有一種作用是用來擴充jQuery對象本身。
這樣定義的外掛程式,我們在使用時如果不傳fontSize,那麼使用這個外掛程式的jQuery對象標籤的內容會被設定成預設的12px。
使用方式:$("p").changeStyle({colorStr:"red"});
注意:在為外掛程式定義預設參數時,一定要把預設參數寫在外掛程式方法內部,這樣預設參數的範圍就在外掛程式內部。
總結
定義外掛程式的方式除了上面說的用$.fn來定義,還有另外一種方式來定義外掛程式,那就是使用$.fn.extend方法。類似下面的寫法:
1 (function($){ 2 $.fn.extend({ 3 changeStyle:function(option){ 4 var defaultSetting = { colorStr:"green",fontSize:12}; 5 var setting = $.extend(defaultSetting,option); 6 this.css("color",setting.colorStr).css("fontSize",setting.fontSize+"px"); 7 return this; 8 } 9 });10 }(jQuery));
PS:$.extend方法和$.fn.extend方法都可以用來擴充jQuery功能,通過閱讀jQuery源碼我們可以發現這兩個方法的本質區別,那就是$.extend方法是在jQuery全域對象上擴充方法,$.fn.extend方法是在$選擇符選擇的jQuery對象上擴充方法。所以擴充jQuery的公用方法一般用$.extend方法,定義外掛程式一般用$.fn.extend方法。
參考資料
jQuery源碼
How to Create a Basic Plugin
http://www.jianshu.com/p/518d424d4994
掌握jQuery外掛程式開發