DIV CSS 佈局教程網

從零寫一個 jQuery 插件:靜態方法與元素方法的兩種擴充方式
編輯:JavaScript綜合知識     

用 jQuery 用了很久,卻連插件都不會寫,這件事說出去有點不好意思。其實寫插件比想像中簡單,而且過程中會順便搞懂 jQuery 源碼裡那些 extend 到底在幹嘛。

起點:JavaScript 對象就是這麼隨意

JavaScript 是很自由的語言,想怎麼寫就怎麼寫。看這段:

var jQuery = new Object();   // 或者 var jQuery = {};
jQuery.method = function (args) {
  alert("hello, " + args);
};
jQuery.method("Henry");      // 弹出 hello, Henry

夠直白吧。所以你自然會想到,引入 jQuery 之後直接這樣幹:

<script language="javascript" src="jquery.js"></script>
<script language="javascript">
jQuery.method = function () {
  alert("hello, this is my defined method");
};
jQuery.method();
</script>

效果如你所願。但這不是最好的做法,因為一個好的框架一定留了擴充介面給你,應該用它。

正解:用 extend 掛靜態方法

jQuery.extend({
  method: function () {
    alert("hello, this is my defined method");
  }
});
jQuery.method();

效果一樣,但好在哪裡?當你的函式需要參數,而呼叫的人可能不傳時,你就能用預設值把缺口補起來:

jQuery.extend({
  method: function (options) {
    var defaults = {
      name: "Henry",
      sex:  "male"
    };
    jQuery.extend(defaults, options);   // 使用者傳的會覆蓋預設值
    alert("hello, " + defaults.name + ", you are " + defaults.sex);
  }
});

jQuery.method();                              // hello, Henry, you are male
jQuery.method({ name: "yourname", sex: "x" }); // 使用傳入值

這個「defaults + extend(options)」的組合,是後來所有 jQuery 插件千篇一律的起手式,源頭就在這裡。

另一種:擴充元素方法

上面是靜態方法的擴充,不必選任何元素,直接用 jQuery 類呼叫。如果你想寫的是 $(...).myMethod() 這種作用在選中元素上的方法,只要把 jQuery.extend() 換成 jQuery.fn.extend():

jQuery.fn.extend({
  method: function (options) {
    var defaults = {
      name: "Henry",
      sex:  "male"
    };
    jQuery.extend(defaults, options);
    alert("hello, " + defaults.name + ", you are " + defaults.sex);
    return $(this);   // 別忘了返回自己,才能鏈式呼叫
  }
});

$('#demo').method({ name: "Jim" }).css('color', 'red');

兩個一定要記住的細節

  • jQuery.extend vs jQuery.fn.extend:前者擴充靜態方法(jQuery.xxx()),後者擴充原型方法($().xxx())。jQuery.fn 就是 jQuery.prototype,這點讀過源碼的人會很有感。
  • return this:$().method().css() 這種鏈式寫法能成立,就是因為每個方法都把 this 還回去了。少了這行,後面接 anything 都會出錯。

再往下一層,還會遇到每個元素都要跑一次時的 this.each(function(){ ... }) 寫法,以及避免全域名稱污染的 (function($){ ... })(jQuery) 閉包包裝。把這幾塊拼起來,就是你在 npm 上看到的那些正規插件的骨架。

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