剛接觸前端時,看到別人寫的外掛總覺得很厲害——那些炫麗的輪播、彈窗、日期選擇器,背後其實多半只是幾百行的 jQuery。學會寫外掛,不只是「做效果」,更重要的是把常用邏輯沉澱成可重複使用的元件。
回頭看,jQuery 最成功的地方之一正是它的可擴充性:任何人都能替它擴充功能,於是形成龐大的外掛生態系。這與各家巨頭爭相打造平台的道理相同——得平台者得天下。
使用 jQuery 並不難,但要讓能力再上一層,寫一個自己的外掛是最好的練習。
軟體開發需要設計模式來組織程式碼。《jQuery 高級編程》一書把外掛開發歸納為三種方式:
1. 透過 $.extend() 擴充 jQuery 2. 透過 $.fn 為 jQuery 添加新方法 3. 透過 $.widget() 套用 jQuery UI 的部件工廠方式建立
第一種:$.extend() 只是往 jQuery 命名空間上掛一個靜態方法,最簡單,但無法使用選擇器。呼叫方式是 $.myfunction(),而不是 $('#example').myfunction():
$.extend({
sayHello: function (name) {
console.log('Hello, ' + (name ? name : 'Dude') + '!');
}
});
$.sayHello(); // Hello, Dude!
$.sayHello('test'); // Hello, test!
第三種:$.widget() 用來開發更高階的 jQuery UI 部件,能免費獲得狀態保存、開關、啟用停用等內建能力,功能強但學習成本高。
第二種:$.fn 是一般外掛最常用的方式,因為它能直接作用在選到的元素上,充分利用 jQuery 的選擇器。你日常用過的外掛,大多出自這條路。
$.fn.pluginName = function () {
// your code here
};
稍微正式一點的寫法會採用物件導向思維:先把設定與方法定義在一個建構函式上,再由外掛入口建立實例。
// 定義一個元件建構函式
var testObj = function (el, opt) {
this.$element = el;
this.defaults = {
'color': 'red',
'fontSize': '12px',
'textDecoration': 'none'
};
// 第三個參數放最後,讓使用者傳入的值覆蓋預設值
this.options = $.extend({}, this.defaults, opt);
};
// 定義方法
testObj.prototype = {
changecss: function () {
return this.$element.css({
'color': this.options.color,
'fontSize': this.options.fontSize,
'textDecoration': this.options.textDecoration
});
}
};
// 外掛入口
$.fn.myPlugin = function (options) {
var instance = new testObj(this, options);
return instance.changecss();
};
$.extend({}, this.defaults, opt) 之所以要帶一個空物件 {},是為了建立一個新物件來承接結果,避免直接改動 this.defaults 這個預設值本身。少了它,第二次呼叫外掛時預設值可能已經被上一次的參數污染。
呼叫方式:
$(function () {
$('a').myPlugin({ 'color': '#2C9929', 'fontSize': '20px' });
});
這個版本有個致命缺陷——testObj 是全域變數。一旦頁面上其他地方剛好也用了這個名字,你的外掛就會被覆蓋,反之亦然。外掛是要給別人用的,這種命名衝突風險不可接受。
解法是用立即執行函式(IIFE,又稱私有作用域或塊級作用域)把整段程式碼包起來:
(function () {
// 外掛程式碼
})();
但還有一個細節。研究成熟專案的原始碼時,你會發現開頭常有一個分號,這不是隨手寫的:
var testFunction = function () { }
(function () { })()
上面這段會出錯,因為前一行結尾沒有分號,解析器會把兩段程式碼誤認為同一個表達式的呼叫。加上分號就沒問題了:
var testFunction = function () { };
;(function () { })();
在檔案開頭補上分號,是為了避免合併壓縮時與前一個檔案的內容黏在一起而出錯。
還有一個實務問題:有些使用者為了避免 jQuery 與 Zepto 等函式庫衝突,會把 $ 改回 jQuery;也有人會覆寫 document 之類的物件。若你的外掛內部直接用 $,在這些環境下就會壞掉。
標準做法是把 jQuery、window、document 當參數傳進閉包,並把 undefined 也保留成參數:
; (function ($, window, document, undefined) {
// 我們的程式碼,這裡的 $ 保證就是 jQuery
})(jQuery, window, document);
把 undefined 列為參數卻不傳值,有個古老但實際的理由:在舊版 JavaScript 中 undefined 是可以被重新賦值的,透過參數保留能確保它在閉包內永遠是真正的 undefined。
濃縮成一行,這就是 jQuery 官方推薦的外掛封裝形式:
<script type="text/javascript">
(function ($) {
// 這裡放入外掛程式碼
})(jQuery);
</script>
它同時解決三件事:
1. 避免全域依賴——內部變數不會外洩。
2. 避免第三方破壞——別人的程式碼動不到你的變數。
3. 相容 $ 與 jQuery 兩種操作符——不論對方怎麼設定,閉包內的 $ 都指向 jQuery。
這段程式碼在解析時,等同於:
var jq = function ($) {
// Code goes here
};
jq(jQuery);
以下範例示範外掛如何接收參數、合併預設值並綁定事件。
撰寫外掛:
$(function () {
$.fn.插件名稱 = function (options) {
var defaults = {
Event: "click", // 觸發響應的事件
msg: "Holle word!" // 顯示內容
};
var options = $.extend(defaults, options);
var $this = $(this); // 響應事件的對象
// 功能程式碼寫在這裡
$this.on(options.Event, function (e) {
alert(options.msg);
});
return $this; // 保留鏈式呼叫
};
});
呼叫外掛:
$(function () {
$("#test").插件名稱({
Event: "click",
msg: "外掛其實就是這麼簡單!"
});
});
對應的頁面結構:
<input type="button" id="test" value="這是一個簡單的外掛呼叫" />
兩個實務提醒:一是範例中的 $.extend(defaults, options) 建議改寫成 $.extend({}, defaults, options),理由如前所述,避免污染預設值;二是原本使用的 live() 已在 jQuery 1.9 移除,請改用 on(),並在需要時加上委派語法 $(document).on(event, selector, fn)。另外別忘了 return this,否則外掛就無法與其他方法串接成鏈式呼叫。