撰寫 jQuery 外掛時,可以選擇擴充「全域函式」或「物件方法」,兩者的呼叫形式與適用場景不同。本文示範這兩種擴充方式,並說明開發物件方法時必須注意的兩個關鍵:隱式迭代與方法連綴。
所謂全域函式,實際上就是挂在 jQuery 命名空間下的函式。最直接的寫法是把它指定為 jQuery 物件的一個屬性。
jQuery.five = function () {
alert("直接繼承方式不一樣");
};
// 呼叫
$.five();
要一次加上多個:
jQuery.five = function () { alert("直接繼承方式不一樣"); }
jQuery.six = function () { alert("直接繼承方式不一樣2"); }
$.five();
$.six();
這種做法有命名空間衝突的風險。比較好的方式是把同一外掛的所有全域函式收進一個物件:
// 命名空間繼承
jQuery.myPlugin = {
one: function (obj) {
var object = obj;
var id = object.attr("id");
alert(id);
},
two: function () {
alert(22);
}
};
// 呼叫
$.myPlugin.one($("#someId"));
如此一來就等於為這些函式建立了獨立命名空間 jQuery.myPlugin,不必擔心與其他外掛撞名。
jQuery 絕大多數內建功能都是以物件方法的形式提供的,寫法是在 jQuery.fn 上掛函式。
jQuery.fn.myMethod = function () {
alert(11);
};
// 呼叫
$.fn.myMethod();
注意:jQuery.fn 是 jQuery.prototype 的別名,兩者等價。
以下是一個行為不正確的範例:
<ul>
<li>11111111111111111111111111</li>
<li class="this">22222222222222222222</li>
<li>333333333333333</li>
<li class="that">44444444444444444</li>
<li class="this">55555555555555</li>
</ul>
<input type="button" value="swap" id="swap" />
<script>
jQuery.fn.swapClass = function (class1, class2) {
if (this.hasClass(class1)) {
this.removeClass(class1).addClass(class2);
}
if (this.hasClass(class2)) {
this.removeClass(class2).addClass(class1);
}
}
$("#swap").click(function () {
$("li").swapClass("this", "that");
return false;
})
</script>
問題在於:當選到的元素不只一個時,this 代表整個集合,hasClass 只要「其中任一元素」符合就回傳 true,於是所有 li 最後都變成 that 樣式。
解法是在方法內呼叫 .each(),讓程式碼對每個元素各跑一次。在 each() 的回呼內部,this 會依序指向個別的 DOM 元素。維持隱式迭代是讓自製外掛與 jQuery 內建方法行為一致的重要關鍵。
jQuery.fn.swapClass = function (class1, class2) {
this.each(function () {
var $element = jQuery(this);
if ($element.hasClass(class1)) {
$element.removeClass(class1).addClass(class2);
} else if ($element.hasClass(class2)) {
$element.removeClass(class2).addClass(class1);
}
});
}
// 呼叫
$("li").swapClass("this", "that");
這裡有個細節:原本的兩個獨立 if 改成了 if / else if。因為同一個元素不可能同時需要兩次互換,改成 else if 可以避免判斷被執行兩遍。
要支援串接呼叫,必須在方法中回傳一個 jQuery 物件,通常就是 this。
jQuery.fn.swapClass = function (class1, class2) {
return this.each(function () {
var $element = jQuery(this);
if ($element.hasClass(class1)) {
$element.removeClass(class1).addClass(class2);
} else if ($element.hasClass(class2)) {
$element.removeClass(class2).addClass(class1);
}
});
}
// 連綴呼叫
$("li").swapClass("this", "that").css("text-decoration", "underline");
.each() 本身就會回傳 jQuery 物件,所以在它前面加上 return 就能同時滿足隱式迭代與連綴兩個需求。
若某組動畫效果經常一起出現,可以包成簡寫方法:
jQuery.fn.slideFadeOut = function (speed, callback) {
return this.animate({ height: "hide", opacity: "hide" }, speed, callback);
}
jQuery.fn.slideFadeIn = function (speed, callback) {
return this.animate({ height: "show", opacity: "show" }, speed, callback);
}
jQuery.fn.slideFadeToggle = function (speed, callback) {
return this.animate({ height: "toggle", opacity: "toggle" }, speed, callback);
}
把「回傳 this」與「each 迭代」這兩個習慣養成反射動作,寫出來的 jQuery 外掛品質就會與官方外掛看齊。