CJS、AMD、UMD、ESM的区别

2024-09 1

最初，Javascript 没有导入/导出模块的方法， 这是让人头疼的问题。 想象一下，只用一个文件编写应用程序——这简直是噩梦！

后来社区出现了一些 Javascript 模块化的方式。其中就有 CJS、AMD、UMD 和 ESM。你可能听说过其中的一些方法(还有其他方法，但这些是比较通用的)。

CJS

CJS 是 CommonJS 的缩写，其用法如下

// importing 
const doSomething = require('./doSomething.js'); 

// exporting
module.exports = function doSomething(n) {
  // do something
}
  • 很多人可以从 Node 中立刻认出 CJS 的语法。这是因为 Node 就是使用 CJS 模块的
  • CJS 是同步导入模块
  • 你可以从 node_modules 中引入一个库或者从本地目录引入一个文件 。如 const myLocalModule = require('./some/local/file.js') 或者 var React = require('react'); ，都可以起作用
  • 当 CJS 导入时，它会给你一个导入对象的副本
  • CJS 不能在浏览器中工作。它必须经过转换和打包

AMD

AMD 代表异步模块定义。下面是一个示例代码

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 () {};
});
  • AMD 是异步(asynchronously)导入模块的(因此得名)
  • 一开始被提议的时候，AMD 是为前端而做的(而 CJS 是后端)
  • AMD 的语法不如 CJS 直观，甚至可以说 AMD 和 CJS 完全相反

UMD

UMD 代表通用模块定义（Universal Module Definition）。下面是它可能的样子(来源)

(function (root, factory) {
    if (typeof define === "function" && define.amd) {
        define(["jquery", "underscore"], factory);
    } else if (typeof exports === "object") {
        module.exports = factory(require("jquery"), require("underscore"));
    } else {
        root.Requester = factory(root.$, root._);
    }
}(this, function ($, _) {
    // this is where I defined my module implementation

    var Requester = { // ... };

    return Requester;
}));

以下是简写

(function(root, B){
  // do something
}(this, b))
  • 从简写模式中可以看出，UMD其实就是一个匿名的立即执行函数。
  • 在前端和后端都适用（“通用”因此得名）
  • 与 CJS 或 AMD不同，UMD 更像是一种配置多个模块系统的模式。这里可以找到更多的模式
  • 当使用 Rollup/Webpack 之类的打包器时，UMD 通常用作备用模块

ESM

ESM 代表 ES 模块。这是 Javascript 提出的实现一个标准模块系统的方案，这也是现在大家所熟悉的前端方案

import React from 'react';

或者其他更多的

import {foo, bar} from './myLib';

...

export default function() {
  // your Function
};
export const function1() {...};
export const function2() {...};
  • 在很多现代浏览器可以使用
  • 它兼具两方面的优点：具有 CJS 的简单语法和同步特性，也可以动态引入，从而具备 AMD 一样的异步
  • 得益于 ES6 的静态模块结构，可以进行 Tree Shaking
  • ESM 允许像 Rollup 这样的打包器，删除不必要的代码，减少代码包可以获得更快的加载
  • 可以在 HTML 中调用，只要如下
<script type="module">
  import {func1} from 'my-lib';

  func1();
</script>

总结

  • 由于 ESM 具有简单的语法，异步特性和可摇树性，因此它是最好的模块化方案
  • UMD 随处可见，通常在 ESM 不起作用的情况下用作备用
  • CJS 是同步的，适合后端
  • AMD 是异步的，适合前端