jQuery 物件能一次操作多個 DOM,又支援鏈式呼叫,用起來順手。問題是內建方法再豐富,也追不上實務上的各種奇怪需求。
舉個例子,要把某些元素標成高亮,直覺的寫法是:
$('span.hl').css('backgroundColor', '#fffceb').css('color', '#d85030');
$('p a.hl').css('backgroundColor', '#fffceb').css('color', '#d85030');
到處複製貼上顯然不是好主意,日後想改配色還得逐處替換。與其如此,不如包成一個 highlight() 方法:
$('span.hl').highlight();
$('p a.hl').highlight();
這當然做得到——擴充 jQuery 就是為此而生,也就是所謂的「撰寫 jQuery 外掛」。往後要調邏輯,只改一處即可。
替 jQuery 物件綁上新方法,是透過擴充 $.fn 物件來完成的。先寫出第一版 highlight1():
$.fn.highlight1 = function () {
// this已綁定為當前jQuery對象:
this.css('backgroundColor', '#fffceb').css('color', '#d85030');
return this;
}
函式內部的 this 在呼叫時會被綁成 jQuery 物件,因此裡面可以自由使用所有 jQuery 方法。
配上這樣的 HTML 結構:
<!-- HTML結構 -->
<div id="test-highlight1">
<p>什麼是<span>jQuery</span></p>
<p><span>jQuery</span>是目前最流行的<span>JavaScript</span>庫。</p>
</div>
實測一下:
'use strict';
$('#test-highlight1 span').highlight1();
什麼是jQuery
jQuery是目前最流行的JavaScript庫。
细心的读者可能已经发现……說得精準一點:最後那句 return this 為什麼不能省?因為 jQuery 支援鏈式呼叫,自製方法也得接得下去:
$('span.hl').highlight1().slideDown();
少了這行回傳,使用者被迫把一段呼叫硬拆成兩句,體驗就差很多。
不過這個版本還不夠好用。有人希望高亮配色能自己決定,於是加上參數,就有了 highlight2():
$.fn.highlight2 = function (options) {
// 要考慮到各種情況:
// options為undefined
// options只有部分key
var bgcolor = options && options.backgroundColor || '#fffceb';
var color = options && options.color || '#d85030';
this.css('backgroundColor', bgcolor).css('color', color);
return this;
}
對應的 HTML:
<!-- HTML結構 -->
<div id="test-highlight2">
<p>什麼是<span>jQuery</span> <span>Plugin</span></p>
<p>編寫<span>jQuery</span> <span>Plugin</span>可以用來擴展<span>jQuery</span>的功能。</p>
</div>
帶參數實測:
'use strict';
$('#test-highlight2 span').highlight2({
backgroundColor: '#00a8e6',
color: '#ffffff'
});
什麼是jQuery Plugin
編寫jQuery Plugin可以用來擴展jQuery的功能。
預設值的處理,這裡用的是 && 與 || 短路運算子的組合,無論 options 是 undefined 還是只給了部分欄位,最後都能得到一個有效值。
另一條路是使用 jQuery 的輔助方法 $.extend(target, obj1, obj2, ...)。它會把多個物件的屬性合併進第一個 target,遇到同名屬性時後者覆蓋前者,也就是越後面優先權越高:
// 把默認值和用戶傳入的options合並到對象{}中並返回:
var opts = $.extend({}, {
backgroundColor: '#00a8e6',
color: '#ffffff'
}, options);
接著使用者又提出新期待:每次呼叫都要帶設定太麻煩,能不能預設一組值,之後直接無參數呼叫?也就是說,預設值本身應該允許被改寫。
那預設值放哪裡合適?放全域變數顯然不妥,最恰當的位置是 $.fn.highlight2 這個函式物件本身。於是最終版的 highlight() 誕生了:
$.fn.highlight = function (options) {
// 合並默認值和用戶設定值:
var opts = $.extend({}, $.fn.highlight.defaults, options);
this.css('backgroundColor', opts.backgroundColor).css('color', opts.color);
return this;
}
// 設定默認值:
$.fn.highlight.defaults = {
color: '#d85030',
backgroundColor: '#fff8de'
}
使用者只要在初始化時改一次預設值:
$.fn.highlight.defaults.color = '#fff'; $.fn.highlight.defaults.backgroundColor = '#000';
之後就能非常簡潔地呼叫 highlight() 了。
測試用的 HTML:
<!-- HTML結構 -->
<div id="test-highlight">
<p>如何編寫<span>jQuery</span> <span>Plugin</span></p>
<p>編寫<span>jQuery</span> <span>Plugin</span>,要設置<span>默認值</span>,並允許用戶修改<span>默認值</span>,或者運行時傳入<span>其他值</span>。</p>
</div>
驗證改寫預設值的效果:
'use strict';
$.fn.highlight.defaults.color = '#659f13';
$.fn.highlight.defaults.backgroundColor = '#f2fae3';
$('#test-highlight p:first-child span').highlight();
$('#test-highlight p:last-child span').highlight({ color: '#dd1144' });
如何編寫jQuery Plugin
編寫jQuery Plugin,要設置默認值,並允許用戶修改默認值,或者運行時傳入其他值。
歸納起來,寫一個 jQuery 外掛有四條原則:
1. 把函式綁到 $.fn 上,實作外掛的程式邏輯;
2. 函式結尾要 return this;,以維持鏈式呼叫;
3. 預設值掛在 $.fn.<pluginName>.defaults 上;
4. 呼叫時允許傳入設定值覆寫預設。
jQuery 有些方法天生只作用於特定元素,例如 submit() 只對 form 有意義。若我們寫的擴充也只適用於某類元素,該怎麼處理?
回想一下選擇器支持的 filter(),正好可以拿來把不該作用的元素濾掉。
實例:替所有指向外部網站的連結加上跳轉確認。先寫出呼叫端:
$('#main a').external();
再依前面的原則實作 external 擴充:
$.fn.external = function () {
// return返回的each()返回結果,支持鏈式調用:
return this.filter('a').each(function () {
// 注意: each()內部的回調函數的this綁定為DOM本身!
var a = $(this);
var url = a.attr('href');
if (url && (url.indexOf('https://') === 0 || url.indexOf('https://') === 0)) {
a.attr('href', '#0')
.removeAttr('target')
.append(' <i class="uk-icon-external-link"></i>')
.click(function () {
if (confirm('你確定要前往' + url + '?')) {
window.open(url);
}
});
}
});
}
測試結構如下:
<!-- HTML結構 -->
<div id="test-external">
<p>如何學習<a href="https://jquery.com" rel="external nofollow" >jQuery</a>?</p>
<p>首先,你要學習<a href="/wiki/001434446689867b27157e896e74d51a89c25cc8b43bdb3000" rel="external nofollow" >JavaScript</a>,並了解基本的<a href="https://developer.mozilla.org/en-US/docs/Web/HTML" rel="external nofollow" >HTML</a>。</p>
</div>
實測:
'use strict';
$('#test-external a').external();
小結
擴充 jQuery 的門檻並不高,真正的功夫在於遵守它的規矩:支援鏈式呼叫、提供可覆寫的預設值、必要時用 filter() 限定作用範圍。做到這幾點,自製方法看起來就跟原生 API 沒有兩樣了。