seajs是淘宝的前UED玉伯写的,可以在http://seajs.org/docs/看到更全面的说明
在 Sea.js 中,所有 JavaScript 模块都遵循 CMD(Common Module Definition) 模块定义规范。该规范明确了模块的基本书写格式和基本交互规则。
在 CMD 规范中,一个模块就是一个文件。代码的书写格式如下:define(factory);
define是一个全局函数,用来定义模块
接收factory参数,factory可以是一个函数,也可以是一个对象或者字符串。
factory为对象或者字符串时表示该模块的接口就是该对象或者字符串,
eg:
define({"foo":"bar"})(对象接口)
define("I'm a templete.My name is {{name}}.")(字符串接口)
define(function(require,exports,module){//模块代码
})
define也可以接受两个以上的参数:
define(id,deps,factory)(id 表示模块标识,数组deps表示模块依赖,他们可以省略,省略的时候可以通过构建工具自动生成。带 id 和 deps 参数的 define 用法不属于 CMD 规范,而属于 Modules/Transport 规范。)
define.cmd:一个空对象,可用来判断当前页面是否有cmd模块加载器:
if (typeof define === "function" && define.cmd) {
// 有 Sea.js 等 CMD 模块加载器存在}
}
require是factory函数的第一个参数,它是一个函数,接受模块标识作为其唯一参数,用来获取其他模块提供的接口,require不能被修改,只有这一种唯一的写法,require的参数必须是字符串直接量:
define(function(require,exports){
var a=require("./a");//获取模块a的接口
a.doSomething();//调用模块a的方法
})
有时需要加载动态依赖,这时可以加一个判断,
如
if (todayIsWeekend)
require("play");
else
require("work");
但是从静态文件的角度来看,这个模块同时依赖play和work这两个模块,可以使用require.async来进行条件加载。
require.async用于在模块内部异步加载模块,并在加载完成后执行指定回调函数,回调函数可以缺省:
define(function(require,exports){
//异步加载一个模块
require.async("./b",function(b){
b.doSomething();
});
require.async(["./c","./d"],function(c,d){
//异步加载多个模块
c.doSomething();
d.doSomething();
});
})
小结:require是同步执行的,require.async 则是异步回调执行。require.async 一般用来加载可延迟异步加载的模块。
require.resolve(id):
使用模块系统内部的路径解析机制来解析并返回模块路径。该函数不会加载模块,只会返回解析后的绝对路径。这可以用来获取模块路径,一般用在插件环境可能需要动态拼接模块路径的情况下。
exports是一个对象,用来提供模块对外的接口:
define(function(require,exports){
exports.foo="foo";//对外提供foo属性
exports.doSomething=function(){}//对外提供doSomething方法
})
除了给exports对象增加成员,还可以通过return直接向外提供模块接口:
define(function(require){
return {
"foo":"foo",
doSomething:function(){}
}
})
如果return语句是代码中的唯一代码,也可以直接写成:
define({
"foo":"foo",
doSomething:function(){}
})
上面这种格式很适合定义jsonp模块。
下面这种写法不正确:
define(function(require, exports) {
// 错误用法!!!
exports = {
foo: 'bar',
doSomething: function() {};
};
});
正确的写法应该是:
define(function(require, exports,module) {
module.exports = {
foo: 'bar',
doSomething: function() {};
};
});
exports仅仅是module.exports的一个引用,在factory内部给exports赋值,并不能改变module.exports的值,不能用来更改模块接口。
module是一个对象,用来存储与当前模块相关联的一些属性和方法:
module.id:模块的唯一标识
module.uri:根据模块系统的路径解析规则得到的模块绝对路径(一般情况下,没有在define中手写id参数的时候,module.id===module.uri)
module.dependencies是一个数组,表示当前模块的依赖
module.exports:当前模块对外的接口
传给factory构造函数的参数exports是module.exports对象的一个引用。只通过exports来提供接口,有时无法满足开发需求。比如当接口是某个类的实例时,需要通过module.exports来实现:
define(function(require, exports, module) {
// exports 是 module.exports 的一个引用
console.log(module.exports === exports); // true
// 重新给 module.exports 赋值
module.exports = new SomeClass();
// exports 不再等于 module.exports
console.log(module.exports === exports); // false
});
对module.exports的赋值需要同步执行,不能放在回调函数里面