DIV CSS 佈局教程網

jQuery 插件衝突怎麼辦?noConflict 完整解法與原理剖析
編輯:JQuery特效代碼     

許多 JavaScript 函式庫都選用 $ 作為函式或變數名稱,jQuery 是其中最典型的一個。在 jQuery 裡,$ 只是 window.jQuery 的一個參照,因此即使 $ 被覆寫,window.jQuery 依然是支撐整個函式庫完整性的後盾。也因為 API 設計時就考慮到了跨框架的引用衝突,我們才能用 jQuery.noConflict 輕鬆完成控制權的移交。

一、noConflict 的用法

這個方法帶有一個可選的布林參數,用來決定「移交 $ 參照的同時,是否連 jQuery 物件本身一起移交」:

jQuery.noConflict([removeAll])

預設情況下,執行 noConflict 會把變數 $ 的控制權交還給第一個產生 $ 的函式庫;當 removeAll 設為 true 時,$ 與 jQuery 物件本身的控制權會全部交還。

例如在 KISSY 與 jQuery 混用、又習慣用 $ = KISSY 來精簡 API 呼叫的情況下,就能靠這個方法解決命名衝突。

二、原來它是這樣實作的

翻開 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 兩者都會失效。

三、這種設計解決了什麼

不管是框架混用,還是 jQuery 多版本共存這種高度衝突的執行環境,noConflict 提供的移交機制加上「本身會回傳未被覆蓋的 jQuery 物件」這個特性,完全可以用變數映射的方式化解衝突。

唯一要留意的是插件可能因此失效。解法很簡單:把 jQuery 當參數傳進立即執行函式,$ 別名就回來了。

var query = jQuery.noConflict(true);
(function ($) {
  // 插件或其他形式的程式碼,也可以把參數設為 jQuery
})(query);

四、實戰:同一頁面並存多個 jQuery 版本

jQuery 的版本越來越多,官網也不斷更新。但老專案往往已經採用舊版本(1.3.x、1.4.x、1.5.x、1.6.2……),而新功能又需要新版。靠 noConflict(),不僅能讓 jQuery 與 Prototype 等函式庫並存,也能讓多個 jQuery 版本在同一頁共存不衝突。

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
  <head>
    <title>在同一個頁面中載入多個不同的 jQuery 版本</title>

    <!-- 從 CDN 載入 jQuery 最新版本 -->
    <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.5.2 -->
    <script type="text/javascript" src="https://ajax.googleapis.com/ajax/libs/jquery/1.5.2/jquery.min.js"></script>
    <script type="text/javascript">
      var jQuery_1_5_2 = $.noConflict(true);
    </script>

    <!-- 載入 jQuery 1.4.2 -->
    <script type="text/javascript" src="https://ajax.googleapis.com/ajax/libs/jquery/1.4.2/jquery.min.js"></script>
    <script type="text/javascript">
      var jQuery_1_4_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_5_2.fn.jquery);
      alert(jQuery_1_4_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'); });
      jQuery_1_5_2(function($){ $('<p>我是 ' + $.fn.jquery + ' 版本加入的。</p>').appendTo('body'); });
      jQuery_1_4_2(function($){ $('<p>我是 ' + $.fn.jquery + ' 版本加入的。</p>').appendTo('body'); });
      jQuery_1_3_2(function($){ $('<p>我是 ' + $.fn.jquery + ' 版本加入的。</p>').appendTo('body'); });
    </script>
  </head>
  <body>
    在同一個頁面中載入多個不同的 jQuery 版本
    <br>
  </body>
</html>

每載入一個版本就立刻用 noConflict(true) 把它「請下台」並存進專屬變數,之後要使用哪個版本,就呼叫對應的變數即可。這是維護老系統時相當實用的一招,不過新專案還是建議統一版本,避免 bundle 體積與維護成本失控。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved