JavaScript模塊

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的模塊究竟是什么?它是一種代碼的組織方式,用函數和閉包來構造模塊。模塊隱藏了私有的屬性和方法,對外暴露出公有屬性和方法。

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 229,460評論 6 538
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 99,067評論 3 423
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 177,467評論 0 382
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,468評論 1 316
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,184評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,582評論 1 325
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,616評論 3 444
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,794評論 0 289
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,343評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 41,096評論 3 356
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,291評論 1 371
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,863評論 5 362
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,513評論 3 348
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,941評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,190評論 1 291
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,026評論 3 396
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,253評論 2 375

推薦閱讀更多精彩內容