用 jQuery 寫元件,很多人會直接從 $.fn.xxx 開始,把邏輯全塞進外掛函式裡。這樣做短期很快,但元件一旦有了狀態與多個方法,就會變得難以維護。這裡介紹一種更清爽的模式。
最後一點其實最有趣。照這個模式走,建構函式與原型方法都由你自己掌控,那些為了模擬繼承而生的 hack 手段都可以丟掉——甚至 jQuery 本身都不是必要的。手工的,往往是最好的。
以下做一個標籤選擇器:點擊候選標籤可以加入或移除,並限制最多幾個。
/*
* @by ambar_li
* @create 2010-11-30
* 標籤選擇、驗證
*/
(function($){
var tagSelector = function(input, options){
var me = this;
var opt = me.opt = $.extend({
limit : 5
, tags : null
, delimiter : ','
}, options || {});
var $el = me.input = $(input);
var $tags = me.tags = $(opt.tags);
if (!$el.length || !$tags.length) return;
$tags.click(function(e){
e.preventDefault();
var tag = $(this).text();
me[me.has(tag) ? 'remove' : 'add'](tag);
});
};
tagSelector.prototype = {
add : function(tag){
if (tag) {
var me = this, tags = me.get(), del = me.opt.delimiter;
tags.push(tag);
me.input.val(tags.join(del));
}
return me;
}
, remove : function(tag){
var me = this, exist = function(v){ return v != tag; };
me.input.val($.grep(me.get(), exist));
return me;
}
, cleanify : function(){
return this.remove();
}
, limit : function(){
var me = this, tags = this.cleanify().get()
, len = tags.length, max = me.opt.limit;
if (len > max) {
me.input.val(tags.slice(0, max));
}
return me;
}
, has : function(tag){
return $.inArray(tag, this.get()) > -1;
}
, get : function(){
var val = $.trim(this.input.val());
return val ? $.map(val.split(/[,,]+/), $.trim) : [];
}
};
$.fn.tagSelector = function(options){
return this.each(function(){
$(this).data('tagSelector', new tagSelector(this, options));
});
};
})(jQuery);
整段程式裡最重要的是最後那幾行。每個方法都 return me,因此可以在元件外部形成鏈式呼叫;而 $.fn.tagSelector 做的事只有一件——把元件實例掛進 data,之後隨時取得。
官方 UI 在這一步多做了「重複初始化檢查」:
this.each(function() {
var instance = $.data(this, name);
if (instance) {
instance.option(options || {})._init();
} else {
$.data(this, name, new object(options, this));
}
});
差別在於官方版本允許二次呼叫時更新設定,而簡化版會直接建立新實例。實務上建議補上這層判斷,避免重複綁定事件。
// 方式一:透過外掛方法建立,再從 data 取回 API
var $input = $('#tb_tags').tagSelector({ tags: 'div.tag_group a:not(.btn_tag_more)' });
var api = $input.data('tagSelector');
// 方式二:直接 new
// var api = new tagSelector('#tb_tags', { tags: 'div.tag_group a:not(.btn_tag_more)' });
兩種方式 respectively 適合不同場景:走外掛能保有 jQuery 的鏈式手感,直接 new 則在需要明確持有實例參照時更直白。
<!DOCTYPE HTML>
<html lang="zh-Hant">
<head>
<meta charset="UTF-8">
<title>簡易的標籤選擇</title>
<style type="text/css">
.tag_group a { margin: 0 3px; }
</style>
</head>
<body>
<div class="filed">
<div class="filed_label">標籤:</div>
<input type="text" name="tags" id="tb_tags" class="inp_txt" />
<span class="filed_tip">最多 5 個,用逗號隔開</span>
<div class="tag_group">
<a href="#" title="腐敗">腐敗</a>
<a href="#" title="休假">休假</a>
<a href="#" title="蜜月">蜜月</a>
<a href="#" title="電影">電影</a>
<a href="#" title="讀書">讀書</a>
<a class="btn_tag_more" href="#" title="更多">更多</a>
</div>
</div>
<script src="https://ajax.microsoft.com/ajax/jQuery/jquery-1.4.4.min.js"></script>
<script>
(function($){
var tagSelector = function(input, options){
var me = this;
var opt = me.opt = $.extend({
limit: 5, tags: null, delimiter: ','
}, options || {});
var $el = me.input = $(input);
var $tags = me.tags = $(opt.tags);
if (!$el.length || !$tags.length) return;
$tags.click(function(e){
e.preventDefault();
var tag = $(this).text();
me[me.has(tag) ? 'remove' : 'add'](tag);
});
};
tagSelector.prototype = {
add : function(tag){
if (tag) {
var me = this, tags = me.get(), del = me.opt.delimiter;
tags.push(tag);
me.input.val(tags.join(del));
}
return me;
}
, remove : function(tag){
var me = this, exist = function(v){ return v != tag; };
me.input.val($.grep(me.get(), exist));
return me;
}
, cleanify : function(){ return this.remove(); }
, limit : function(){
var me = this, tags = this.cleanify().get(), max = me.opt.limit;
if (tags.length > max) me.input.val(tags.slice(0, max));
return me;
}
, has : function(tag){ return $.inArray(tag, this.get()) > -1; }
, get : function(){
var val = $.trim(this.input.val());
return val ? $.map(val.split(/[,,]+/), $.trim) : [];
}
};
$.fn.tagSelector = function(options){
return this.each(function(){
$(this).data('tagSelector', new tagSelector(this, options));
});
};
})(jQuery);
$(function(){
var $input = $('#tb_tags').tagSelector({
tags: 'div.tag_group a:not(.btn_tag_more)'
});
var api = $input.data('tagSelector');
});
</script>
</body>
</html>
這個模式最迷人之處在於,它把「元件」當成一個真正的物件來看待:有自己的狀態(opt、input、tags)、自己的行為(add、remove、limit),而 jQuery 只負責把 DOM 元素與這個物件綁在一起。想擴充功能,往 prototype 上加一個方法就好,不必回頭改動外掛入口。