JS模块化编程

对象写法

模块即实现特定功能的一组方法。只要把不同的函数(以及记录状态的变量)简单地放在一起,就算是一个模块。

若多个函数依次调用,缺点很明显:”污染”了全局变量,无法保证不与其他模块发生变量名冲突,而且模块成员之间看不出直接关系。

避免这种缺点,可以使用对象写法:把模块写成一个对象,把所有的模块成员(即所要调用的函数)写进一个对象里。

1
2
3
4
5
6
7
8
9
var module1 = new Object({
_count: 0,
m1: function() {
//code here
},
m2: function() {
//code here
}
});

则调用函数即访问对象的属性: module1.m1();

但是,这样的写法会暴露所有模块成员,内部状态可以被外部改写。比如,外部代码可以直接改变内部计数器的值: module1._count = 5;

立即执行函数

使用”立即执行函数”(IIFE),可以达到不暴露私有成员的目的。

1
2
3
4
5
6
7
8
9
10
11
12
13
var module1 = (function() {
var _count = 0;
var m1 = function() {
//code here
};
var m2 = function() {
//code here
};
return {
m1: m1,
m2: m2
}; //将 m1、m2 暴露出来,可以被外部访问
})();

然而这种写法无法从外部访问到 _count 变量。以上就是JS模块的基本写法。

放大模式

1
2
3
4
5
6
var module1 = (function (mod) {
  mod.m3 = function () {
    //...
  };
  return mod;
})(module1);

上面的代码为 module1 模块 添加了一个新方法 m3(),然后返回新的 module1 模块。

宽放大模式

在浏览器环境中,模块的各个部分通常都是从网上获取的,有时无法知道哪个部分会先加载。如果采用上一节的写法,第一个执行的部分有可能加载一个不存在空对象,这时就要采用”宽放大模式”。

1
2
3
4
var module1 = (function(mod) {
   //...
   return mod;
})(window.module1 || {});

与”放大模式”的区别在于,"宽放大模式"就是”立即执行函数”的参数可以是空对象。

输入全局变量

独立性是模块的重要特点,模块内部最好不与程序的其他部分直接交互。为了在模块内部调用全局变量,必须显式地将其他变量输入模块。

1
2
3
var module1 = (function ($, YAHOO) {
//...
})(jQuery, YAHOO);

上面的 module1模块 需要使用 jQuery库 和 YUI库,就把这两个库(其实是两个模块)当作参数输入 module1。这样做除了保证模块的独立性,还使得模块之间的依赖关系变得明显。

虽然没接触过 YUI库,但是以后可能会用上。附上一篇写有用法的博客:http://www.blogjava.net/shenang/archive/2009/04/21/266712.html

Javascript模块规范

目前,通行的Javascript模块规范共有两种:CommonJS和AMD。先从CommonJS讲起。

CommonJS 有一个全局性方法 require(),用于 加载模块 。假定有一个数学模块 math.js,就可以像下面这样加载。

1
var math = require('math');

然后就可以调用模块提供的方法:

1
2
var math = require('math');
math.add(2,3); //输出5

然而这种方法有一个缺陷:第二行 math.add(2, 3),在第一行 require(‘math’) 之后运行,因此必须等 math.js 加载完成。也就是说,如果加载时间很长,整个应用就会停在那里等。
这对服务器端不是一个问题,因为所有的模块都存放在本地硬盘,可以同步加载完成,等待时间就是硬盘的读取时间。但是,对于浏览器,这却是一个大问题,因为模块都放在服务器端,等待时间取决于网速的快慢,可能要等很长时间,浏览器处于”假死”状态。

因此,浏览器端的模块,不能采用”同步加载”(synchronous),只能采用”异步加载”(asynchronous)。这就是 AMD规范 诞生的背景。

AMD

AMD 是”Asynchronous Module Definition”的缩写,意思就是”异步模块定义”。它采用异步方式加载模块,模块的加载不影响它后面语句的运行。所有依赖这个模块的语句,都定义在一个回调函数中,等到加载完成之后,这个回调函数才会运行。

AMD 也采用 require() 语句加载模块,但是不同于 CommonJS,它要求两个参数:

1
require([module], callback);

第一个参数 [module],是一个数组,里面的成员就是要加载的模块;第二个参数 callback,则是加载成功之后的回调函数。如果将前面的代码改写成 AMD 形式,就是下面这样:

1
2
3
require(['math'], function (math) {
math.add(2, 3);
});

math.add() 与 math 模块加载不是同步的,浏览器不会发生假死。所以很显然,AMD 比较适合浏览器环境。

require.js的用法

以往若我们有多个JS文件,会依次加载JS文件。这样有很大的缺陷:加载的时候,浏览器会停止网页渲染,加载文件越多,网页失去响应的时间就会越长;另外,由于JS文件之间的依赖性,我们需要弄清加载的顺序。当代码复杂时,这样的工作会十分巨大。

require.js 有两个作用:1、实现js文件的异步加载,避免网页失去响应;2、管理模块之间的依赖性,便于代码的编写和维护。

使用require.js的第一步,是先去官方网站下载最新版本。

下载后,假定把它放在js子目录下面,就可以加载了。

1
  <script src="js/require.js"></script>

有人可能会想到,加载这个文件,也可能造成网页失去响应。解决办法有两个,一个是把它放在网页底部加载,另一个是写成下面这样:

1
  <script src="js/require.js" defer async="true" ></script>

async 属性表明这个文件需要异步加载,避免网页失去响应。IE不支持这个属性,只支持 defer,所以把 defer 也写上。
加载 require.js 以后,下一步就要加载我们自己的代码了。假定我们自己的代码文件是 main.js,也放在 js目录 下面。那么,只需要写成下面这样就行了:

1
  <script src="js/require.js" data-main="js/main"></script>

data-main 属性的作用是,指定网页程序的主模块。在上例中,就是js目录下面的 main.js,这个文件会第一个被 require.js 加载。由于 require.js 默认的文件后缀名是js,所以可以把 main.js 简写成 main。

require.js 的其他应用详细见:http://www.ruanyifeng.com/blog/2012/11/require_js.html