在 jQuery 中,$ 只是 jQuery 的別名,為了書寫方便我們習慣用 $('#id') 這樣的形式。但當同一頁引入了多個版本的 jQuery,或 jQuery 與其他函式庫(Prototype、MooTools 等)並存時,控制台就會跳出衝突錯誤。
你可能會問:為什麼要引入兩個版本,用一個不就得了?
原因是:現有網站已經採用舊版 jQuery 與一批依賴它的外掛。直接升級到新版,這些外掛很可能就失效了——除非你能把它們全部升級,或者等作者推出支援新版的版本。過渡期裡,讓兩版並存往往是最實際的選擇。
解法是 jQuery.noConflict()。假設頁面同時引進 1.5.0 與 1.11.0:
<script src="jquery-1.5.0.js"></script> <script src="jquery-1.11.0.js"></script> <script> console.log($.fn.jquery); // '1.11.0' var $jq = jQuery.noConflict(true); console.log($.fn.jquery); // '1.5.0' </script>
noConflict(true) 會把 $ 的控制權讓給先載入的 1.5.0,而 1.11.0 則改用 $jq() 呼叫。傳入 true 代表連 jQuery 這個全域名稱也一併釋放。
直接在全域寫 $jq 到處替換,程式碼會變得很亂,別人接手時容易誤刪。比較好的做法是用閉包把版本隔離開。
先只引入新版:
<script src="jquery-1.11.0.js"></script> <script src="myJS.js"></script>
自己寫的程式放在立即呼叫函式中,使用新版:
// myJS.js —— 這裡的 $ 是 v1.11.0
(function($) {
// 你的程式碼
})(jQuery);
再把舊版嵌入另一個閉包,讓舊版專用的程式在裡面用 $:
// myJS.js 續
(function () {
// ...此處放入 jquery 1.5.0 的壓縮原始碼
var $ = jQuery.noConflict(true);
// 從這裡開始,$() 指的是 jquery 1.5.0
})();
這樣兩邊互不干擾,全域也乾淨。要注意的是:直接把 jQuery 原始碼嵌入自己的檔案前,請先確認其授權條款允許這樣做。
如果 jQuery 在其他函式庫之前載入,其實不需要 noConflict——只要先把 jQuery 存到別的變數即可:
<!-- 先載入 jQuery -->
<script src="jquery-1.11.0.js"></script>
<script>
var $jq = $;
console.log($.fn.jquery); // '1.11.0'
</script>
<!-- 後載入的其他函式庫覆寫了 $ -->
<script>
$ = { fn: { jquery: "otherJS" } };
</script>
<script>
console.log($.fn.jquery); // otherJS
console.log($jq.fn.jquery); // '1.11.0'
</script>
如果 jQuery 在其他函式庫之後載入,就要用 noConflict 把 $ 讓出去:
<!-- 先載入其他函式庫 -->
<script>
$ = { fn: { jquery: "otherJS" } };
</script>
<!-- 再載入 jQuery -->
<script src="jquery-1.11.0.js"></script>
<script>
console.log($.fn.jquery); // '1.11.0'
var $jq = $.noConflict();
console.log($.fn.jquery); // otherJS
console.log($jq.fn.jquery); // '1.11.0'
</script>
缺點很明顯:接下來所有引用 jQuery 的地方都必須把 $ 換成 $jq。
jQuery 會把 jQuery 物件當作參數傳進 ready 的回呼,所以可以這樣寫:
// 改寫前
$(document).ready(function() { ... });
// 改寫後
jQuery(document).ready(function($) {
// 這裡面的 $ 就是 jQuery
});
缺點是只在 ready 內部有效,外面的子函式仍然拿不到。
(function($) {
// 你的程式碼,包含 ready 與所有子函式
})(jQuery);
或者:
jQuery(function($){
// 你的程式碼
});
這個方式的好處是:整個檔案範圍內 $ 都指向 jQuery,ready 內外一致;而且寫公共元件時,使用者不必為了配合你而改自己的程式碼。這也是為什麼多數 jQuery 外掛都用這種形式包裝。
遇到衝突時,先在控制台執行 $.fn.jquery,看回傳的版本號是不是你預期的那一個;接著檢查 window.$ 與 window.jQuery 是否指向同一個物件。多數問題在這兩步就能定位。若是外掛彼此衝突(而非與 jQuery 衝突),則要留意它們是否各自定義了同名的方法或全域變數。