JavaScript不像其他OO語言有public / private關鍵字,小應用中無所謂,但大工程里,如果所有屬性或方法均為公有,即無必要,也維護困難。JavaScript中要實現私有屬性或方法的封裝,需要一種特殊的代碼結構,稱為模塊。
之前的JavaScript繼承里已經蜻蜓點水般介紹過如何通過模塊實現私有屬性隱藏,但由于不是主題,因此介紹的比較簡單。下面詳細介紹一下。
例如要定義一個array模塊,只暴露出inArray和isArray這兩個公共方法。
第一步先為模塊聲明一個命名空間:
X.namespace('utilities.array');
再返回一個字面量對象,內容可以暫時為空:
X.utilities.array = (function() {
return {
//todo...
};
}());
第二步為這個字面量對象添加inArray和isArray這兩個公共方法,并用()包起來立即執行:
X.utilities.array = (function () {
return {
inArray: function () { },
isArray: function () { }
};
}());
立即執行的目的是讓每個模塊都有各自獨立的作用域,每個模塊文件內的全局變量,都會變成了匿名函數內部的局部變量。這樣就完全不必操心是否有變量,函數等是否重名的問題,實現了模塊的隔離。每個模塊都可以獨立開發了。
第三步為函數添加私有屬性和方法,并實現字面量對象里的公共方法:
X.utilities.array = (function () {
//如果依賴其他模塊,也可以添加一下
var uobj = X.utilities.object,
ulang = X.utilities.lang,
//私有屬性
array_string = "[object Array]",
ops = Object.prototype.toString;
//私有方法
//...
//公共API
return {
inArray: function (needle, haystack) {
for (var i=0, max=haystack.length; i<max; i+=1) {
if (haystack[i] === needle) {
return true;
}
}
},
isArray: function (a) {
return ops.call(a) === array_string;
}
};
}());
console.log(X.utilities.array.array_string); //undefined,外部無法訪問
console.log(X.utilities.array.isArray([1,2,3])); //true
console.log(X.utilities.array.isArray(1)); //false
由于函數是立即執行函數,所以能封裝私有屬性和方法。定義在X.utilities.array模塊的return語句外的屬性和方法都是私有的,外部是無法訪問的。需要被暴露給外部的屬性和方法,統一被加到了對象字面量里,最后return出這個對象字面量。
上面這種組織代碼的方式就是模塊的雛形,被廣泛使用。你可以用這種方式組織自己的代碼,實現封裝。
因為上面return語句里集中了大量代碼,看起來比較吃力。因此還有一個變種,將大段代碼放入私有方法內,return語句只做映射:
X.utilities.array = (function () {
//私有屬性
var array_string = "[object Array]",
ops = Object.prototype.toString,
//私有方法
inArray = function (needle, haystack) {
for (var i=0, max=haystack.length; i<max; i+=1) {
if (haystack[i] === needle) {
return true;
}
}
},
isArray = function (a) {
return ops.call(a) === array_string;
};
//公共對象
return {
inArray: inArray,
isArray: isArray
};
}());
console.log(X.utilities.array.array_string); //undefined
console.log(X.utilities.array.inArray(2, [1,2,3])); //true
console.log(X.utilities.array.isArray([1,2,3])); //true
這樣該模塊究竟提供了哪些公共屬性和方法,看一眼return語句就一目了然了。兩種代碼的組織方式并沒有什么本質上的區別,你可以隨自己的需求來選用。
你還可以給模塊傳遞任意參數,通常參數都是全局變量,導入的全局變量會成為模塊的局部變量,加速內部對全局符號的解析速度。例如X.utilities.array模塊內部如果需要用到jQuery庫和YUI庫,可以這樣:
X.utilities.array = (function ($, Y) {
...
}(jQuery, YAHOO));
這樣一個X.utilities.array模塊就定義好了。當然實際項目中array沒必要也不推薦自定義,直接用原生的Array即可,這里只是舉個例子而已。重要的是了解模塊的這種代碼組織方式。
實際項目中一個模塊可能就是一個文件,但如果模塊比較大時,為了開發的方便,也常會拆分成幾個小文件。例如上面的X.utilities.array寫在一個文件里,現在想在新文件里為該模塊新增一個indexOf公有方法,你可以:
X.utilities.array = (function (mod){
mod.indexOf = function (needle, haystack) {
for (var i=0, max=haystack.length; i<max; i+=1) {
if (haystack[i] === needle) {
return i;
}
}
return -1;
};
return mod;
})(X.utilities.array);
console.log(X.utilities.array.indexOf(2, [1,2,3])); //1
最終用部署工具將多個文件一合并就行了,新增的indexOf方法和定義在模塊中的其他方法并無二致:
總結
回過頭再去想想JavaScript的模塊究竟是什么?它是一種代碼的組織方式,用函數和閉包來構造模塊。模塊隱藏了私有的屬性和方法,對外暴露出公有屬性和方法。