关于CommonJS、AMD、CMD、UMD规范，JavaScript模块化编程和浏览器端的规范和实现

时间 2019-11-18

标签关于 commonjs amd cmd umd 规范 javascript 模块化编程浏览器端的实现栏目 JavaScript 繁體版

原文原文链接

1、Javascript模块化编程

1.一、Javascript模块化介绍

随着网站逐渐变成"互联网应用程序"，嵌入网页的Javascript代码愈来愈庞大，愈来愈复杂。网页愈来愈像桌面程序，须要一个团队分工协做、进度管理、单元测试等等......开发者不得不使用软件工程的方法，管理网页的业务逻辑。Javascript模块化编程，已经成为一个迫切的需求。理想状况下，开发者只须要实现核心的业务逻辑，其余均可以加载别人已经写好的模块。可是，Javascript不是一种模块化编程语言，它不支持"类"（class），更遑论"模块"（module）了。（正在制定中的ECMAScript标准第六版，将正式支持"类"和"模块"，但还须要很长时间才能投入使用。)Javascript社区作了不少努力，在现有的运行环境中，实现"模块"的效果。本文总结了当前＂Javascript模块化编程＂的最佳实践，说明如何投入实用。虽然这不是初级教程，可是只要稍稍了解Javascript的基本语法，就能看懂。javascript

1.二、Javascript模块化进阶

1.2.一、原始写法

模块就是实现特定功能的一组方法。只要把不一样的函数（以及记录状态的变量）简单地放在一块儿，就算是一个模块。html

function m1(){
　　　　//...
}
function m2(){
　　　　//...
}

上面的函数m1()和m2()，组成一个模块。使用的时候，直接调用就好了。java

这种作法的缺点很明显："污染"了全局变量，没法保证不与其余模块发生变量名冲突，并且模块成员之间看不出直接关系。node

1.2.二、对象写法

为了解决上面的缺点，能够把模块写成一个对象，全部的模块成员都放到这个对象里面。jquery

var module1 = new Object({
　　　　_count : 0,
　　　　m1 : function (){
　　　　　　//...
　　　　},
　　　　m2 : function (){
　　　　　　//...
　　　　}
});
module1.m1();
module1._count = 5;

