JS中的模块规范:AMD,CMD,CommonJS, UMD

前端开发一直在强调js模块化,将一个功能当做一个模块来开发,js本身并没有模块的功能。JS中的模块化规范主要有:

  • AMD,即 Asynchronous Module Definition: 异步模块定义:这种规范可以异步的加载或依赖其他模块, Require.js就遵循的AMD规范 。
  • CMD,即 Common Module Definition,CMD则是依赖就近,用的时候再require。玉伯写的sea.js 就是遵循的CMD规范。
  • CommonJS,NodeJS就采用了CommonJS。
  • UMD,即通用模块定义,UMD规范兼容AMD 和 CommonJs。

AMD 规范

AMD规范只定义了一个函数 "define",它是全局变量。函数的描述为:

//  '?' 表示该参数是可选的
define(id?, dependencies?, callback);
  • id,是个字符串, 指定模块的名字。如果没有提供该参数,模块的名字应该默认为模块加载器请求的指定脚本的名字。如果提供了该参数,模块名必须是“顶级”的和绝对的(不允许相对名字)。
  • dependencies,是个数组, 指定该模块依赖的模块数组。依赖模块依次执行,并且执行的结果,应该按照依赖模块数组中的位置顺序以参数的形式传入callback中。
  • factory,依赖模块加载成功之后的回调函数或对象,如果为函数,它应该只被执行一次。如果是对象,此对象应该为模块的输出值。。

AMD规范定义了三个特殊的依赖关键字。如果"require","exports", 或 "module" 出现在依赖列表中,参数应该按照CommonJS模块规范自由变量去解析。
如果依赖参数没传,默认为["require", "exports", "module"]。然而,如果factory的形参个数小于3,加载器会选择以函数指定的参数个数调用factory。

AMD 定义模块:

// 要在声明模块的时候指定所有的依赖(dep),并且还要当做形参传到factory中
// 这里的依赖是jquery
define(['jquery'], factory($) {
  return {
    myMethod: function() {
       console.log('AMD 规范');
    }
  };
})

一个使用Simplified CommonJS Wrapping的模块定义:

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

CMD 规范

CMD, 是seajs推崇的规范,CMD则是依赖就近,用的时候再require。写法如下:

// define(factory方法)
define(function(require, exports, module) {
   var a = require('a');
   a.hello();
});

AMDCMD都是异步加载模块,最大的区别是对依赖模块的执行时机不同,而不是加载方式不同。

  • AMD依赖前置,提前执行,依赖模块一目了然;
  • CMD依赖就近,并行加载所有依赖的模块, 但不会立即执行模块, 等到对应 require 语句时,才执行模块。因此CMD需要从factory.toString() 中提取到依赖模块,这会导致更长的等待时间,实际上解析模块用的时间短到可以忽略。

CommonJS 规范

NodeJS的模块系统就是遵循CommonJS规范实现的。CommonJS是主要为了JS在后端的表现制定的,实现CommonJS规范的API是同步加载模块的, 因为在服务端模块的加载一般是从本地磁盘中读取,加载速度很快,不像客户端端需要发送请求加载, 可能出现'假死'状况。

CommonJS定义的模块分为:

  • 模块引用(require):用来引入外部模块
  • 模块定义(exports):用于导出当前模块的方法或变量,唯一的导出口
  • 模块标识(module):module对象就代表模块本身
 //add.js
exports.add = function(x, y){
  return x+y;
};

//main.js
var math = require('add');
exports.add = function(n){
     return math.add(100, n);
};

Browserify(http://browserify.org/) 是目前最常用的 CommonJS 格式转换的工具, 能够将commonJs规范的代码转换为浏览器可直接执行的代码。

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

UMD(通用模块规范)

UMD规范则是兼容了 AMD 和 CommonJs。

(function (root, factory) {
    if (typeof define === 'function' && define.amd) {
        // AMD
        define(['jquery'], factory);
    } else if (typeof exports === 'object') {
        // Node, CommonJS之类的
        module.exports = factory(require('jquery'));
    } else {
        // 浏览器全局变量 (root 即window)
        root.returnExports = factory(root.jQuery);
    }
}(this, function ($) {
    function add(){};
    // 暴露公共方法
    return {
      add: add
    };
}));

ES6中的模块化

  • ES6 模块的设计思想,是尽量的静态化,使得编译时就能确定模块的依赖关系,以及输入和输出的变量。
    Require是CommonJS的语法,CommonJS的模块是对象,输入时必须查找对象属性。
// CommonJS模块
let { stat, exists, readFile } = require('fs');

Commonjs:整体加载fs模块(即加载fs所有方法),生成一个对象"_fs",然后再从这个对象上读取三个方法,这叫“运行时加载”,因为只有运行时才能得到这个对象,不能在编译时做到静态化。

ES6模块不是对象,而是通过export命令显示指定输出代码,再通过import输入。
ES6模块是编译时加载:模块之间的依赖关系,在运行之前(即编译时)就通过静态分析来确定好了的。

// 从fs加载“stat, exists, readFile” 三个方法,其他方法不加载,这是编译时加载,也叫静态加载
import { stat, exists, readFile } from 'fs';
  • ES6 的模块自动采用严格模式,不管你有没有在模块头部加上"use strict";。
  • ES6使用import, export 实现的模块化。import 用来导入其它模块, export 用来输出对外的接口,可以是变量,函数和类。

export 关键字

一个模块就是一个独立的文件。该文件内部的所有变量,外部无法获取。如果你希望外部能够读取模块内部的某个变量,就必须使用export关键字输出该变量。

export可以输出变量、函数和类,但不可以直接输出值,否则会报错,因为export命令规定的是对外的接口,必须与模块内部的变量建立一一对应关系。

const sum = function(a, b) {
  return a+b;
}
const minus = function(a, b) {
  return a-b;
} 
// 同一个模块可以有多个export 命令语句。
export {
  sum 
}
// as 关键字用来重命名变量
export {
  minus as reduce
}

注意:export不能输出值,并且它输出的变量函数名或者类名要放在"{ }"中

export default命令

export default为模块指定默认输出,一个模块只能有一个默认输出。
可以理解为:export default 就是输出一个叫做default的变量, 系统允许你为它取任意名字。

export default  sum(a, b) {
  return a+b;
}

import:

  • 使用import加载export输出的接口, 必须用{ }包住
import  {sum as add,  reduce } from './index.js';
  • 使用import加载export default 输出的接口
// 方式1
import  sum from './index.js';

// 方式2: 可以任意命名
import  default as foo from './index.js';

注意:

  • import只会导入一次,无论你引入多少次, import语句是 Singleton 模式。
    有提升效果,import会自动提升到顶部,首先执行
import { foo } from 'my_module';
import { bar } from 'my_module';

// 等同于
import { foo, bar } from 'my_module';
  • 由于import是静态执行,所以不能使用表达式和变量,这些只有在运行时才能得到结果的语法结构。
  • 循环加载时,ES6模块是动态引用。只要两个模块之间存在某个引用,代码就能够执行。
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,294评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,493评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,790评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,595评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,718评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,906评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,053评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,797评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,250评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,570评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,711评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,388评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,018评论 3 316
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,796评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,023评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,461评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,595评论 2 350

推荐阅读更多精彩内容