JS模塊的寫法
該文章轉自阮一峰個人網站,僅做學習之用;
一、原始寫法
模塊就是實現特定功能的一組方法。
只要把不同的函數(以及記錄狀態的變量)簡單地放在一起,就算是一個模塊。
1 function m1(){ 2 //... 3 } 4 function m2(){ 5 //... 6 }
上面的函數m1()和m2(),組成一個模塊。使用的時候,直接調用就行了。
這種做法的缺點很明顯:"汙染"了全局變量,無法保證不與其他模塊發生變量名沖突,而且模塊成員之間看不出直接關系。
二、對象寫法
為了解決上面的缺點,可以把模塊寫成一個對象,所有的模塊成員都放到這個對象裏面。
1 var module1 = new Object({2 _count : 0, 3 m1 : function (){ 4 //... 5 }, 6 m2 : function (){ 7 //... 8 } 9 });
上面的函數m1()和m2(),都封裝在module1對象裏。使用的時候,就是調用這個對象的屬性。
1 module1.m1();
但是,這樣的寫法會暴露所有模塊成員,內部狀態可以被外部改寫。比如,外部代碼可以直接改變內部計數器的值。
1 module1._count = 5;
三、立即執行函數寫法
使用"立即執行函數"(Immediately-Invoked Function Expression,IIFE),可以達到不暴露私有成員的目的。
1 var module1 = (function(){ 2 var _count = 0; 3 var m1 = function(){ 4 //... 5 }; 6 var m2 = function(){ 7 //... 8 }; 9 return { 10 m1 : m1, 11 m2 : m2 12 }; 13 })();
使用上面的寫法,外部代碼無法讀取內部的_count變量。
1 console.info(module1._count); //undefined
module1就是Javascript模塊的基本寫法。下面,再對這種寫法進行加工。
四、放大模式
如果一個模塊很大,必須分成幾個部分,或者一個模塊需要繼承另一個模塊,這時就有必要采用"放大模式"(augmentation)。
1 var module1 = (function (mod){ 2 mod.m3 = function () { 3 //... 4 }; 5 return mod; 6 })(module1);
上面的代碼為module1模塊添加了一個新方法m3(),然後返回新的module1模塊。
五、寬放大模式(Loose augmentation)
在瀏覽器環境中,模塊的各個部分通常都是從網上獲取的,有時無法知道哪個部分會先加載。如果采用上一節的寫法,第一個執行的部分有可能加載一個不存在空對象,這時就要采用"寬放大模式"。
1 var module1 = ( function (mod){ 2 //... 3 return mod; 4 })(window.module1 || {});
與"放大模式"相比,"寬放大模式"就是"立即執行函數"的參數可以是空對象。
六、輸入全局變量
獨立性是模塊的重要特點,模塊內部最好不與程序的其他部分直接交互。
為了在模塊內部調用全局變量,必須顯式地將其他變量輸入模塊。
1 var module1 = (function ($, YAHOO) { 2 //... 3 })(jQuery, YAHOO);
上面的module1模塊需要使用jQuery庫和YUI庫,就把這兩個庫(其實是兩個模塊)當作參數輸入module1。這樣做除了保證模塊的獨立性,還使得模塊之間的依賴關系變得明顯。這方面更多的討論,參見Ben Cherry的著名文章《JavaScript Module Pattern: In-Depth》。
JS模塊的寫法