DIV CSS 佈局教程網

從零學會寫 jQuery 插件:三種類型、七條規範與完整示例
編輯:JQuery入門技巧     

為什麼要寫插件

寫插件的目的是把已有的方法或函數封裝起來,讓它在多個項目中可重複使用,既提升開發效率,也讓後期維護有單一的入口。本文把 jQuery 插件的類型、編寫規範和三種常見形態一次講清楚。

插件的三種類型

1、封裝對象方法

最常見的一種,把方法掛上去用於操作選擇器選出的 jQuery 對象。jQuery 內部大量方法都是这样「插」進內核的,例如 parent()、appendTo(),如今它們已是自帶 API,我們引入庫後即可直接用。

2、封裝全局函數

把獨立函數掛到 jQuery 命名空間下,例如 jQuery.ajax()、jQuery.trim()。

3、選擇器插件

雖然原生選擇器已經很強,但個別場景仍需要擴充自定義的篩選規則。

七條編寫要點

1、文件名推薦寫成 jquery.[插件名].js,避免與其他庫的插件混淆。

2、所有對象方法掛到 jQuery.fn,所有全局函數掛到 jQuery 本身。

3、插件內部的 this 指向的是當前 jQuery 對象,而不是像 click 那樣指向 DOM 元素。

4、需要遍歷元素時用 this.each。

5、所有方法、函數都以分號結尾,否則壓縮時可能出問題;穩妥起見可在文件開頭也補一個分號,防止他人的不規範代碼影響自己。

6、插件應返回 jQuery 對象,以保證鏈式調用不被打斷。

7、避免在插件內部直接使用 $ 別名以防衝突,可用閉包解決。

閉包:插件的標準外殼

利用閉包既能隔離臨時變量不污染全局,又能在內部放心使用 $:

 (function(){
     /*這裡放置代碼*/
 })();

先定義匿名函數,用括號包起來成為表達式,再以 () 立即執行。還可以傳參:

 //為了更好的兼容性,開始前有個分號
 ;(function($){
     //此處將 $ 作為匿名函數的形參
     /*這裡放置代碼,可以使用 $ 作為 jQuery 的縮寫別名*/
 })(jQuery);
 //這裡就將 jQuery 作為實參傳遞給匿名函數了

插件機制:兩個 extend

jQuery 提供了兩個擴展入口:jQuery.fn.extend() 用於擴展對象方法(實例方法),jQuery.extend() 用於擴展全局函數與選擇器。兩者都接收一個 Object 參數,其「名/值對」即「函數名/函數主體」。

【jQuery.fn.extend()】

把對象內容合併進 jQuery 原型,從而產生新的實例方法:

 <label><input type="checkbox" name="foo"> Foo</label>
 <label><input type="checkbox" name="bar"> Bar</label>
 <button id="btn1">全選</button>
 <button id="btn2">全不選</button>
 <script>
 jQuery.fn.extend({
   check: function() {
     return this.each(function() {
       this.checked = true;
     });
   },
   uncheck: function() {
     return this.each(function() {
       this.checked = false;
     });
   }
 });

 $('#btn1').click(function(){
   $( "input[type='checkbox']" ).check();
 });
 $('#btn2').click(function(){
   $( "input[type='checkbox']" ).uncheck();
 });
 </script>

【jQuery.extend()】

用一個或多個其他對象來擴展目標對象,並返回被擴展後的對象:

jQuery.extend( target [, object1 ] [, objectN ] )

例如合併 settings 與 options:

 var settings = {validate:false,limit:5,name:"foo"};
 var options = {validate:true,name:"bar"};

 var newOptions = jQuery.extend(settings,options);
 console.log(newOptions);//Object {validate: true, limit: 5, name: "bar"}

這個方法最常被用來處理插件的默認參數:

 function foo(options){
     options = jQuery.extend({ name:"bar", length:5, dataType:"xml" }, options);
 }

用戶傳了就用用戶的,沒傳就用默認值。相比傳統的逐個參數判斷,這種命名參數的方式更靈活也更簡潔;而且日後新增選項不會影響既有調用代碼。

動手寫一個:封裝對象方法的 color 插件

