在網站開發中,現在很少有人還願意手寫 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。當頁面上同時存在別人定義的 $,衝突就無可避免。實務上有兩條路可走。
核心只有一行:$$ = jQuery.noConflict()。但要讓它平穩運作,需要配套四件事:
$$ = jQuery.noConflict();若使用 jQuery 附帶的 VS 智慧提示檔(jQueryXXX–vsdoc.js),也要把結尾的 window.jQuery = window.$ = jQuery; 改為 window.jQuery = window.$$ = jQuery;。$ = jQuery.noConflict();,結尾再加 $$ = jQuery.noConflict();。$ 的檔案,最上面先呼叫 jQuery.noConflict(),表示把 $ 的「主導權」交還給既有程式,檔案末尾同樣補上 $$ = jQuery.noConflict()。做完之後,$ 仍代表原本的意思,需要 jQuery 時改用 jQuery 或 $$ 即可。
優點:只需改動少數幾個檔案。
缺點:$$ 打起來不順手,而且以後每引入一個新插件,都得重跑一次步驟二。
考量到 jQuery 在後續專案中會被大量使用,長期寫 $$ 或 jQuery 反而別扭,最後我採用了這個方向:把原有自製的 $ 改名為 $get,一方面避開衝突,一方面剛好與 ASP.NET AJAX 的命名習慣對齊。
用 Visual Studio 做全域替換並不難,但仍有一些細節:
$(" 換成 $get(",再把 $(' 換成 $get(',最後才把殘留的 $ 換成 $get。順序錯了容易產生 $getget 這類慘案。幾個實用設定:Use 千萬別勾 Regular expressions,因為右側提示明確寫著 $ 代表 End of Line,一旦啟用正則,整批替換會變成災難。Look In 選 Current Project,按下右側按鈕後還能勾選多個目錄來縮小範圍。Look at these file types 則可指定特定副檔名,進一步把搜尋結果收攏。
若專案歷史包袱不重、jQuery 只是配角,方案一成本最低。若 jQuery 已是主力工具、團隊會長期維護,方案二雖然前期工時較高,卻能換來更乾淨的程式碼風格。