JS模块化-CJS，ESM，AMD，CMD，UMD

1、为什么要模块化？

一旦应用非常复杂和庞大，不可能一个文件就写下所有的代码，所以将代码切割成多个模块，可按需加载和复用等。

JavaScript模块化编程是指将JavaScript代码分割成独立的模块，每个模块都有自己的作用域和接口，可以按需加载和使用。这样可以避免全局变量污染，提高代码的可维护性和可重用性。

2、CJS，ESM，AMD，CMD，UMD是什么？

CJS、ESM、AMD、CMD、UMD其实是不同的模块化规范，CJS和ESM比较常用。

CJS：全称CommonJS。

加载方式：同步。

使用范围：nodejs。

说明：定义每个文件都是一个模块（module变量代表当前模块）并有自己的作用域，而每个文件里面定义的变量、函数、类，都是私有的，对于其他模块是不可见。模块的exports属性是对外的接口，只有通过exports导出的属性才能被加载识别。Node就是基于CommonJs规范实现的，因为CommonJS规范加载模块是同步的，而服务器中的Node模块都直接存储在服务器本地硬盘中的，加载起来自然比较快，可以说node项目是CommonJs规范目前的最好实践应用。

module 变量代表当前模块，这是个对象，会创建exports的属性，属性的默认值是空对象{}。

module.exports 有两种写法：

• module.exports.xxx=abc;  // 作为对象
• module.exports=abc;  // 重新赋值

exports 和 module.exports的区别：

exports 是对 module.exports 的引用，相当于exports = module.exports = {};

例如：

写法一：
// a.js 导出
module.exports.a = function(a,b){
    console.log("这是aaaa");
    return a + b;
}

// b.js 引用
var afile = require('./a');
console.log(afile.a(1,2));

另一个例子：
// a.js 导出
exports.data = {
    name: "momo",
    age: 18,
    add: function () {
        console.log("add...")
    }
}

// b.js 引用
var afile = require('./a');
console.log(afile);    //{ data: { name: 'momo', age: 18, add: [Function: add] } }

写法二：
// test.js 导出
module.exports = {
  a: "china",
  b: function() {
    console.log("b");
  }
};

// index.js 引用
var test = require("./test");
test.b();

ESM：全称ES Modules。

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

注意：

1、引入 export default 导出的模块不用加 {},引入非 export default 导出的模块需要加 {}。

2、一个文件只能导出一个 default 模块。

3、import/export 不能对引入模块重新赋值/定义。

import fs from 'fs'
import {readFile} from 'fs' //从 fs 导入 readFile 模块
import {default as fs} from 'fs' //从 fs 中导入使用 export default 导出的模块
import * as fileSystem from 'fs' //从 fs 导入所有模块，引用对象名为 fileSystem
import {readFile as read} from 'fs' //从 fs 导入 readFile 模块，引用对象名为 read

export default fs
export const fs
export function readFile
export {readFile, read}
export * from 'fs'

AMD：全称Asynchronously Module Definition（异步模块定义)。

AMD规范采用异步方式加载模块，模块的加载不影响它后面语句的运行。所有依赖这个模块的语句，都定义在一个回调函数中，等到加载完成之后，这个回调函数才会运行。这里介绍用require.js实现AMD规范的模块化：用require.config()指定引用路径等，用definde()定义模块，用require()加载模块。

首先我们需要引入require.js文件和一个入口文件main.js。main.js中配置require.config()并规定项目中用到的基础模块。

/** 网页中引入require.js及main.js **/
<script src="js/require.js" data-main="js/main"></script>

/** main.js 入口文件/主模块 **/
// 首先用config()指定各模块路径和引用名
require.config({
  baseUrl: "js/lib",
  paths: {
    "jquery": "jquery.min",  //实际路径为js/lib/jquery.min.js
    "underscore": "underscore.min",
  }
});
// 执行基本操作
require(["jquery","underscore"],function($,_){
  // some code here
});

引用模块的时候，我们将模块名放在[]中作为reqiure()的第一参数；如果我们定义的模块本身也依赖其他模块,那就需要将它们放在[]中作为define()的第一参数。

// 定义math.js模块
define(function () {
    var basicNum = 0;
    var add = function (x, y) {
        return x + y;
    };
    return {
        add: add,
        basicNum :basicNum
    };
});

// 定义一个依赖underscore.js的模块
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(10,20);
  $("#sum").html(sum);
});

定义模块的两种写法：
define(['dep1', 'dep2'], function (dep1, dep2) {
    //Define the module value by returning a value.
    return function () {};
});

// "simplified CommonJS wrapping" https://requirejs.org/docs/whyamd.html
define(function (require) {
    var dep1 = require('dep1'),
        dep2 = require('dep2');
    return function () {};
});

CMD：全称Synchronously Module Definition（同步模块定义)。

AMD的实现者require.js在申明依赖的模块时，会在第一时间加载并执行模块内的代码。

CMD是另一种js模块化方案，它与AMD很类似，不同点在于：AMD推崇依赖前置、提前执行，CMD推崇依赖就近、延迟执行。此规范其实是在sea.js推广过程中产生的。

/** AMD写法 **/
define(["a", "b", "c", "d", "e", "f"], function(a, b, c, d, e, f) { 
     // 等于在最前面声明并初始化了要用到的所有模块
    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();
    }
});

