DIV CSS 佈局教程網

jQuery 與其他函式庫的 $ 命名衝突怎麼解決
編輯:JavaScript綜合知識     

首先要釐清一個事實:在 jQuery 中,$ 就是 jQuery 的別名,兩者完全等價。也就是說 $('#xmlas') 與 jQuery('#xmlas') 只是寫法不同,執行結果一模一樣。

問題就出在這個簡短的別名上——Prototype、MooTools、YUI 等函式庫也都把 $ 作為核心快捷方式,多個函式庫同時載入時,後者會覆蓋前者,衝突於焉而生。

解決思路有兩條:一是用不同的名稱稱呼它們,二是讓它們各自處於不同的命名空間。

情況一:jQuery 在其他函式庫之前載入

這種順序下,不必呼叫 noConflict,直接使用 jQuery 這個全名即可:

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- 先載入 jQuery -->
<script src="../../scripts/jquery-1.3.1.js" type="text/javascript"></script>
<!-- 後載入其他函式庫 -->
<script src="prototype-1.6.0.3.js" type="text/javascript"></script>
</head>
<body>
<p id="pp">test---prototype</p>
<p>test---jQuery</p>
<script type="text/javascript">
jQuery(function(){  // 直接用 jQuery,不必呼叫 noConflict
  jQuery("p").click(function(){
    alert( jQuery(this).text() );
  });
});

$("pp").style.display = 'none';  // 這裡的 $ 屬於 prototype
</script>
</body>
</html>

情況二:jQuery 在其他函式庫之後載入

這時需要呼叫 jQuery.noConflict(),把 $ 的控制權讓給先前的函式庫。有以下幾種變體。

寫法一:直接還原 $

<script type="text/javascript">
jQuery.noConflict();  // 把 $ 的控制權讓渡給 prototype.js
jQuery(function(){    // 使用 jQuery
  jQuery("p").click(function(){
    alert( jQuery(this).text() );
  });
});
$("pp").style.display = 'none';  // 使用 prototype
</script>

寫法二:自訂一個簡短的別名

<script type="text/javascript">
var $j = jQuery.noConflict();  // noConflict 會回傳 jQuery 本身
$j(function(){
  $j("p").click(function(){
    alert( $j(this).text() );
  });
});
$("pp").style.display = 'none';  // 使用 prototype
</script>

寫法三:把 $ 作為 ready 的參數傳入

<script type="text/javascript">
jQuery.noConflict();
jQuery(function($){     // 參數名為 $,僅在此函式內有效
  $("p").click(function(){  // 繼續使用 $
    alert( $(this).text() );
  });
});
$("pp").style.display = 'none';  // 使用 prototype
</script>

寫法四:用 IIFE 建立獨立作用域(推薦)

<script type="text/javascript">
jQuery.noConflict();
(function($){     // 定義匿名函式並以 $ 為參數
  $(function(){    // 此處的 $ 均指 jQuery
    $("p").click(function(){
      alert($(this).text());
    });
  });
})(jQuery);      // 傳入 jQuery 作為實參

$("pp").style.display = 'none';  // 使用 prototype
</script>

這四種寫法中,第四種最為通用。它並不限於 ready 場合——整個檔案的 jQuery 程式碼都可以包進這個 IIFE 裡,之後就能自然地到處使用 $,而全域的 $ 則完全留給其他函式庫。這也是今日 jQuery 外掛開發的標準寫法。

另一條路:自訂命名空間

如果不想依賴 noConflict,也可以替自己的程式建立專屬命名空間。假設專案代號是 xmlas,原本寫成:

$('contentArea').show()

可以改為:

XMLAS('contentArea').show()

做法是把自己的函式都掛在一個全域物件底下,例如 window.XMLAS = {...}。這樣做的好處是不必理會載入順序,也不會與任何人衝突;代價是程式碼變長,且失去了 jQuery 的鏈式呼叫優勢。對小型專案來說,這個「最笨但最有效」的方法其實很值得考慮。

一個常見的完整寫法

實務上最常看到的就是 noConflict 搭配 IIFE 的組合:

<script type="text/javascript" src="photolist.js"></script>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript">
$.noConflict();
jQuery(function($) {
  // 使用了 $ 的 jQuery 程式碼
});
// 這裡放其他函式庫的程式碼
</script>

最後補一個觀念:這種衝突問題在今日已大幅減少,因為主流函式庫多已改採 UMD 或 ES Module 包裝,不再搶佔全域的 $。若你正在整合 Prototype 這類老舊函式庫,除了上述做法,更根本的建議是評估能否用現代方案取代它。

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