JavaScript模塊

JavaScript不像其他OO語言有public / private關(guān)鍵字,小應(yīng)用中無所謂,但大工程里,如果所有屬性或方法均為公有,即無必要,也維護(hù)困難。JavaScript中要實(shí)現(xiàn)私有屬性或方法的封裝,需要一種特殊的代碼結(jié)構(gòu),稱為模塊。

之前的JavaScript繼承里已經(jīng)蜻蜓點(diǎn)水般介紹過如何通過模塊實(shí)現(xiàn)私有屬性隱藏,但由于不是主題,因此介紹的比較簡(jiǎn)單。下面詳細(xì)介紹一下。

例如要定義一個(gè)array模塊,只暴露出inArray和isArray這兩個(gè)公共方法。

第一步先為模塊聲明一個(gè)命名空間

X.namespace('utilities.array');

再返回一個(gè)字面量對(duì)象,內(nèi)容可以暫時(shí)為空:

X.utilities.array = (function() {
  return {
    //todo...
  };
}());

第二步為這個(gè)字面量對(duì)象添加inArray和isArray這兩個(gè)公共方法,并用()包起來立即執(zhí)行:

X.utilities.array = (function () {
  return {
    inArray: function () { },
    isArray: function () { }
  };
}());

立即執(zhí)行的目的是讓每個(gè)模塊都有各自獨(dú)立的作用域,每個(gè)模塊文件內(nèi)的全局變量,都會(huì)變成了匿名函數(shù)內(nèi)部的局部變量。這樣就完全不必操心是否有變量,函數(shù)等是否重名的問題,實(shí)現(xiàn)了模塊的隔離。每個(gè)模塊都可以獨(dú)立開發(fā)了。

第三步為函數(shù)添加私有屬性和方法,并實(shí)現(xiàn)字面量對(duì)象里的公共方法:

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

由于函數(shù)是立即執(zhí)行函數(shù),所以能封裝私有屬性和方法。定義在X.utilities.array模塊的return語句外的屬性和方法都是私有的,外部是無法訪問的。需要被暴露給外部的屬性和方法,統(tǒng)一被加到了對(duì)象字面量里,最后return出這個(gè)對(duì)象字面量。

上面這種組織代碼的方式就是模塊的雛形,被廣泛使用。你可以用這種方式組織自己的代碼,實(shí)現(xiàn)封裝。

因?yàn)樯厦鎟eturn語句里集中了大量代碼,看起來比較吃力。因此還有一個(gè)變種,將大段代碼放入私有方法內(nèi),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;
        };

    //公共對(duì)象
    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語句就一目了然了。兩種代碼的組織方式并沒有什么本質(zhì)上的區(qū)別,你可以隨自己的需求來選用。

你還可以給模塊傳遞任意參數(shù),通常參數(shù)都是全局變量,導(dǎo)入的全局變量會(huì)成為模塊的局部變量,加速內(nèi)部對(duì)全局符號(hào)的解析速度。例如X.utilities.array模塊內(nèi)部如果需要用到j(luò)Query庫和YUI庫,可以這樣:

X.utilities.array = (function ($, Y) {
  ...
}(jQuery, YAHOO));

這樣一個(gè)X.utilities.array模塊就定義好了。當(dāng)然實(shí)際項(xiàng)目中array沒必要也不推薦自定義,直接用原生的Array即可,這里只是舉個(gè)例子而已。重要的是了解模塊的這種代碼組織方式。

實(shí)際項(xiàng)目中一個(gè)模塊可能就是一個(gè)文件,但如果模塊比較大時(shí),為了開發(fā)的方便,也常會(huì)拆分成幾個(gè)小文件。例如上面的X.utilities.array寫在一個(gè)文件里,現(xiàn)在想在新文件里為該模塊新增一個(gè)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

最終用部署工具將多個(gè)文件一合并就行了,新增的indexOf方法和定義在模塊中的其他方法并無二致:


總結(jié)

回過頭再去想想JavaScript的模塊究竟是什么?它是一種代碼的組織方式,用函數(shù)和閉包來構(gòu)造模塊。模塊隱藏了私有的屬性和方法,對(duì)外暴露出公有屬性和方法。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

推薦閱讀更多精彩內(nèi)容