js模块规范学习

3中规范:CommonJS、AMD、CMD

1.CommonJS
COmmonJS的模块定义分为三部分:
{模块引用(require)}{模块定义(exports)}{模块标识(module)}
require()用来引用外部模块
exports()用来导出当前模块的方法或变量,唯一的导出口
module对象就代表模块本身
CommonJS主要用于Node,Node一个文件是一个模块,有自己的作用域,每个文件内定义的变量、方法、类都是私有变量。
CommonJS规范规定,module变量代表当前模块,该变量是一个对象,他的exports属性(module.exports)是该模块对外的接口。
加载某个模块的时候,加载的是该模块的module.exports属性。

//example.js
let x = 1;
const addX = (value) => value + x;

module.exports.x = x;
module.exports.addX = addX;
//main.js
const example = require('./example.js');

console.log(example.x);
console.log(example.addX(10));

CommonJS特点
1.模块代码都运行在模块作用域,不会污染全局变量;
2.模块可以多次加载,但是只在第一次加载的时候运行,产生缓存,以后再次加载都是读取第一次的运行缓存。如果想重新加载模块,需要清除缓存;
所有的缓存存在于 require.cache中,如果想清除缓存,以如下操作
//删除制定文件缓存
delete require.cache[moduleName];
//删除所有缓存
Object.keys(require.cache).forEach(function(key) {
delete require.cache[key];
})
3.模块加载顺序是按照其在代码中的出现的顺序。
4.CommonJS加载模块是同步加载。

详细说明:
1.require:
读入并执行一个js文件,并返回该模块的exports对象,如果没有该对象,会报错;如果要输出一个函数,则该函数要定义在moduel.exports上,而非exports上。
理由见exports详细说明,如下。
require常用函数说明
2.exports:
为了方便,每个模块都提供一个exports变量,相当于var exports = module.exports;
可以直接向exports中添加属性,输出;但是不能将exports赋值,如 exports = x => { console.log(x); }
这样切断了exports和module.exports之间的联系。使得exports无效。
3.module:Node内部提供一个Module的构造函数,每个模块都是Module的实例。
每个模块内部都有一个module对象,代表当前模块,拥有以下属性:

module.id 模块的识别符,通常是带有绝对路径的模块文件名。
module.filename 模块的文件名,带有绝对路径。
module.loaded 返回一个布尔值,表示模块是否已经完成加载。
module.parent 返回一个对象,表示调用该模块的模块。
module.children 返回一个数组,表示该模块要用到的其他模块。
module.exports 表示模块对外输出的值。

2.AMD(asynchronous)异步模块定义 主要服务于前端js
一般来讲,浏览器端需要从服务器加载模块,所以异步加载效率更好。AMD允许有回调函数。
define()函数说明:

define(id?, dependencies?, factory);

参数解释:
1.id:定义中模块的名字,可以是绝对路径也可以是相对路径;
2.dependencies:定义中模块依赖模块的数组。默认是['require', 'exports', 'module'];
3.factory:工厂方法,为模块初始化要执行的函数或对象。如果是函数,这个函数只执行一次;如果是对象,这个对象应该设置为模块的输出值。

define(['package/lib'], function(lib){
  function foo(){
    lib.log('hello world!');
  }

  return {
    foo: foo
  };
});

define(function('require', 'exports', 'module'){
    var a = require('./a');
    var b = require('./b');

    exports.value = function () {
        a.doSomething();
        b.doSomething();
    }
})

3.CMD 通用模块定义
AMD和CMD的区别:RequireJS 遵循 AMD(异步模块定义)规范,Sea.js 遵循 CMD (通用模块定义)规范。
RequireJS 想成为浏览器端的模块加载器,同时也想成为 Rhino / Node 等环境的模块加载器。Sea.js 则专注于 Web 浏览器端,同时通过 Node 扩展的方式可以很方便跑在 Node 环境中。
define()函数说明:

define(id?, dependencies?, factory);

函数说明与AMD相同。
factory可以是一个对象、字符串或者是一个函数:
1)当factory为一个对象或字符串的时候,说明接口就是这个对象或字符串
2)当factory为一个函数的时候,默认有3个参数require、exports 和 module。

备注:
1.加载路径顺序
requrie加载的文件后缀名默认是.js
var a = require('./a');
//等价于
var a = require('./a.js');
1)路径名以'/'开始,是绝对路径
2)路径名以'./' 或'../'等开始,是相对路径
如果模块 "a/b/c" 请求 "../d", 则解析为"a/d"
如果模块 "a/b/c" 请求 "./e", 则解析为"a/b/e"
3)路径名不以'/'、'./'、'../'开头,表示加载的是一个默认提供的核心模块(位于node的安装目录中)或者位于node_modules目录中已经安装的模块。
eg:
脚本/home/user/projects/foo.js执行了require('bar.js')命令,Node会依次搜索以下文件:

    /usr/local/lib/node/bar.js
    /home/user/projects/node_modules/bar.js
    /home/user/node_modules/bar.js
    /home/node_modules/bar.js
    /node_modules/bar.js
  1. 路径名不以“./“或”/“开头,而且是一个路径,比如require('example-module/path/to/file'),则将先找到example-module的位置,然后再以它为参数,找到后续路径。
    5)如果指定的模块文件没有发现,Node会尝试为文件名添加.js、.json、.node后,再去搜索。.js件会以文本格式的JavaScript脚本文件解析,.json文件会以JSON格式的文本文件解析,.node文件会以编译后的二进制文件解析。
    6)如果想得到require命令加载的确切文件名,使用require.resolve()方法。

参考:
1.CommonJS规范
2.浅析JS终端模块规范
3.AMD (中文版)
4.CMD 模块定义规范

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,843评论 6 502
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,538评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 163,187评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,264评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,289评论 6 390
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,231评论 1 299
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,116评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,945评论 0 275
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,367评论 1 313
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,581评论 2 333
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,754评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,458评论 5 344
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,068评论 3 327
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,692评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,842评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,797评论 2 369
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,654评论 2 354

推荐阅读更多精彩内容