/** sea.js **/
// 定义模块 math.js
define(function(require, exports, module) {
    var $ = require('jquery.js');
    var add = function(a,b){
        return a+b;
    }
    exports.add = add;
});

// 加载模块
seajs.use(['math.js'], function(math){
    var sum = math.add(1+2);
});

UMD：全称Universal Module Definition（通用模块定义）。

加载方式：同步

使用范围：nodejs、浏览器；兼容 CommonJS、CMD、AMD

// a.js 导出
(function (global, factory) {
    if (typeof exports === "object" && typeof module !== "undefined") {
        // commonjs
        factory(exports);
    } else if (typeof define === "function" && define.amd) {
        // amd
        define(["exports"], factory);
    } else if (typeof define === "function" && define.cmd) {
        // cmd
        define(function (require, exports, module) {
            exports.a = 10
            factory(exports);
        });
    } else {
        // 没有环境
        (global = typeof globalThis !== "undefined" ? globalThis : global || self),
            factory((global.umd = {}));
    }
})(this, function (exports) {
    "use strict";
    var sum = function sum(a, b) {
        console.log(a);
        console.log(b);
        return a + b;
    };
    exports.sum = sum;
    Object.defineProperty(exports, "__esModule", { value: true });
});

// b.js 引入  会打印出1 5 6
var afile = require("./a");
console.log(afile.sum(1,5));

3、require与import的区别

1，require是CommonJS规范的模块化语法，import是ECMAScript 6规范的模块化语法；

2，require是运行时加载，import是编译时加载；CommonJS 加载的是一个对象（即 module.exports 属性），该对象只有在脚本运行完才会生成。而 ES6 模块不是对象，它的对外接口只是一种静态定义，在代码静态解析阶段就会生成。

3，require可以写在代码的任意位置，import只能写在文件的最顶端且不可在条件语句或函数作用域中使用；

4，require通过module.exports导出的值就不能再变化，import通过export导出的值可以改变；require/exports 输出的是值的拷贝。也就是说，一旦输出一个值，模块内部的变化就影响不到这个值。import/export 模块输出的是值的引用。JS 引擎对脚本静态分析的时候，遇到模块加载命令import，就会生成一个只读引用。等到脚本真正执行时，再根据这个只读引用，到被加载的那个模块里面去取值。

5，require通过module.exports导出的是exports对象，import通过export导出是指定输出的代码；

6，require运行时才引入模块的属性所以性能相对较低，import编译时引入模块的属性所所以性能稍高。

4、一些总结

1、AMD/CMD/CommonJs 是js模块化开发的规范，对应的实现是require.js/sea.js/Node.js

2、CommonJs 主要针对服务端，AMD/CMD/ES Module主要针对浏览器端，容易混淆的是AMD/CMD。（顺便提一下，针对服务器端和针对浏览器端有什么本质的区别呢？服务器端一般采用同步加载文件，也就是说需要某个模块，服务器端便停下来，等待它加载再执行。这里如果有其他后端语言，如java。而浏览器端要保证效率，需要采用异步加载，这就需要一个预处理，提前将所需要的模块文件并行加载好。）

3、AMD/CMD区别，虽然都是并行加载js文件，但还是有所区别，AMD是预加载，在并行加载js文件同时，还会解析执行该模块（因为还需要执行，所以在加载某个模块前，这个模块的依赖模块需要先加载完成）；而CMD是懒加载，虽然会一开始就并行加载js文件，但是不会执行，而是在需要的时候才执行。

4、AMD/CMD的优缺点：

AMD优点：加载快速，尤其遇到多个大文件，因为并行解析，所以同一时间可以解析多个文件。

AMD缺点：并行加载，异步处理，加载顺序不一定，可能会造成一些困扰，甚至为程序埋下大坑。

CMD优点：因为只有在使用的时候才会解析执行js文件，因此，每个JS文件的执行顺序在代码中是有体现的，是可控的。

CMD缺点：执行等待时间会叠加。因为每个文件执行时是同步执行（串行执行），因此时间是所有文件解析执行时间之和，尤其在文件较多较大时，这种缺点尤为明显。（PS：重新看这篇文章，发现这里写的不是很准确。确切来说，JS是单线程，所有JS文件执行时间叠加在AMD和CMD中是一样的。但是CMD是使用时执行，没法利用空闲时间，而AMD是文件加载好就执行，往往可以利用一些空闲时间。这么来看，CMD比AMD的优点还是很明显的，毕竟AMD加载好的时候也未必就是JS引擎的空闲时间！）

5、CommonJS 和 ES Module 区别：CommonJS 模块输出的是一个值的拷贝，ES6 模块输出的是值的引用

6、如何使用？CommonJs 的话，因为 NodeJS 就是它的实现，所以使用 node 就行，也不用引入其他包。AMD则是<script>标签引入require.js，CMD则是引入sea.js。

参考：

require与import的区别和使用(CommonJS规范和es6规范)

require和import的区别

CJS, AMD, UMD,ESM 简洁解释

require VS import VS import() 对比分析(史上最详细)

前端模块化——彻底搞懂AMD、CMD、ESM和CommonJS