该文章转自阮一峰个人网站,仅做学习之用;
一、原始写法
模块就是实现特定功能的一组方法。
只要把不同的函数(以及记录状态的变量)简单地放在一起,就算是一个模块。
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》。