CMD模块定义规范

CMD(Common Module Definition) 通用模块定义。在 CMD 规范中,一个模块就是一个文件。

代码的书写格式如下:

define(factory);
define 接受 factory 参数,factory 可以是一个函数,也可以是一个对象或字符串。

factory 为对象、字符串时,表示模块的接口就是该对象、字符串。

factory 为函数时,表示是模块的构造方法。执行该构造方法,可以得到模块向外提供的接口。factory 方法在执行时,默认会传入三个参数:requireexports 和 module

define(function(require,exports,module){
// 模块代码
});

define 也可以接受两个以上参数。字符串 id 表示模块标识,数组 deps 是模块依赖。比如:

define(‘hello‘,[‘jquery‘],function(require,exports,module){// 模块代码});

id 和 deps 参数可以省略。省略时,可以通过构建工具自动生成。

注意:带 id 和 deps 参数的 define 用法不属于 CMD 规范,而属于 Modules/Transport 规范。

define.cmd

一个空对象,可用来判定当前页面是否有 CMD 模块加载器:

if(typeof define==="function"&&define.cmd){
// 有 Sea.js 等 CMD 模块加载器存在
}

require

require 是 factory 函数的第一个参数。

  require 是一个方法,接受 模块标识 作为唯一参数,用来获取其他模块提供的接口。

define(function(require,exports){// 获取模块 a 的接口vara=require(‘./a‘);// 调用模块 a 的方法a.doSomething();});
注意:在开发时,require 的书写需要遵循一些 简单约定

require.async

require.async 方法用来在模块内部异步加载模块,并在加载完成后执行指定回调。callback 参数可选。

define(function(require,exports,module){
// 异步加载一个模块,在加载完成时,执行回调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

使用模块系统内部的路径解析机制来解析并返回模块路径。该函数不会加载模块,只返回解析后的绝对路径。

define(function(require,exports){
console.log(require.resolve(‘./b‘));// ==> http://example.com/path/to/b.js
});

这可以用来获取模块路径,一般用在插件环境或需动态拼接模块路径的场景下。

exports

exports 是一个对象,用来向外提供模块接口。

define(function(require,exports){// 对外提供 foo 属性 exports.foo = ‘bar‘;// 对外提供 doSomething 方法  exports.doSomething = function() {};});

除了给 exports 对象增加成员,还可以使用 return 直接向外提供接口。

define(function(require){// 通过 return 直接提供接口return {
    foo: ‘bar‘,
    doSomething: function() {}
  };});

如果 return 语句是模块中的唯一代码,还可简化为:

define({foo:‘bar‘,doSomething:function(){}});

上面这种格式特别适合定义 JSONP 模块。

define(function(require,exports,module){// 正确写法
    module.exports = {
    foo: ‘bar‘,
    doSomething: function() {}
  };});

提示exports 仅仅是 module.exports 的一个引用。在 factory 内部给 exports 重新赋值时,并不会改变module.exports 的值。因此给 exports 赋值是无效的,不能用来更改模块接口。

module

module 是一个对象,上面存储了与当前模块相关联的一些属性和方法。

module.id

模块的唯一标识。

define(‘id‘,[],function(require,exports,module){// 模块代码});

上面代码中,define 的第一个参数就是模块标识。

module.uri

根据模块系统的路径解析规则得到的模块绝对路径。

define(function(require,exports,module){console.log(module.uri);// ==> http://example.com/path/to/this/file.js});

一般情况下(没有在 define 中手写 id 参数时),module.id 的值就是 module.uri,两者完全相同。

module.dependencies

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.exportsconsole.log(module.exports===exports);// false
});

注意:对 module.exports 的赋值需要同步执行,不能放在回调函数里。下面这样是不行的:

// x.jsdefine(function(require,exports,module){
// 错误用法
setTimeout(function(){module.exports={a:"hello"};},0);
});

在 y.js 里有调用到上面的 x.js:

// y.jsdefine(function(require,exports,module){varx=require(‘./x‘);
// 无法立刻得到模块 x 的属性 aconsole.log(x.a);
// undefined});

小结

这就是 CMD 模块定义规范的所有内容。经常使用的 API 只有 definerequirerequire.asyncexports,module.exports 这五个。其他 API 有个印象就好,在需要时再来查文档,不用刻意去记。

时间: 2024-10-10 23:29:06

CMD模块定义规范的相关文章

CMD 模块定义规范

在 Sea.js 中,所有 JavaScript 模块都遵循 CMD(Common Module Definition) 模块定义规范.该规范明确了模块的基本书写格式和基本交互规则. 在 CMD 规范中,一个模块就是一个文件.代码的书写格式如下: define(factory); define Function define 是一个全局函数,用来定义模块. define define(factory) define 接受 factory 参数,factory 可以是一个函数,也可以是一个对象或字

Sea.js学习3——Sea.js的CMD 模块定义规范

在 Sea.js 中,所有 JavaScript 模块都遵循 CMD(Common Module Definition) 模块定义规范.该规范明确了模块的基本书写格式和基本交互规则. 在 CMD 规范中,一个模块就是一个文件.代码的书写格式如下: define(factory); define Function define 是一个全局函数,用来定义模块. define define(factory) define 接受 factory 参数,factory 可以是一个函数,也可以是一个对象或字

CMD (sea.js)模块定义规范

转自http://www.cnblogs.com/hongchenok/p/3685677.html CMD 模块定义规范 在 Sea.js 中,所有 JavaScript 模块都遵循 CMD(Common Module Definition) 模块定义规范.该规范明确了模块的基本书写格式和基本交互规则. 在 CMD 规范中,一个模块就是一个文件.代码的书写格式如下: define(factory); define Function define 是一个全局函数,用来定义模块. define d

AMD模块定义规范

AMD 即Asynchronous Module Definition,中文名是"异步模块定义"的意思.它是一个在浏览器端模块化开发的规范,服务器端的规范是CommonJS.   模块将被异步加载,模块加载不影响后面语句的运行.所有依赖某些模块的语句均放置在回调函数中. AMD 是 RequireJS 在推广过程中对模块定义的规范化的产出. define() 函数 AMD规范只定义了一个函数 define,它是全局变量.函数的描述为: define(id?, dependencies?

AMD(异步模块定义规范)

AMD规范:https://github.com/amdjs/amdjs-api/wiki/AMD 本规范只定义了一个函数 "define",它是全局变量.函数的描述为: define(id?, dependencies?, factory); 第一个参数,id,是个字符串.它指的是定义中模块的名字,这个参数是可选的.如果没有提供该参数,模块的名字应该默认为模块加载器请求的指定脚本的名字.如果提供了该参数,模块名必须是“顶级”的和绝对的(不允许相对名字). 第二个参数,dependen

如何改造现有文件为 CMD 模块

经过一段考察,我们终于要在项目中引入模块机制和 Sea.js 了,那么如何将现有的文件改造成 CMD 模块就成了重要的问题.下面针对一些典型场景来说明包装的方式. 首先还是请大家详细了解下 CMD 模块定义规范,只要洞悉事物的定义和本质,一切问题可迎刃而解. 改造主流模块 这里指的是 jQuery.Moment.Backbone.underscore 等业界主流模块,这些模块一般都有对 AMD 和 CommonJS 的支持代码,例如 jQuery 源文件的最后几行: if ( typeof mo

seajs2.3学习日志 简单尝试模板+数据合并、模块异步加载、非标准CMD模式定义define模块

今天继续尝试seajs 2.3的版本,那做点什么demo好呢,就来一个简单是数据模板吧,然后通过其他一些细节深入学习 先看看目录结构,按照官方demo架设 index.html只是简单入口文件和seajs的配置项,最下面有一个seajs.use加载crontroller模块,然后回调暴露的combine方法 <!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>

JS - CommonJS、ES2015、AMD、CMD模块规范对比与介绍(附样例)

一.CommonJS 1,CommonJS 基本介绍 (1)CommonJS 是一种思想,它是为 JS 的表现来制定规范.由于 JS 没有模块系统.标准库较少.缺乏包管理工具,因此 CommonJS 应运而生. (2)CommonJS 的目标是希望 JS 可以在任何地方运行,不只是浏览器中.只要我们的 JavaScript 是根据 CommonJS API 编写的,那么就可以在与 CommonJS 兼容的系统上运行. (3)根据 CommonJS API 编写的 JavaScript 可以做下面

该如何理解AMD ,CMD,CommonJS规范--javascript模块化加载学习总结

是一篇关于javascript模块化AMD,CMD,CommonJS的学习总结,作为记录也给同样对三种方式有疑问的童鞋们,有不对或者偏差之处,望各位大神指出,不胜感激. 本篇默认读者大概知道require,seajs的用法(AMD,CMD用法),所以没有加入使用语法. 1.为何而生: 这三个规范都是为javascript模块化加载而生的,都是在用到或者预计要用到某些模块时候加载该模块,使得大量的系统巨大的庞杂的代码得以很好的组织和管理.模块化使得我们在使用和管理代码的时候不那么混乱,而且也方便了