DIV CSS 佈局教程網

一步一步教你寫一個 jQuery 插件(Plugin)教程
編輯:JQuery特效代碼     

開發 jQuery 插件時,有一些約定俗成的最佳實踐值得注意。本文以一個名為 hilight(高亮文字)的插件為例,逐步示範如何寫出結構良好、易於擴展的 jQuery 插件。

開發前需注意的六件事

1. 明確 jQuery 的命名空間只有一個($.fn);
2. 明白 options 參數用來控制插件行為;
3. 為默認設置提供公共訪問權限;
4. 為子函數提供公共訪問權限;
5. 私有函數絕對保持私有;
6. 支持 metadata 插件。

1. 明確命名空間只有一個

我們把插件命名為 hilight,即可透過 $('#id').hilight() 的方式調用。jQuery 插件統一掛在 $.fn 這個唯一命名空間下,這樣可讀性更強,也符合面向對象的設計思維。

2. 用 options 參數控制行為

先為插件定義 foreground(前景色)與 background(背景色)兩個選項,透過 options 對象傳入主函數。

3. 為默認設置提供公共訪問權限

改進上面的寫法,讓用戶能用最少的代碼重載選項。把默認值掛在 $.fn.hilight.defaults 上,用戶就能輕鬆覆寫某個屬性。

4. 為子函數提供公共訪問權限

可以定義一個 format 函數來決定高亮文字的形式,並掛在 $.fn.hilight.format 上開放給外部覆寫,這是很好的自定義方式。

5. 私有函數保持私有

並非所有東西都該公開。像 debug 這種內部輔助函數就應該保持私有,避免暴露不必要的實作細節而破壞封裝。

6. 支持 metadata 插件

若能整合 metadata 插件,用戶就能直接透過 HTML 標記上的 data 屬性來覆寫選項,讓插件更靈活強大。

最終完整代碼

// create closure
(function($) {
$.fn.hilight = function(options) {
debug(this);
// build main options before element iteration
var opts = $.extend({}, $.fn.hilight.defaults, options);
return this.each(function() {
$this = $(this);
// build element specific options
var o = $.meta ? $.extend({}, opts, $this.data()) : opts;
$this.css({
backgroundColor: o.background,
color: o.foreground
});
var markup = $this.html();
markup = $.fn.hilight.format(markup);
$this.html(markup);
});
};
// private function for debugging
function debug($obj) {
if (window.console && window.console.log)
window.console.log('hilight selection count: ' + $obj.size());
};
// define and expose our format function
$.fn.hilight.format = function(txt) {
return '<strong>' + txt + '</strong>';
};
// plugin defaults
$.fn.hilight.defaults = {
foreground: 'red',
background: 'yellow'
};
})(jQuery);

掌握這六個要點,你就能寫出結構清晰、易於維護與擴展的 jQuery 插件。整個插件用 IIFE(立即調用函數表達式)包裹並傳入 jQuery,能有效避免污染全局命名空間。

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