jQuery 預設用 $ 作為操作符,而 Prototype、MooTools 等函式庫也都愛用 $。同一頁同時引入時,衝突幾乎無可避免。noConflict() 就是為此而生。
$ 只是 window.jQuery 的一個引用。由於 JavaScript 由上而下執行,如果 jQuery 在其他用 $ 的函式庫之後引入,jQuery 就會取得 $ 的使用權;反之,如果 jQuery 先引入,它就不會佔用 $。這個行為本身不難理解,但結果就是後引入的那一方會拿到 $。
呼叫 jQuery.noConflict() 之後,$ 的控制權會讓給第一個宣告它的函式庫,此後只能用 jQuery 這個變數存取 jQuery 物件。原本寫 $("div p") 的地方,就得改成 jQuery("div p")。
jQuery.noConflict([removeAll])
它帶一個可選的布林參數,用來決定是否連 jQuery 本身也一起讓出去:
jQuery 原始碼開頭,第一件事就是先把 window 上的兩個名稱映射下來:
// Map over jQuery in case of overwrite _jQuery = window.jQuery, // Map over the $ in case of overwrite _$ = window.$,
接著 noConflict 依這兩個私有變數的差異決定怎麼交接:
noConflict: function (deep) {
if (window.$ === jQuery) {
window.$ = _$;
}
if (deep && window.jQuery === jQuery) {
window.jQuery = _jQuery;
}
return jQuery;
}
仔細看:如果 deep 沒設定,_ $ 會覆蓋 window.$,此時 jQuery 的別名 $ 失效,但 jQuery 本體完好無損;如果 deep 設為 true,_jQuery 覆蓋 window.jQuery,$ 和 jQuery 都會失效。
值得注意的是它會 return jQuery。這個未被覆蓋的參照,讓我們可以自行決定要把它接到哪個變數上——不管是多個函式庫混用,還是 jQuery 多版本共存的環境,都能靠變數映射化解衝突。
1. 把 $ 還給原本的擁有者
jQuery.noConflict();
jQuery("div p").hide(); // 使用 jQuery
$("content").style.display = "none"; // 使用其他函式庫的 $()
2. 用 IIFE 還原 $ 別名
在函式作用域內,$ 仍然是 jQuery 的別名,外面則不受影響。這對大多數不依賴其他函式庫的插件都很有效:
jQuery.noConflict();
(function ($) {
$(function () {
// 使用 $ 作為 jQuery 別名的代碼
});
})(jQuery);
// 其他用 $ 作為別名的函式庫的代碼
3. 與 ready 的簡寫結合,寫得更緊湊
jQuery.noConflict()(function () {
// 使用 jQuery 的代碼
});
// 其他函式庫使用 $ 做別名的代碼
4. 建立新別名
var j = jQuery.noConflict();
j("div p").hide(); // 基於 jQuery 的代碼
$("content").style.display = "none"; // 基於其他函式庫的 $() 代碼
5. 完全把 jQuery 移進自訂命名空間
var dom = {};
dom.query = jQuery.noConflict(true);
dom.query("div p").hide(); // 新的 jQuery 代碼
$("content").style.display = "none"; // 另一個函式庫 $() 的代碼
jQuery("div > p").hide(); // 另一個版本 jQuery 的代碼
第五種寫法在多版本共存時特別有用,因為連 jQuery 這個名稱都空出來了。
希望這篇對大家的 jQuery 開發有幫助。