談?wù)?jQuery 中的防沖突機制
許多的 JS 框架類庫都選擇使用 $ 符號作為函數(shù)或變量名,jQuery 是其中最為典型的一個。在 jQuery 中,$ 符號只是 window.jQuery 對象的一個引用,因此即使 $ 被刪除,window.jQuery 依然是保證整個類庫完整性的堅強后盾。jQuery 的 API 設(shè)計充分考慮了多框架之間的引用沖突,我們可以使用 jQuery.noConflict 方法來輕松實現(xiàn)控制權(quán)的移交。
jQuery.noConflict 方法包含一個可選的布爾參數(shù)[1],用以決定移交 $ 引用的同時是否移交 jQuery 對象本身:
- jQuery.noConflict([removeAll])
缺省情況下,執(zhí)行 noConflict 會將變量 $ 的控制權(quán)移交給第一個產(chǎn)生 $ 的庫;當 removeAll 設(shè)置為 true 時,執(zhí)行 noConflict 則會將 $ 和 jQuery 對象本身的控制權(quán)全部移交給第一個產(chǎn)生他們的庫。
例如在 KISSY 和 jQuery 混用,并且慣用 $ = KISSY 來簡化 API 操作的時候,就能夠通過這個方法解決命名沖突的問題。
那么這個機制是如何實現(xiàn)的呢?閱讀 jQuery 源碼開頭[2],首先做的一件事情是這樣的:
- // Map over jQuery in case of overwrite
- _jQuery = window.jQuery,
- // Map over the $ in case of overwrite
- _$ = window.$,
容易理解的是,jQuery 通過兩個私有變量映射了 window 環(huán)境下的 jQuery 和 $ 兩個對象,以防止變量被強行覆蓋。一旦 noConflict 方法被調(diào)用,則通過 _jQuery, _$, jQuery, $ 四者之間的差異,來決定控制權(quán)的移交方式,具體的代碼如下:
- noConflict: function( deep ) {
- if ( window.$ === jQuery ) {
- window.$ = _$;
- }
- if ( deep && window.jQuery === jQuery ) {
- window.jQuery = _jQuery;
- }
- return jQuery;
- }
再來看上面所說的參數(shù)設(shè)定問題,如果 deep 沒有設(shè)置,_$ 覆蓋 window.$,此時 jQuery 別名 $ 失效,但 jQuery 本身完好無損。如果有其他類庫或代碼重新定義了 $ 變量,它的控制權(quán)就完全交接出去了。反之如果 deep 設(shè)置為 true 的話,_jQuery 覆蓋 window.jQuery,此時 $ 和 jQuery 都將失效。
這種操作的好處是,不管是框架混用還是 jQuery 多版本共存這種高度沖突的執(zhí)行環(huán)境,由于 noConflict 方法提供的移交機制,以及本身返回未被覆蓋的 jQuery 對象,完全能夠通過變量映射的方式解決沖突。
但無法避免的事實是可能導致的插件失效等問題,當然通過簡單修改上下文參數(shù)即可恢復 $ 別名
- var query = jQuery.noConflict(true);
- (function ($) {
- // 插件或其他形式的代碼,也可以將參數(shù)設(shè)為 jQuery
- })(query);
[1] http://api.jquery.com/jQuery.noConflict/#jQuery-noConflict-removeAll
[2] https://github.com/jquery/jquery/blob/master/src/core.js