js模块化编程之完全弄懂CommonJS和AMD/CMD!

先回答我:为何模块很重要?javascript

 

答:由于有了模块,咱们就能够更方便地使用别人的代码,想要什么功能,就加载什么模块。
可是,这样作有一个前提,那就是你们必须以一样的方式编写模块,不然你有你的写法,我有个人写法,岂不是乱了套!html

因而下面三个模块规范出来了,这篇文章也出来了(拼出来的 {捂脸笑})。前端

 

JS中的模块规范(CommonJS,AMD,CMD),若是你听过js模块化这个东西,那么你就应该听过或CommonJS或AMD甚至是CMD这些规范咯,我也听过,但以前也真的是听听而已。 如今就看看吧,这些规范究竟是啥东西,干吗的。本文包括这三个规范的来源及对应的产物的原理。java

 

1、CommonJSnode

1.一开始你们都认为JS是辣鸡,没什么用,官方定义的API只能构建基于浏览器的应用程序,逗我呢,这太狭隘了吧(用了个高端词,嘎嘎),CommonJS就按耐不住了,CommonJS API定义不少普通应用程序(主要指非浏览器的应用)使用的API,从而填补了这个空白。它的终极目标是提供一个相似Python,Ruby和Java标准库。这样的话,开发者可使用CommonJS API编写应用程序,而后这些应用能够运行在不一样的JavaScript解释器和不一样的主机环境中。jquery

在兼容CommonJS的系统中,你可使用JavaScript开发如下程序:webpack

 

(1).服务器端JavaScript应用程序
(2).命令行工具
(3).图形界面应用程序
(4).混合应用程序(如,Titanium或Adobe AIR)git

2009年,美国程序员Ryan Dahl创造了node.js项目,将javascript语言用于服务器端编程。这标志"Javascript模块化编程"正式诞生。由于老实说,在浏览器环境下,没有模块也不是特别大的问题,毕竟网页程序的复杂性有限;可是在服务器端,必定要有模块,与操做系统和其余应用程序互动,不然根本无法编程。NodeJS是CommonJS规范的实现,webpack 也是以CommonJS的形式来书写。程序员

node.js的模块系统,就是参照CommonJS规范实现的。在CommonJS中,有一个全局性方法require(),用于加载模块。假定有一个数学模块math.js,就能够像下面这样加载。github

var math = require('math');

而后,就能够调用模块提供的方法:

  var math = require('math');

      math.add(2,3); // 5

CommonJS定义的模块分为:{模块引用(require)} {模块定义(exports)} {模块标识(module)}

require()用来引入外部模块;exports对象用于导出当前模块的方法或变量,惟一的导出口;module对象就表明模块自己。

虽然说Node遵循CommonJS的规范,可是相比也是作了一些取舍,填了一些新东西的。

不过,说了CommonJS也说了Node,那么我以为也得先了解下NPM了。NPM做为Node的包管理器,不是为了帮助Node解决依赖包的安装问题嘛,那它确定也要遵循CommonJS规范啦,它遵循包规范(仍是理论)的。CommonJS WIKI讲了它的历史,还介绍了modules和packages等。

下面讲讲commonJS的原理以及简易实现:

一、原理

浏览器不兼容CommonJS的根本缘由,在于缺乏四个Node.js环境的变量。

 

  • module
  • exports
  • require
  • global

 

只要可以提供这四个变量,浏览器就能加载 CommonJS 模块。

 

下面是一个简单的示例。

 

var module = { exports: {} }; (function(module, exports) { exports.multiply = function (n) { return n * 1000 }; }(module, module.exports)) var f = module.exports.multiply; f(5) // 5000 

 

上面代码向一个当即执行函数提供 module 和 exports 两个外部变量,模块就放在这个当即执行函数里面。模块的输出值放在 module.exports 之中,这样就实现了模块的加载。

 

二、Browserify 的实现

知道了原理,就能作出工具了。Browserify 是目前最经常使用的 CommonJS 格式转换的工具。

请看一个例子,main.js 模块加载 foo.js 模块。

 

 // foo.js module.exports = function(x) { console.log(x); };  // main.js var foo = require("./foo"); foo("Hi"); 

 

使用下面的命令,就能将main.js转为浏览器可用的格式。

 

$ browserify main.js > compiled.js 

 

Browserify到底作了什么?安装一下browser-unpack,就能看清楚了。

 

$ npm install browser-unpack -g 

 

而后,将前面生成的compile.js解包。

 

$ browser-unpack < compiled.js [ { "id":1, "source":"module.exports = function(x) {\n console.log(x);\n};", "deps":{} }, { "id":2, "source":"var foo = require(\"./foo\");\nfoo(\"Hi\");", "deps":{"./foo":1}, "entry":true } ] 

 

能够看到,browerify 将全部模块放入一个数组,id 属性是模块的编号,source 属性是模块的源码,deps 属性是模块的依赖。

 

由于 main.js 里面加载了 foo.js,因此 deps 属性就指定 ./foo 对应1号模块。执行的时候,浏览器遇到 require('./foo') 语句,就自动执行1号模块的 source 属性,并将执行后的 module.exports 属性值输出。

 

