CommonJS,AMD,CMD,ES6 —— JS中的模块规范

模块化的重要性

先谈谈模块的重要性,因为有了模块,我们就可以方便地使用别人的代码,想要什么功能,就加载什么模块。
但是,这样做有一个前提,那就是大家必须以同样的方式编写模块,否则你有你的写法,我有我的写法,岂不是乱了套!

之前就听过或CommonJS、AMD、CMD、ES6模块化这些规范,听的头皮发麻,东拼西凑好多文章,整理了一篇这几个规范的介绍。

JS中的模块规范(CommonJS,AMD,CMD,ES6)

CommonJS

一、为什么制定CommonJS规范?

JS官方定义的API只能构建基于浏览器的应用程序,CommonJS API定义很多普通应用程序(主要指非浏览器的应用)使用的API。CommonJS规范的提出,主要是为了弥补JavaScript没有标准的缺陷,从而达到像Python、Ruby和Java那样具备开发大型应用的基础能力,而不是停留在开发浏览器端小脚本程序的阶段。

NodeJS是CommonJS规范的实现,webpack 也是以CommonJS的形式来书写。

在兼容CommonJS的系统中,你可以使用JavaScript开发以下程序:
 
(1).服务器端JavaScript应用程序
(2).命令行工具
(3).图形界面应用程序
(4).混合应用程序
  
二、CommonJS模块规范

  CommonJS模块规范主要分为三部分:模块引用(require)、模块定义(export)、模块标识(module)。

1、模块引用 
 
如果在a.js文件中使用如下语句
var math=require'math');

意为使用require()方法,引入math模块,并赋值给变量math。
命名的变量名和引入的模块名不必相同,像这样:
var Math=require('math');

赋值的意义在于,a.js中将仅能识别已经定义的变量Math,并不能识别math。

引入带路径
  上面例子中require的参数仅仅是模块名字的字符串,没有路径,默认引用的是a.js所在当前目录下的node_modules目录下的math模块。 
   
  如果要引入的模块在其他路径,就需要使用到相对路径或者绝对路径,例如:
var add=require('./add.js')

  上面例子中引入了当前目录下的add.js文件,并赋值给add变量。

2、模块定义

module对象:在每一个模块中,module对象代表该模块自身。export属性:module对象的一个属性,它向外提供接口。


  仍然采用上一个示例,假设add.js中的代码如下: 
  
function add(num1,num2){ alert(num1+num2);}


  尽管a.js文件引入了add.js文件,前者却仍然无法使用后者中的add函数,在a.js文件中add(3,5)这样的代码会报错,提示add不是一个函数。 

  add.js中的函数要能被其他模块使用,就需要暴露一个对外的接口,export属性用于完成这一工作。将add.js中代码改为如下:

exports.add=function (num1,num2){ alert(num1+num2);}

  a.js文件就可以正常调用add.js中的方法,例如add.add(3,5)这样的调用能够正常执行,前一个add意为本文件中add变量代表的模块,后一个add是引入模块的add方法。

3、模块标识

模块标识指的是传递给require方法的参数,必须是符合小驼峰命名的字符串,或者以 . 、.. 、开头的相对路径,或者绝对路径。


下面再讲讲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 之中,这样就实现了模块的加载。

三、CommonJS模块规范的好处

CommonJS模块规范很好地解决变量污染问题,每个模块具有独立空间,互不干扰。
CommonJS规范定义模块十分简单,接口十分简洁。
CommonJS模块规范支持引入和导出功能,可以顺畅连接各个模块,实现彼此依赖关系。

AMD

一、AMD诞生背景

基于commonJS规范的nodeJS出来以后,服务端的模块概念已经形成,很自然地,大家就想要客户端模块。而且最好两者能够兼容,一个模块不用修改,在服务器和浏览器都可以运行。但是,由于一个重大的局限,使得CommonJS规范不适用于浏览器环境!

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

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

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

二、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规范

一、为什么要用require.js?

当js代码越来越多,必须分成多个文件,依次加载。如下面的代码。
 
  <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)管理模块之间的依赖性,便于代码的编写和维护。

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

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


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


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


六、加载非规范的模块
 
理论上,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'
    }
  }


七、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中,像这样:
 
define(['dep1','dep2'],function(dep1,dep2){...});
 
要是没什么依赖,就定义简单的模块,下面这样就可以啦:
 
define(function(){
    var exports = {};
    exports.method = function(){...};
    return exports;
});
 
咦,这里有define,把东西包装起来啦,那Node实现中怎么没看到有define关键字呢,它也要把东西包装起来呀,其实吧,只是Node隐式包装了而已.....
这有AMD的WIKI中文版,讲了很多蛮详细的东西,用到的时候可以查看:AMD的WIKI中文版

CMD

seajs,遵循CMD规范,与AMD蛮相近的,用起来感觉更加方便些,最重要的是中文版,应有尽有:seajs官方doc

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

前面说AMD,说RequireJS实现了AMD,CMD看起来与AMD好像呀。
虽然CMD与AMD蛮像的,但区别还是挺明显的,官方非官方都有阐述和理解:

 

ES6

ES6 在语言标准的层面上,实现了模块功能,而且实现得相当简单,旨在成为浏览器和服务器通用的模块解决方案。其模块功能主要由两个命令构成:export 和 import。export命令用于规定模块的对外接口,import命令用于输入其他模块提供的功能。

有人认为 Module 可以帮助我们更好地写代码,也有人认为这增加了 Javascript 的复杂度,大多数人其实并不需要它。
到底是好是坏,这里不去辩别。但目前 Module 的语法已经定下来了,我们可以来探索下它。

ECMAScript 6 的模块有什么优点?

三个字:爽,快,强。

爽?
1. 语言层级支持,无需引入第三方库
2. 统一的 API,不用再写 [shim](umdjs/umd · GitHub)
3. 清爽的语法(与 Python 相似),功能却很丰富:

import:
import * as _ from 'src/lodash'; // 引入外部文件所有对象
import { each, map } from 'src/lodash'; // 引入外部文件部分对象
import _ from 'src/lodash'; // 引入外部文件默认导出对象
import _, { each, map } from 'src/lodash'; // 同时引入默认导出对象和部分对象
import 'src/lodash'; // 只加载外部文件,但啥都不引入

export:
export let _ = function () {}; // 导出 _ 对象
export function lodash () {}; // 导出 lodash 函数
export default function (x) {return x}; // 导出匿名函数并设为默认导出对象
export { _, lodash as default }; // 一次导出多个对象

4. 由于可以选择性引入并重命名外部模块的部分对象,因此全局变量不被污染,局部变量也不怕被污染。

快?

基于目前第三方依赖管理工具的实现,我们要通过运行时检查当前模块引入了哪些外部模块,效率较低。但现在有了新语法的支持,我们就可以在运行前判断得出模块之间的依赖关系,进行代码检查。

强?

1. 更好地支持循环依赖

循环依赖示例:
/* --- a.js --- */import * as b from 'js/b';// 在模块中间调用其它模块的方法
b.bar('b');export function foo (from) {
    console.log('caller: ' + from);
}
/* --- b.js --- */import * as a from 'js/a';// 在模块中间调用其它模块的方法
a.foo('a');export function bar (from) {
    a.foo(from);
}
/* --- main.js --- */
import {bar} from 'js/b';bar('main');

结果:
caller: b a.js:7caller: a a.js:7caller: main a.js:7

2. 提供模块加载器接口(Module Loader API)

有了这个接口后,模块的加载就有了更多的可能性,比如动态加载,加载后回调等。


展开阅读全文

没有更多推荐了,返回首页