本文說明如何利用 jQuery.noConflict 讓多個不同的 jQuery 版本在同一頁面並存而不衝突,同時解決與其他 JS 框架的 $ 佔用問題。
許多 JS 框架(如 Prototype、MooTools)都選擇用 $ 作為函式或變數名,jQuery 是最典型的一個。在 jQuery 中,$ 只是 window.jQuery 的一個參照,因此即使 $ 被刪除,window.jQuery 仍能保證整個類庫的完整性。jQuery 的 API 設計充分考虑了多框架的引用衝突,可用 jQuery.noConflict 輕鬆實現控制權的移交。
jQuery.noConflict 包含一個可選的布林參數,用以決定移交 $ 參照的同時是否移交 jQuery 物件本身:
jQuery.noConflict([removeAll])
預設情況下,執行 noConflict 會把變數 $ 的控制權移交給第一個產生 $ 的庫;當 removeAll 設為 true 時,則會把 $ 與 jQuery 物件本身的控制權全部移交出去。
閱讀 jQuery 原始碼開頭可知,它首先做的事是:
// Map over jQuery in case of overwrite
.jQuery = window.jQuery,
// Map over the $ in case of overwrite
_$= window.$,
jQuery 透過兩個私有變數映射了 window 下的 jQuery 與 $,以防被強制覆蓋。一旦 noConflict 被呼叫,便透過 _jQuery、_$、jQuery、$ 四者的差異來決定移交方式:
noConflict: function( deep ) {
if ( window.$ === jQuery ) {
window.$ = _$;
}
if ( deep && window.jQuery === jQuery ) {
window.jQuery = _jQuery;
}
return jQuery;
}
若 deep 未設定,_$ 覆蓋 window.$,此時 $ 別名失效,但 jQuery 本身完好無損;若 deep 設為 true,_jQuery 覆蓋 window.jQuery,$ 與 jQuery 都將失效。由於 noConflict 會回傳未被覆蓋的 jQuery 物件,因此能透過變數映射完美解決衝突。可能的插件失效問題,只需修改上下文參數即可恢復 $ 別名:
var query = jQuery.noConflict(true);
(function ($) {
// 插件或其他程式碼,也可將參數設為 jQuery
})(query);
利用 noConflict 特性,不僅能讓 jQuery 與其他庫並存,也能讓 jQuery 自身的多個版本在同一頁面共存而不衝突:
<!-- 從 CDN 加載最新版本 -->
<script type="text/javascript" src="https://ajax.googleapis.com/ajax/libs/jquery/1/jquery.js"></script>
<script type="text/javascript">
var jQuery_New = $.noConflict(true);
</script>
<!-- 加載 jQuery 1.6.2 -->
<script type="text/javascript" src="https://ajax.googleapis.com/ajax/libs/jquery/1.6.2/jquery.min.js"></script>
<script type="text/javascript">
var jQuery_1_6_2 = $.noConflict(true);
</script>
<!-- 加載 jQuery 1.3.2 -->
<script type="text/javascript" src="https://ajax.googleapis.com/ajax/libs/jquery/1.3.2/jquery.min.js"></script>
<script type="text/javascript">
var jQuery_1_3_2 = $.noConflict(true);
</script>
<script type="text/javascript">
alert(jQuery_New.fn.jquery);
alert(jQuery_1_6_2.fn.jquery);
alert(jQuery_1_3_2.fn.jquery);
jQuery_New(function($){
$('<p>我是最新的' + $.fn.jquery + '版本添加進來的。</p>').appendTo('body');
});
jQuery_1_6_2(function($){
$('<p>我是' + $.fn.jquery + '版本添加進來的。</p>').appendTo('body');
});
</script>
透過 noConflict(true) 並以自訂變數承接各版本物件,就能在維護舊專案的同時引入新版 jQuery,兩者互不干擾、各自運作。