當同一個頁面上同時引入了多個使用 $ 符號的 JavaScript 函式庫(例如 jQuery 與 Prototype)時,就容易發生衝突。jQuery 提供的 noConflict() 方法正是為了解決這個問題而生。本文將深入解析它的功能、源碼原理與常見用法。
jQuery 預設使用 $ 作為操作符,而 $ 只是 window.jQuery 物件的一個引用。由於其他框架(如 Prototype)也使用 $,若 jQuery 在其他庫之後引入,就會取得 $ 的使用權;反之則不會佔用。jQuery.noConflict() 能將 $ 的控制權讓渡給第一個實作它的庫,確保 jQuery 不會與其他庫的 $ 物件衝突。呼叫後,就只能透過 jQuery 變數來存取 jQuery 物件。
jQuery.noConflict([removeAll])
預設情況下,執行 noConflict 會把 $ 的控制權移交給第一個產生 $ 的庫;當 removeAll 設為 true 時,則會把 $ 與 jQuery 物件本身的控制權全部移交出去。
jQuery 在源碼開頭會先映射 window 環境下的 jQuery 與 $ 兩個物件,以防被強制覆蓋:
// Map over jQuery in case of overwrite
_jQuery = window.jQuery,
// Map over the $ in case of overwrite
_$ = window.$,
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 都會失效。
1. 將 $ 映射回原始物件:
jQuery.noConflict();
jQuery("div p").hide(); // 使用 jQuery
$("content").style.display = "none"; // 使用其他庫的 $()
2. 透過 IIFE 恢復 $ 別名:
jQuery.noConflict();
(function($) {
$(function() {
// 使用 $ 作為 jQuery 別名的程式碼
});
})(jQuery);
3. 與 ready 結合:
jQuery.noConflict()(function(){
// 使用 jQuery 的程式碼
});
4. 建立新別名:
var j = jQuery.noConflict();
j("div p").hide();
5. 完全移轉到新命名空間:
var dom = {};
dom.query = jQuery.noConflict(true);
dom.query("div p").hide();
透過 noConflict 提供的移交機制,無論是框架混用還是 jQuery 多版本共存,都能以變數映射的方式優雅地解決衝突問題。