寫 jQuery 插件的目的,是把我們常用的一系列方法或函式做一個封裝,以便在其他地方重複使用、方便後期維護。jQuery 除了提供簡單有效的方式來管理元素與腳本,還提供了一套擴充機制:讓我們能替核心模組加上自己的方法與額外功能。透過這種機制,我們可以建立屬於自己的插件,顯著提升開發效率。
本文整理了三份值得參考的資料:CodeProject 上的 How to write plugin in Jquery、《鋒利的 jQuery》一書,以及 RascallySnake 的 jQuery.extend() 詳解。
(1)封裝物件方法的插件(物件層級開發)——這是我們本文要重點說明的類型。
(2)封裝全域函式的插件(類別層級開發)——把獨立的函式掛到 jQuery 命名空間之下。定義方式很簡單:
jQuery.foo = function() {
alert('This is a test. This is only a test.');
};
也可以一次加上多個全域函式:
jQuery.foo = function() {
alert('This is a test. This is only a test.');
};
jQuery.bar = function(param) {
alert('This function takes a parameter, which is "' + param + '".');
};
呼叫方式和一般函式一樣:jQuery.foo();、jQuery.bar();,或寫成別名的 $.foo();、$.bar('bar');。
(3)選擇器插件——用來擴充 jQuery 的選擇器能力。
1. 插件的建議命名方式為 jquery.[插件名].js。
2. 所有物件方法都應附加到 jQuery.fn 上,所有全域函式則應附加到 jQuery 物件本身。
3. 在插件內部,this 指向的是透過選擇器取得的 jQuery 物件,而不像一般方法那樣指向 DOM 元素。
4. 可以透過 this.each 來遍歷所有元素。
5. 所有方法或函式插件都應以分號結尾,否則壓縮時可能出問題。更保險的做法是在插件開頭也加上一個分號,以免別人的不規範程式碼影響到你的插件。
6. 插件應回傳一個 jQuery 物件,以保證可鏈式操作。
7. 避免在插件內部使用 $ 作為 jQuery 的別名,而應使用完整的 jQuery,以避免衝突。
① jQuery.fn.extend()——對應上面第一種類型(物件層級)。
② jQuery.extend()——對應後兩種類型(類別層級)。
jQuery.extend() 在插件開發中還有一個很重要的功能:擴充既有的物件。
var newSrc = $.extend(dest, src1, src2, src3...)
它的含義是把 src1、src2、src3……合併進 dest,回傳值為合併後的 dest。
例如:
var result = $.extend({}, {name:"Tom", age:21}, {name:"Jerry", sex:"Boy"});
得到的結果是:
result = {name:"Jerry", age:21, sex:"Boy"}
注意後者(Jerry)覆蓋了前者的 name,而 age 則被保留下來——這正是後面實作「預設值+使用者自訂」的關鍵。
雖然 jQuery 命名空間已經禁止大量使用 JavaScript 的函式名與變數名,但仍無法完全避免某些名稱與其他插件衝突。因此習慣上會把方法封裝到另一個自訂的命名空間中:
jQuery.myPlugin = {
foo: function() {
alert('This is a test. This is only a test.');
},
bar: function(param) {
alert('This function takes a parameter, which is "' + param + '".');
}
};
採用命名空間的函式仍然是全域函式,呼叫方式如下:
$.myPlugin.foo();
$.myPlugin.bar('baz');
要寫一個 jQuery 插件,你需要在 $.fn 物件後面增加一個屬性名,這個屬性名就是你的插件名。一般框架如下:
(function( $ ) {
$.fn.myPlugin = function() {
// 在這裡開始寫功能
};
})( jQuery );
外面那層立即執行函式有兩個作用:一是把 jQuery 傳進來當作 $ 使用,在插件內部就能安心用 $;二是創造一個獨立的作用域,插件內部的變數不會污染全域。
我們要寫的功能很簡單:把一個物件慢慢隱藏起來,也就是使用 fadeOut()。
新建一個 js 檔並命名為 MyPlugin.js,寫入:
(function ($) {
$.fn.myPlugin = function () {
this.fadeOut('normal');
};
})(jQuery);
怎麼用呢?很簡單。新建一個 html 頁面,把 jQuery 與剛才的 MyPlugin.js 都引入:
<script src="Scripts/jquery-1.4.1.js" type="text/javascript"></script> <script src="MyPlugin.js" type="text/javascript"></script>
接著寫觸發的程式碼:
<script type="text/javascript">
$(document).ready(function () {
$("#btn1").click(function () {
$("#div1").myPlugin();
});
});
</script>
HTML 部分:
<div id="div1" style="width: 400px; height: 30px; background-color: Gray;"> My God </div> <input id="btn1" type="button" value="button" />
現在點擊網頁上的按鈕,div 就會緩緩隱藏起來——因為我們設定的是 normal,這個參數也可以換成 'slow'、'fast' 或具體的毫秒數。
寫在 $.fn 上的方法還有一個好處:編輯器能給出智慧提示,如下圖。