上面的函数m1()和m2(），都封装在module1对象里。使用的时候，就是调用这个对象的属性。可是，这样的写法会暴露全部模块成员，内部状态能够被外部改写。好比，外部代码能够直接改变内部计数器的值。git

1.2.三、当即执行函数写法

使用"当即执行函数"（Immediately-Invoked Function Expression，IIFE），能够达到不暴露私有成员的目的。程序员

var module1 = (function (mod){
　　　　mod.m3 = function () {
　　　　　　//...
　　　　};
　　　　return mod;
})(module1);

使用上面的写法，外部代码没法读取内部的_count变量。github

1.2.四、放大模式

若是一个模块很大，必须分红几个部分，或者一个模块须要继承另外一个模块，这时就有必要采用"放大模式"（augmentation）。ajax

var module1 = (function(){
　　　　var _count = 0;
　　　　var m1 = function(){
　　　　　　//...
　　　　};
　　　　var m2 = function(){
　　　　　　//...
　　　　};
　　　　return {
　　　　　　m1 : m1,
　　　　　　m2 : m2
　　　　};
})();
console.info(module1._count); //undefined

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

1.2.五、宽放大模式

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

var module1 = ( function (mod){
　　　　//...
　　　　return mod;
})(window.module1 || {});

与"放大模式"相比，＂宽放大模式＂就是"当即执行函数"的参数能够是空对象。

1.2.六、输入全局变量

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

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

上面的module1模块须要使用jQuery库和YUI库，就把这两个库（实际上是两个模块）看成参数输入module1。这样作除了保证模块的独立性，还使得模块之间的依赖关系变得明显。这方面更多的讨论，参见Ben Cherry的著名文章《JavaScript Module Pattern: In-Depth》http://www.adequatelygood.com/JavaScript-Module-Pattern-In-Depth.html

2、模块的规范

一、规范介绍

先想想，为何模块很重要？由于有了模块，咱们就能够更方便地使用别人的代码，想要什么功能，就加载什么模块。可是，这样作有一个前提，那就是你们必须以一样的方式编写模块，不然你有你的写法，我有个人写法，岂不是乱了套！考虑到Javascript模块如今尚未官方规范，这一点就更重要了。目前，通行的Javascript模块规范共有三种：CommonJS、AMD、CMD。

二、CommonsJS

2009年，美国程序员Ryan Dahl创造了node.js项目，将javascript语言用于服务器端编程。这标志"Javascript模块化编程"正式诞生。由于老实说，在浏览器环境下，没有模块也不是特别大的问题，毕竟网页程序的复杂性有限；可是在服务器端，必定要有模块，与操做系统和其余应用程序互动，不然根本无法编程。node.js的模块系统，就是参照CommonJS规范实现的。在CommonJS中，有一个全局性方法require()，用于加载模块。假定有一个数学模块math.js，就能够像下面这样加载。

var math = require('math');

//而后，就能够调用模块提供的方法：
var math = require('math');
math.add(2,3); // 5

三、AMD规范

AMD标准：https://github.com/amdjs/amdjs-api/blob/master/AMD.md

有了服务器端模块之后，很天然地，你们就想要客户端模块。并且最好二者可以兼容，一个模块不用修改，在服务器和浏览器均可以运行。可是，因为一个重大的局限，使得CommonJS规范不适用于浏览器环境。仍是上一节的代码，若是在浏览器中运行，会有一个很大的问题，你能看出来吗？

var math = require('math');

//而后，就能够调用模块提供的方法：
var math = require('math');
math.add(2,3); // 5

第二行math.add(2, 3)，在第一行require('math')以后运行，所以必须等math.js加载完成。也就是说，若是加载时间很长，整个应用就会停在那里等。这对服务器端不是一个问题，由于全部的模块都存放在本地硬盘，能够同步加载完成，等待时间就是硬盘的读取时间。可是，对于浏览器，这倒是一个大问题，由于模块都放在服务器端，等待时间取决于网速的快慢，可能要等很长时间，浏览器处于"假死"状态。所以，浏览器端的模块，不能采用"同步加载"（synchronous），只能采用"异步加载"（asynchronous）。这就是AMD规范诞生的背景。

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

AMD也采用require()语句加载模块，可是不一样于CommonJS，它要求两个参数：

require([module], callback);

第一个参数[module]，是一个数组，里面的成员就是要加载的模块；第二个参数callback，则是加载成功以后的回调函数。若是将前面的代码改写成AMD形式，就是下面这样：

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

math.add()与math模块加载不是同步的，浏览器不会发生假死。因此很显然，AMD比较适合浏览器环境。目前，主要有两个Javascript库实现了AMD规范：require.js和curl.js。下面将经过介绍require.js，进一步讲解AMD的用法，以及如何将模块化编程投入实战。

四、CMD规范

CMD标准：https://github.com/cmdjs/specification/blob/master/draft/module.md

http://github.com/seajs/seajs/issues/242

在 CMD 规范中，一个模块就是一个文件。代码的书写格式以下：

define(factory);

define `define(factory)`

define 接受 factory 参数，factory 能够是一个函数，也能够是一个对象或字符串。

define `define(id?, deps?, factory)`

define 也能够接受两个以上参数。字符串 id 表示模块标识，数组 deps 是模块依赖。好比：

define('hello', ['jquery'], function(require, exports, module) {

  // 模块代码

});

五、UMD规范

umd是AMD和CommonJS的糅合

AMD 浏览器第一的原则发展异步加载模块。

CommonJS 模块以服务器第一原则发展，选择同步加载，它的模块无需包装(unwrapped modules)。

这迫令人们又想出另外一个更通用的模式UMD （Universal Module Definition）。但愿解决跨平台的解决方案。

UMD先判断是否支持Node.js的模块（exports）是否存在，存在则使用Node.js模块模式。

在判断是否支持AMD（define是否存在），存在则使用AMD方式加载模块。

(function (window, factory) {
	 if (typeof exports === 'object') {
		  module.exports = factory();
	 } else if (typeof define === 'function' && define.amd) {
		  define(factory);
	 } else {
		  window.eventUtil = factory();
	 }
})(this, function () {
	 //module ...
});

3、模块的规范实现

一、require.js

1.一、为何要用require.js？

最先的时候，全部Javascript代码都写在一个文件里面，只要加载这一个文件就够了。后来，代码愈来愈多，一个文件不够了，必须分红多个文件，依次加载。下面的网页代码，相信不少人都见过。

<script src="1.js"></script>
<script src="2.js"></script>
<script src="3.js"></script>
<script src="4.js"></script>
<script src="5.js"></script>
<script src="6.js"></script>

这段代码依次加载多个js文件。

这样的写法有很大的缺点。首先，加载的时候，浏览器会中止网页渲染，加载文件越多，网页失去响应的时间就会越长；其次，因为js文件之间存在依赖关系，所以必须严格保证加载顺序（好比上例的1.js要在2.js的前面），依赖性最大的模块必定要放到最后加载，当依赖关系很复杂的时候，代码的编写和维护都会变得困难。

require.js的诞生，就是为了解决这两个问题：

（1）实现js文件的异步加载，避免网页失去响应；

（2）管理模块之间的依赖性，便于代码的编写和维护。

1.二、require.js的加载

使用require.js的第一步，是先去官方网站下载最新版本。下载后，假定把它放在js子目录下面，就能够加载了。

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

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

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

async属性代表这个文件须要异步加载，避免网页失去响应。IE不支持这个属性，只支持defer，因此把defer也写上。

加载require.js之后，下一步就要加载咱们本身的代码了。假定咱们本身的代码文件是main.js，也放在js目录下面。那么，只须要写成下面这样就好了

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

data-main属性的做用是，指定网页程序的主模块。在上例中，就是js目录下面的main.js，这个文件会第一个被require.js加载。因为require.js默认的文件后缀名是js，因此能够把main.js简写成main。

1.三、主模块的写法

上一节的main.js，我把它称为"主模块"，意思是整个网页的入口代码。它有点像C语言的main()函数，全部代码都从这儿开始运行。

下面就来看，怎么写main.js。

若是咱们的代码不依赖任何其余模块，那么能够直接写入javascript代码。

// main.js
alert("加载成功！");

但这样的话，就不必使用require.js了。真正常见的状况是，主模块依赖于其余模块，这时就要使用AMD规范定义的的require()函数。

// main.js
require(['moduleA', 'moduleB', 'moduleC'], function (moduleA, moduleB, moduleC){
　　　　// some code here
});

require()函数接受两个参数。第一个参数是一个数组，表示所依赖的模块，上例就是['moduleA', 'moduleB', 'moduleC']，即主模块依赖这三个模块；第二个参数是一个回调函数，当前面指定的模块都加载成功后，它将被调用。加载的模块会以参数形式传入该函数，从而在回调函数内部就可使用这些模块。

require()异步加载moduleA，moduleB和moduleC，浏览器不会失去响应；它指定的回调函数，只有前面的模块都加载成功后，才会运行，解决了依赖性的问题。

下面，咱们看一个实际的例子。

假定主模块依赖jquery、underscore和backbone这三个模块，main.js就能够这样写：

require(['jquery', 'underscore', 'backbone'], function ($, _, Backbone){
　　　　// some code here
});

require.js会先加载jQuery、underscore和backbone，而后再运行回调函数。主模块的代码就写在回调函数中。

1.四、模块的加载

上一节最后的示例中，主模块的依赖模块是['jquery', 'underscore', 'backbone']。默认状况下，require.js假定这三个模块与main.js在同一个目录，文件名分别为jquery.js，underscore.js和backbone.js，而后自动加载。

使用require.config()方法，咱们能够对模块的加载行为进行自定义。require.config()就写在主模块（main.js）的头部。参数就是一个对象，这个对象的paths属性指定各个模块的加载路径。

require.config({
　　　　paths: {
　　　　　　"jquery": "jquery.min",
　　　　　　"underscore": "underscore.min",
　　　　　　"backbone": "backbone.min"
　　　　}
});

上面的代码给出了三个模块的文件名，路径默认与main.js在同一个目录（js子目录）。若是这些模块在其余目录，好比js/lib目录，则有两种写法。一种是逐一指定路径。

require.config({
　　　　paths: {
　　　　　　"jquery": "lib/jquery.min",
　　　　　　"underscore": "lib/underscore.min",
　　　　　　"backbone": "lib/backbone.min"
　　　　}
});

另外一种则是直接改变基目录（baseUrl）：

require.config({
　　　　baseUrl: "js/lib",
　　　　paths: {
　　　　　　"jquery": "jquery.min",
　　　　　　"underscore": "underscore.min",
　　　　　　"backbone": "backbone.min"
　　　　}
});

若是某个模块在另外一台主机上，也能够直接指定它的网址，好比：

require.config({
　　　　paths: {
　　　　　　"jquery": "https://ajax.googleapis.com/ajax/libs/jquery/1.7.2/jquery.min"
　　　　}
});

require.js要求，每一个模块是一个单独的js文件。这样的话，若是加载多个模块，就会发出屡次HTTP请求，会影响网页的加载速度。所以，require.js提供了一个优化工具，当模块部署完毕之后，能够用这个工具将多个模块合并在一个文件中，减小HTTP请求数。

1.五、AMD模块的写法

require.js加载的模块，采用AMD规范。也就是说，模块必须按照AMD的规定来写。

具体来讲，就是模块必须采用特定的define()函数来定义。若是一个模块不依赖其余模块，那么能够直接定义在define()函数之中。

假定如今有一个math.js文件，它定义了一个math模块。那么，math.js就要这样写：

// math.js
define(function (){
　　　　var add = function (x,y){
　　　　　　return x+y;
　　　　};
　　　　return {
　　　　　　add: add
　　　　};
});

加载方法以下：

// main.js
require(['math'], function (math){
　　　　alert(math.add(1,1));
});

若是这个模块还依赖其余模块，那么define()函数的第一个参数，必须是一个数组，指明该模块的依赖性。

define(['myLib'], function(myLib){
　　　　function foo(){
　　　　　　myLib.doSomething();
　　　　}
　　　　return {
　　　　　　foo : foo
　　　　};
});

当require()函数加载上面这个模块的时候，就会先加载myLib.js文件。

1.六、加载非规范的模块

理论上，require.js加载的模块，必须是按照AMD规范、用define()函数定义的模块。可是实际上，虽然已经有一部分流行的函数库（好比jQuery）符合AMD规范，更多的库并不符合。那么，require.js是否可以加载非规范的模块呢？

回答是能够的。

这样的模块在用require()加载以前，要先用require.config()方法，定义它们的一些特征。

举例来讲，underscore和backbone这两个库，都没有采用AMD规范编写。若是要加载它们的话，必须先定义它们的特征。

require.config({
　　　　shim: {

　　　　　　'underscore':{
　　　　　　　　exports: '_'
　　　　　　},
　　　　　　'backbone': {
　　　　　　　　deps: ['underscore', 'jquery'],
　　　　　　　　exports: 'Backbone'
　　　　　　}
　　　　}
});

require.config()接受一个配置对象，这个对象除了有前面说过的paths属性以外，还有一个shim属性，专门用来配置不兼容的模块。具体来讲，每一个模块要定义（1）exports值（输出的变量名），代表这个模块外部调用时的名称；（2）deps数组，代表该模块的依赖性。

好比，jQuery的插件能够这样定义：

shim: {
　　　　'jquery.scroll': {
　　　　　　deps: ['jquery'],
　　　　　　exports: 'jQuery.fn.scroll'
　　　　}
}

1.七、require.js插件

require.js还提供一系列插件，实现一些特定的功能。

domready插件，可让回调函数在页面DOM结构加载完成后再运行。

require(['domready!'], function (doc){
　　　　// called once the DOM is ready
});

text和image插件，则是容许require.js加载文本和图片文件。

define([
　　　　'text!review.txt',
　　　　'image!cat.jpg'
　　　　],

　　　　function(review,cat){
　　　　　　console.log(review);
　　　　　　document.body.appendChild(cat);
　　　　}
);

相似的插件还有json和mdown，用于加载json文件和markdown文件。