DIV CSS 佈局教程網

載入 jQuery 後 $ 衝突怎麼解?兩種實戰方案完整比較
編輯:JQuery特效代碼     

在網站開發中,現在很少有人還願意手寫 document.getElementById() 了。這個方法名字長、又區分大小寫,一不留神就拼錯。於是各種自己包的 $() 簡寫層出不窮:

function $() {
  var elements = new Array();
  for (var i = 0; i < arguments.length; i++) {
    var element = arguments[i];
    if (typeof element == 'string')
      element = document.getElementById(element);
    if (arguments.length == 1)
      return element;
    elements.push(element);
  }
  return elements;
}

微軟的 ASP.NET AJAX 客戶端腳本框架也有類似設計,只是名字叫 $get:

var $get = Sys.UI.DomElement.getElementById = function Sys$UI$DomElement$getElementById(id, element) {
  var e = Function._validateParams(arguments, [
    {name: "id", type: String},
    {name: "element", mayBeNull: true, domElement: true, optional: true}
  ]);
  if (e) throw e;
  if (!element) return document.getElementById(id);
  if (element.getElementById) return element.getElementById(id);
  // 不支援元素層級 getElementById 的瀏覽器,改用手動佇列走訪
  var nodeQueue = [];
  var childNodes = element.childNodes;
  for (var i = 0; i < childNodes.length; i++) {
    var node = childNodes[i];
    if (node.nodeType == 1) nodeQueue[nodeQueue.length] = node;
  }
  while (nodeQueue.length) {
    node = nodeQueue.shift();
    if (node.id == id) return node;
    childNodes = node.childNodes;
    for (i = 0; i < childNodes.length; i++) {
      node = childNodes[i];
      if (node.nodeType == 1) nodeQueue[nodeQueue.length] = node;
    }
  }
  return null;
}

衝突是怎麼發生的

jQuery 因為語法簡潔優美,加上微軟大力推廣,幾乎成了專案標配。它以 $ 函數作為工廠入口,也就是 $ = jQuery。當頁面上同時存在別人定義的 $,衝突就無可避免。實務上有兩條路可走。

方案一:用 noConflict() 把 $$ 讓給 jQuery

核心只有一行:$$ = jQuery.noConflict()。但要讓它平穩運作,需要配套四件事:

  1. 在包含 jQuery 以及所有依賴 jQuery 的 JavaScript 檔最後加上 $$ = jQuery.noConflict();若使用 jQuery 附帶的 VS 智慧提示檔(jQueryXXX–vsdoc.js),也要把結尾的 window.jQuery = window.$ = jQuery; 改為 window.jQuery = window.$$ = jQuery;。
  2. 每個基於 jQuery 的插件或擴充檔,開頭加 $ = jQuery.noConflict();,結尾再加 $$ = jQuery.noConflict();。
  3. 原本自己實作 $ 的檔案,最上面先呼叫 jQuery.noConflict(),表示把 $ 的「主導權」交還給既有程式,檔案末尾同樣補上 $$ = jQuery.noConflict()。
  4. 注意頁面引入順序:jQuery 相關檔案放前面,與 jQuery 無關的放後面。

做完之後,$ 仍代表原本的意思,需要 jQuery 時改用 jQuery 或 $$ 即可。

優點:只需改動少數幾個檔案。
缺點:$$ 打起來不順手,而且以後每引入一個新插件,都得重跑一次步驟二。

方案二:反過來,把舊的 $ 全部換掉

考量到 jQuery 在後續專案中會被大量使用,長期寫 $$ 或 jQuery 反而別扭,最後我採用了這個方向:把原有自製的 $ 改名為 $get,一方面避開衝突,一方面剛好與 ASP.NET AJAX 的命名習慣對齊。

用 Visual Studio 做全域替換並不難,但仍有一些細節:

  1. 替換順序有講究:先把 $(" 換成 $get(",再把 $(' 換成 $get(',最後才把殘留的 $ 換成 $get。順序錯了容易產生 $getget 這類慘案。
  2. 替換時善用 VSS 的簽出提示,逐檔確認。這種全域變更一旦出錯,影響範圍不小,慢一點反而安全。
  3. Visual Studio 的 Replace in Files 功能其實藏了不少學問。

幾個實用設定:Use 千萬別勾 Regular expressions,因為右側提示明確寫著 $ 代表 End of Line,一旦啟用正則,整批替換會變成災難。Look In 選 Current Project,按下右側按鈕後還能勾選多個目錄來縮小範圍。Look at these file types 則可指定特定副檔名,進一步把搜尋結果收攏。

該選哪一個?

若專案歷史包袱不重、jQuery 只是配角,方案一成本最低。若 jQuery 已是主力工具、團隊會長期維護,方案二雖然前期工時較高,卻能換來更乾淨的程式碼風格。

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