需求:既能設置匹配元素的顏色,也能獲取第一個匹配元素的顏色。

 ;(function(){
     jQuery.fn.extend({
         "color":function(value){
             if(value == undefined){
                 return this.css("color");
             }else{
                 return this.css("color",value);
             }
         }
     });
 })(jQuery);

仔細想想就會發現,css() 本身就自帶「傳了值就設置、沒傳值就讀取」的判斷,所以外面這層 if 是多餘的,可以精簡成:

 ;(function(){
     jQuery.fn.extend({
         "color":function(value){
             return this.css("color",value);
         }
     });
 })(jQuery);

配合一個取色器使用:

 <span id="test">測試文字</span>
 <input type="color" id="color">
 <script>
 ;(function($){
   $.fn.extend({
     "color":function(value){
       return this.css("color",value);
     }
   });
 })(jQuery);

 $('#color').on('change',function(){
   $('#test').color($(this).val());
 })
 </script>

若要一次定義一組插件,寫在同一個 extend 裡即可:

 ;(function(){
     jQuery.fn.extend({
         "color":function(value){ /*插件代碼*/ },
         "border":function(value){ /*插件代碼*/ },
         "background":function(value){ /*插件代碼*/ }
     });
 })(jQuery);

再寫一個:封裝全局函數的 ltrim / rtrim

jQuery 自帶 trim() 去兩端空格,但有時只想去掉某一側。

 ;(function($){
   $.extend({
     ltrim:function( text ){
       return (text || "").replace(/^\s+/g,"");
     },
     rtrim:function( text ){
       return (text || "").replace(/\s+$/g,"");
     }
   });
 })(jQuery);

 var $str = " test ";
 console.log($.trim($str));//'test'
 console.log($.ltrim($str));//'test '
 console.log($.rtrim($str));//' test'

此處 (text || "") 的寫法是為了防止傳入的字符串為 undefined 時 replace 報錯,是一個值得借鑑的防禦性技巧。

最後一種:自定義選擇器

jQuery 選擇器的工作原理

選擇器解析器先用一組正則表達式拆解表達式,再對每個選擇符調用對應的「選擇函數」,依返回值 true/false 決定是否保留該元素。

以 $("div:gl(1)") 為例:先取出所有 div,然後隱式遍歷,把每個 div 連同括號裡的參數一起傳給 gt 對應的函數判斷,返回 true 的保留,最終得到結果集合。

選擇函數接收三個參數:

 function (a,i,m){
     //...
 }

a 是當前遍歷到的 DOM 元素;i 是其索引,從 0 開始;m 是正則解析後得到的數組,其中最關鍵的是 m[3]——在 $("div:gl(1)") 中它就是括號裡的那個「1」。

既然 jQuery 已有 lt、gt、eq,我們來補一個「介於兩者之間」的 between。思路是把 m[3] 按逗號拆開,與索引比較,落在區間內就返回 true。

 ;(function($){
   $.extend($.expr[":"],{
     between:function(a,i,m){
       var temp=m[3].split(",");
       return +temp[0]<i && i<+temp[1];
     }
   });
 })(jQuery);

[注意] 實測中第二個參數 i 的值恆為 0,拿不到真實索引,因此需要自己造一個計數器:

 ;(function($){
   var $index = -1;
   $.extend($.expr[":"],{
     between:function(a,i,m){
       var temp=m[3].split(",");
       $index++;
       return +temp[0]<$index && $index<+temp[1];
     }
   });
 })(jQuery);

驗證一下:

 <div>
 <i>0</i>
 <i>1</i>
 <i>2</i>
 <i>3</i>
 <i>4</i>
 <i>5</i>
 </div>
 <button id="btn">測試</button>
 <script>
 ;(function($){
   var $index = -1;
   $.extend($.expr[":"],{
     between:function(a,i,m){
       var temp=m[3].split(",");
       $index++;
       return +temp[0]<$index && $index<+temp[1];
     }
   });
 })(jQuery);

 $('#btn').click(function(){
   $('i:between(1,5)').css('background','lightblue');
 });
 </script>

需要提醒的是,這種自造索引的做法依賴遍歷順序,同一個頁面裡多次調用不同區間的 between 時計數器不會重置,屬於有副作用的實現。它適合作為理解選擇器機制的練習,正式項目中更推薦用 .slice() 或 filter() 搭配 :lt / :gt 組合來達到同樣效果。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved