JavaScript由于不像其他OO語言那樣有namespace,所有全局變量(不管是有意還是無意)都會被添加到window對象里。這樣既容易造成命名沖突,還不便于管理。本篇就介紹一下JavaScript中如何實現命名空間namespace。
首先你需要確定一下按什么規則定義命名空間,通常會按項目名或功能名來分配命名空間。例如我司開發的X控件庫,所有對象就掛在全局變量X下:
var X = {};
X.xButton = {};
…
X.xInputField = {};
X變量作為根變量,底下各控件,如按鈕使用X.xButton,文本框用X.xInputField,這樣團隊可以放心大膽地為自己開發的控件定義屬性和方法,或調用他人開發的控件代碼,而不必擔心命名沖突。類似地jQuery庫都掛在jQuery對象下,Yahoo庫都掛在Y對象下,這樣可以即便于管理,也防止了命名污染。
如果你就一個文件,上面這樣就夠了。但通常項目不止一個文件,尤其是引入多個庫時,要保證多個庫的根命名空間不沖突。即便是同一個庫,有多個文件的話,也要保證多文件內定義的子命名空間不沖突。
先看避免多個庫的根命名空間沖突(雖然概率可能比較小)。
例如jQuery里$對象是jQuery對象的別名,但如果其他庫也用$對象,就會發生沖突。別看現在jQuery牛bi哄哄,早期jQuery剛推出時心也是很虛的,因此jQeruy提供了noConflict
方法可以讓渡根對象$的控制權。
例如下面3個例子:直接放棄$,將$改名,將$移到一個新的命名空間下
//直接放棄$
jQuery.noConflict();
jQuery("p").hide(); //使用 jQuery的代碼
$("content").style.display = "none"; //使用其他庫的 $()
//將$改名
var j = jQuery.noConflict();
j("p").hide(); //使用 jQuery的代碼
$("content").style.display = "none"; //使用其他庫的 $()
//將$移到一個新的命名空間下
var newQuery = {};
newQuery.$ = jQuery.noConflict(true);
newQuery.$("div.aa").css("background-color","red"); //使用 jQuery的代碼
$("div.aa").css("background-color","blue"); //使用其他庫的 $()
當然關于noConflict更多例子請自行查閱jQuery官網。
再看避免同一個庫內多個子命名空間的沖突。通常可以自定義一個生成命名空間的函數,將命名空間傳入并進行檢查,沒有就新建,有了就沿用:
var X = {
namespace: function(ns) { //將命名空間傳入該方法進行檢查
var parts = ns.split("."),
object = this, i, len;
for(i = 0, len = parts.length; i < len; i++) {
if (typeof object[parts[i]] === "undefined") {
object[parts[i]] = {}; //沒有就新建
}
object = object[parts[i]];
}
return object;
}
}
X.namespace("xButton.widget");
X.namespace("xInputField.widget ");
X.xButton.widget = …
X.xInputField.widget = …
根據功能劃分的各文件,都調用自定義的namespace方法來聲明需要的命名空間,開發者就不必擔心命名空間沖突的問題了。