JavaScript 模块化:CommonJS、AMD、CMD、UMD 和 ES6 Module

随着 JavaScript 日新月异的发展,超过了它产生时候的自我定位,由于没有模块管理的概念,在做大型项目或文件组织的时候,就会异常纠结,而且后续也很难维护,长此以往,模块化是必然趋势~

模块化的主要特征是:

  • 可复用
  • 封装了变量和函数,和全局的 namaspace 不接触,松耦合
  • 只暴露可用的 public 方法,其它私有方法全部隐藏

目前比较流行的 JS 模块化规范有 CommonJS、AMD、CMD、UMD 以及 ES6 的模块化。

一、CommonJS

Node.js 是 CommonJS 规范的主要实践者,它有四个重要的环境变量为模块化的实现提供支持:moduleexportsrequireglobal。实际使用时,通过 module.exports 导出对外的变量或接口,通过 require 导入其它模块的输出到当前的模块的作用域中。

模块定义

//  定义模块 math.js
var basicNum = 0;
function add(a, b) {
    return a + b;
}

module.exports = { // 在这里写需要向外暴露的变量或函数
    basicNum: basicNum,
    add: add
};

模块引用

// 引入自定义的模块,参数需要包含路径,可省略后缀.js
var math = require('./math);
math.add(3, 5);
// 引入核心模块,参数直接写模块名,不需要包含路径
var http = require('http');
http.createServer(...).listen(8080);

module.exports v.s. exports

很多时候,我们会看到在一个模块中有两种方式来输出变量:
方式一:对 module.exports 赋值

// hello.js
function sayHello() {
    console.log('Hello');
}
function sayGoodbye() {
    console.log('Goodbye');
}

module.exports = {
    sayHello: sayHello,
    sayGoodbye: sayGoodbye
};

方式二:直接使用 exports

// hello.js
function sayHello() {
    console.log('Hello');
}
function sayGoodbye() {
    console.log('Goodbye');
}

exports.sayHello = sayHello;
exports.sayGoodbye = sayGoodbye;

但是,不可以直接对 exports 赋值。

// 代码可以执行,但是并没有输出任何变量
exports = {
    sayHello: sayHello,
    sayGoodbye: sayGoodbye
};

原因是什么呢?我们来分析一下 Node.js 的加载机制。
首先,Node.js 会把待加载的文件 hello.js 放入一个包装函数 load() 中执行。在执行 load() 函数前,Node.js 准备好了 module 变量:

var module = {
    id: 'hello',
    exports: {}
};

load() 函数最终返回 module.exports

var load = function(module) {
    // hello.js 文件的内容
    ...
    
    // load 函数返回
    return module.exports;
};

var exports = load(module);

也就是说,exports 实际上是 module.exports 的引用,或者理解为 exports 是一个指针,指向 module.exports ,所以在使用 exports 的时候,只能是 exports.sayHello = function() {...} 这样的方式,而不能使用 exports = { sayHello: function() {}},这种方式相当于重新定义了 exportsmodule.exports 仍然是空对象 {},所以给 exports 赋值是无效的。

优点:解决了依赖、全局变量污染的问题。
缺点:CommonJS 用同步的方式加载模块。在服务端,模块文件都存在本地磁盘,读取非常快,所以这样做不会有问题。但是在浏览器端,限于网络原因,更合理的方案是使用异步加载。

二、AMD

AMD( Asynchronous Module Definition ) 是 Require.js 在推广过程中对模块定义的规范化产出。

AMD 规范采用异步方式加载模块,所有依赖这个模块的语句都定义在一个回调函数中,等到加载完成后,这个回调函数才会执行。

实现 AMD 规范的模块化通过 define() 方法将代码定义为模块,通过 require() 方法实现模块的加载。

这里以 require.js 为例,首先将 require.js 引入到页面中:

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

定义模块

(1)独立模块
即 不需要依赖任何其他模块

// math.js
define(function() {
    var basicNum = 0;
    var add = function(a, b) {
        return a + b;
    };
    return {
        basicNum: basicNum,
        add: add
    };
});

(2)非独立模块
即 需要依赖其他模块

define(['underscore'], function(_) {
    var classify = function(list) {
        _.countBy(list, function(num) {
            return num > 30 ? 'old' : 'young';
        });
    };
    return {
        classify: classify
    };
});

引用模块

require(['jquery', 'math'], function($, math) {
    var sum = math.add(3, 5);
    $('#sum').html(sum);
});

require.js 还提供了一个 API: require.config() ,可以用来配置项目中用到的基础模块。

// 通过 config() 指定各模块路径和引用名
require.config({
    baseUrl: 'js/lib',
    paths: {
        'jquery': 'jquery.min', // 实际路径为 js/lib/jquery.min.js
        'underscore': 'underscore.min'
    }
});

// 引入模块
require(['jquery', 'underscore'], function($, _) {
    ...
});

优点:适合在浏览器环境中异步加载模块,可以并行加载多个模块。
缺点:不能按需加载,开发成本大。

三、CMD

CMD( Common Module Definition ) 是 Sea.js 在推广过程中对模块定义的规范化产出。

AMD 推崇依赖前置、提前执行,CMD 推崇依赖就近、延迟执行。

// AMD 写法
define(['a', 'b', 'c', 'd', 'e'], function(a, b, c, d, e) {
    // 等于在最前面声明并初始化了所有依赖的模块
    a.doSomething();
    if (false) {
        // 即使没有用到某个模块 b,但 b 还是提前执行了
        b.doSomething();
    }
});

// CMD 写法
define(function(require, exports, module) {
    var a = require('./a); // 在需要时声明
    a.doSomething();
    if (false) {
        var b = require('./b);
        b.doSomething();
    }
});

四、UMD

UMD ( Universal Module Definition ),希望提供一个前后端跨平台的解决方案(支持 AMD 与 CommonJS 模块方式)。

UMD 的实现原理:

  1. 先判断是否支持 Node.js 模块格式( exports 是否存在 ),存在则使用 Node.js 模块格式。
  2. 再判断是否支持 AMD(define 是否存在),存在则使用 AMD 方式加载模块。
  3. 前两个都不存在,则将模块公开到全局( window 或 global )。

下面是一个示例:
eventUtil.js

(function(root, factory) {
    if (typef exports === 'object') {
        module.exports = factory();
    } else if (typeof define === 'function' && define.amd) {
        define(factory);
    } else {
        root.eventUtil = factory();
    }
})(this, function() {
    // module
    return {
        addEvent: function(el, type, handle) {
            // ...
        },
        removeEvent: function(el, type, handle) {
            // ...
        }
    };
});

五、ES6 Module

在 ES6 中, 我们可以通过 import 引入模块,通过 export 导出模块,功能比前几个方案更强大,也是我们推荐使用的,但是由于浏览器对 ES6 的支持程度不同,目前都是使用 babel 或 traceur 把 ES6 代码转化为 ES5 代码,然后再在浏览器环境中执行。

// 定义模块 math.js
var basicNum = 0;
var add = function(a, b) {
    return a + b;
};

export { basicNum, add };
// 引用模块
import { basicNum, add } from './math';

function test(element) {
    element.textContent = add(basicNum, 99);
}
test();

导出模块时还可以用 export default ,为模块指定默认输出,对应的 import 语句不需要使用大括号。

// 输出模块
export default {
    basicNum,
    add
}

// 引入模块
import math from './math';

注:一个模块只能有一个 export default。

六、CommonJS 与 ES6 模块化的差异

1. CommonJS 支持动态导入,也就是 require(${path}/xx.js) ,ES6 目前还不支持,但是已有提案。

2. CommonJS 是同步导入,ES6是异步导入。

  • CommonJS 因为用于服务端,文件都在本地,同步导入即使卡住主线程影响也不大。
  • ES6 因为用于浏览器,需要下载文件,如果也采用同步导入会对渲染有很大影响。

3. CommonJS 模块输出的是一个值的拷贝,ES6 模块输出的是值的引用。

  • CommonJS 模块输出的是值的拷贝,也就是说,一旦输出一个值,模块内部的变化就影响不到这个值;另一方面,如果导出的值变了,导入的值也不会变,所以如果想更新值,必须重新导入一次。
  • ES6 采用实时绑定的方式,导入和导出的值都指向同一个内存地址,所以导入的值会跟随导出的值变化。

4. CommonJS 模块是运行时加载,ES6 模块是编译时加载。

  • CommonJS 模块就是一个对象,在导入时先加载整个模块,生成一个对象( 这个对象只有在脚本运行完才会生成 ),然后再从这个对象上读取方法,这种加载称为“运行时加载”。
  • ES6 模块不是对象,它的对外接口只是一种静态定义,在代码运行之前( 即编译时 )的静态解析阶段就完成了模块加载,比 CommonJS 模块的加载方式更高效。
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,242评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,769评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,484评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,133评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,007评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,080评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,496评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,190评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,464评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,549评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,330评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,205评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,567评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,889评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,160评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,475评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,650评论 2 335

推荐阅读更多精彩内容