前面第七點提到,若要遍歷則可以用 this.each 方法。$("ID").each 可以遍歷 jQuery 物件、陣列以及集合。
新的程式碼如下:
(function ($) {
$.fn.hoverElement = function () {
this.each(function () {
$(this).hover(
function () {
$(this).addClass("Add");
},
function () {
$(this).removeClass("Remove");
}
);
});
};
})(jQuery);
主要用到的就是 .each() 做遍歷,程式碼很簡單:把目前物件的背景樣式在 "Add" 與 "Remove" 兩個 class 之間切換。
HTML:
<div class="hoverText">First Button..</div> <div class="hoverText">Second Button..</div> <div class="hoverText">Third Button..</div>
JavaScript:
<script type="text/javascript">
$(document).ready(function () {
$(".hoverText").hoverElement();
});
</script>
鏈式操作大家都聽過吧?比如下面這一句:
$("#div1").css("color", "red").addClass("Add").animate({"width":"100px"}, 1000);
能在目前的元素後面透過「.」實施更多操作,這個動作特別瀟灑。
要怎麼實現這種效果呢?很簡單,我們只需要把物件「回傳」出去就可以了。請注意前面第六點:插件應回傳一個 jQuery 物件,以保證可鏈式操作。
我們依舊看剛才的例子,唯一的差別是在 this.each 前面加了一個 return:
(function ($) {
$.fn.hoverElement = function () {
return this.each(function () {
$(this).hover(
function () {
$(this).addClass("Add");
},
function () {
$(this).removeClass("Remove");
}
);
});
};
})(jQuery);
然後你就能這樣寫:
$(document).ready(function () {
$(".hoverText").hoverElement().css("color", "yellow");
});
文字已經變成 yellow 色了。就這一個 return,讓你的插件得以融入 jQuery 的鏈式風格。
對於一個商業插件來說,自訂樣式是必不可少的。我們可以讓使用者傳入不同的設定,來改變開發者提供的預設樣式——最常見的像是 width、height、url、color 等等。少了這些自訂能力,插件的實用價值會大打折扣。
下面的實例是:當滑鼠移入一個物件時,它能改變 text、background、foreground 三個屬性(也就是文字、背景色、前景色)。使用者可以設定自己想要的值,而不是固定死的;當然,如果使用者沒有設定,我們會給他一個預設值。
這類插件的開發框架是:
$.fn.YouPlugin = function (options) { ... }
為了避免懶得設定的人(也為了讓插件更健壯),我們需要準備一些預設值:
var defaultVal = {
Text: 'Your mouse is over',
ForeColor: 'red',
BackColor: 'gray'
};
那預設值和使用者傳進來的值要怎麼合起來呢?這就要用到開篇提到的 $.extend():
var obj = $.extend(defaultVal, options);
這樣一來,使用者自訂的值會覆蓋預設值;如果使用者沒定義,就用系統預設的。
完整程式碼如下:
(function ($) {
$.fn.textHover = function (options) { // options 通常用來表示有許多個參數
var defaultVal = {
Text: 'Your mouse is over',
ForeColor: 'red',
BackColor: 'gray'
};
// 預設值
var obj = $.extend(defaultVal, options);
return this.each(function () {
var selObject = $(this); // 取得目前物件
var oldText = selObject.text(); // 取得目前物件的 text
var oldBgColor = selObject.css("background-color"); // 背景色
var oldColor = selObject.css("color"); // 字型顏色
selObject.hover(
function () {
selObject.text(obj.Text);
selObject.css("background-color", obj.BackColor);
selObject.css("color", obj.ForeColor);
},
function () {
selObject.text(oldText);
selObject.css("background-color", oldBgColor);
selObject.css("color", oldColor);
}
);
});
};
})(jQuery);
這裡有個值得注意的細節:滑鼠移出時並不是套一組固定的樣式,而是還原成移入前的原樣(oldText、oldBgColor、oldColor)。這樣插件就不會破壞頁面原有的設計。
怎麼用呢?HTML:
<div id="div1" class="textBar">Mouse over here.....</div> <div id="div2" class="textBar">Mouse over here.....</div>
JavaScript:
$(document).ready(function () {
$('#div1').textHover({
Text: 'I am going to over..',
ForeColor: 'yellow',
BackColor: 'Red'
});
$('#div2').textHover({ Text: 'I am second div...' });
});
就能看到效果了——而且兩個 div 的設定各自獨立,沒設定的屬性自動沿用預設值。
第一,別忘了 return。少了它,你的插件就無法參與鏈式呼叫,在 jQuery 生態裡等於少了半條命。
第二,用 IIFE 包住並傳入 jQuery。這樣內部可以安全使用 $,也不必擔心與其他庫衝突。
第三,保留使用者的預設值不被破壞。$.extend({}, defaultVal, options) 用空物件當第一個參數,可以避免 defaultVal 本身被覆寫——如果同一個頁面有多個實例共用同一份預設值設定,這一步是必須的。