三、Tiny Browser Require

虽然 Browserify 很强大,但不能在浏览器里操做,有时就很不方便。

 

我根据 mocha 的内部实现,作了一个纯浏览器的 CommonJS 模块加载器 tiny-browser-require 。彻底不须要命令行,直接放进浏览器便可,全部代码只有30多行。

 

 

它的逻辑很是简单,就是把模块读入数组,加载路径就是模块的id。

 

function require(p){ var path = require.resolve(p); var mod = require.modules[path]; if (!mod) throw new Error('failed to require "' + p + '"'); if (!mod.exports) { mod.exports = {}; mod.call(mod.exports, mod, mod.exports, require.relative(path)); } return mod.exports; } require.modules = {}; require.resolve = function (path){ var orig = path; var reg = path + '.js'; var index = path + '/index.js'; return require.modules[reg] && reg || require.modules[index] && index || orig; }; require.register = function (path, fn){ require.modules[path] = fn; }; require.relative = function (parent) { return function(p){ if ('.' != p.charAt(0)) return require(p); var path = parent.split('/'); var segs = p.split('/'); path.pop(); for (var i = 0; i < segs.length; i++) { var seg = segs[i]; if ('..' == seg) path.pop(); else if ('.' != seg) path.push(seg); } return require(path.join('/')); }; }; 

 

使用的时候,先将上面的代码放入页面。而后,将模块放在以下的当即执行函数里面,就能够调用了。

 

<script src="require.js" /> <script> require.register("moduleId", function(module, exports, require){ // Module code goes here }); var result = require("moduleId"); </script>

 

仍是之前面的 main.js 加载 foo.js 为例。

 

require.register("./foo.js", function(module, exports, require){ module.exports = function(x) { console.log(x); }; }); var foo = require("./foo.js"); foo("Hi"); 

 

注意,这个库只模拟了 require 、module 、exports 三个变量,若是模块还用到了 global 或者其余 Node 专有变量(好比 process),就经过当即执行函数提供便可。

2、AMD

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

 

  var math = require('math');

  math.add(2, 3);

 

第二行math.add(2, 3),在第一行require('math')以后运行,所以必须等math.js加载完成。也就是说,若是加载时间很长,整个应用就会停在那里等。您会注意到 require 是同步的。

这对服务器端不是一个问题,由于全部的模块都存放在本地硬盘,能够同步加载完成,等待时间就是硬盘的读取时间。可是,对于浏览器,这倒是一个大问题,由于模块都放在服务器端,等待时间取决于网速的快慢,可能要等很长时间,浏览器处于"假死"状态。

 

所以,浏览器端的模块,不能采用"同步加载"(synchronous),只能采用"异步加载"(asynchronous)。这就是AMD规范诞生的背景。

 

CommonJS是主要为了JS在后端的表现制定的,他是不适合前端的,AMD(异步模块定义)出现了,它就主要为前端JS的表现制定规范。

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.jscurl.js

RequireJS就是实现了AMD规范的呢。

详细归纳:下面以RequireJS为例说明AMD规范

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)管理模块之间的依赖性,便于代码的编写和维护。

 

2、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。

 

3、主模块的写法

 

上一节的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,而后再运行回调函数。主模块的代码就写在回调函数中。

 

4、模块的加载

 

上一节最后的示例中,主模块的依赖模块是['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请求数。

 

5、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文件。

 

6、加载非规范的模块

 

理论上,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'

    }

  }

 

7、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文件。(完)

 

另外一我的的归纳(有点简单):

AMD就只有一个接口:define(id?,dependencies?,factory);

 

它要在声明模块的时候制定全部的依赖(dep),而且还要当作形参传到factory中,像这样:

 

1 define(['dep1','dep2'],function(dep1,dep2){...});

 

要是没什么依赖,就定义简单的模块,下面这样就能够啦:

 

1 define(function(){
2     var exports = {};
3     exports.method = function(){...};
4     return exports;
5 });

 

咦,这里有define,把东西包装起来啦,那Node实现中怎么没看到有define关键字呢,它也要把东西包装起来呀,其实吧,只是Node隐式包装了而已.....

这有AMD的WIKI中文版,讲了不少蛮详细的东西,用到的时候能够查看:AMD的WIKI中文版

3、CMD

大名远扬的玉伯写了seajs,就是遵循他提出的CMD规范,与AMD蛮相近的,不过用起来感受更加方便些,最重要的是中文版,应有尽有:seajs官方doc

1 define(function(require,exports,module){...});

用过seajs吧,这个不陌生吧,对吧。

前面说AMD,说RequireJS实现了AMD,CMD看起来与AMD好像呀,那RequireJS与SeaJS像不像呢?

虽然CMD与AMD蛮像的,但区别仍是挺明显的,官方非官方都有阐述和理解,我以为吧,说的都挺好:

官方阐述SeaJS与RequireJS异同

SeaJS与RequireJS的最大异同(这个说的也挺好)