即使在阅读了很多之后,我仍然对 CommonJS、AMD 和 RequireJS 感到非常困惑。
我知道 CommonJS(以前称为 ServerJS)是一组用于定义一些 JavaScript 规范(即模块)时的语言在浏览器之外使用。 CommonJS 模块规范有一些实现,比如 Node.js 或 RingoJS,对吧?
CommonJS、异步模块定义 (AMD) 和 RequireJS 之间有什么关系? RequireJS 是 CommonJS 模块定义的实现吗?如果是,那么 AMD 是什么?
RequireJS 实现了 AMD API (source)。
CommonJS 是一种借助 exports
对象定义模块的方法,该对象定义模块内容。简单地说,CommonJS 实现可能是这样工作的:
// someModule.js
exports.doSomething = function() { return "foo"; };
//otherModule.js
var someModule = require('someModule'); // in the vein of node
exports.doSomethingElse = function() { return someModule.doSomething() + "bar"; };
基本上,CommonJS 指定您需要有一个 require()
函数来获取依赖项,一个 exports
变量来导出模块内容和一个模块标识符(描述与该模块相关的模块的位置)需要依赖项 (source)。 CommonJS 有各种实现,包括你提到的 Node.js。
CommonJS 的设计并没有特别考虑浏览器,所以它不太适合浏览器环境(*我真的没有这方面的来源——它只是到处都这么说,包括 the RequireJS site.*)显然,这有一些东西要做异步加载等。
另一方面,RequireJS 实现了 AMD,它旨在适应浏览器环境 (source)。显然,AMD 最初是从 CommonJS 传输格式衍生出来的,并演变成自己的模块定义 API。因此,两者之间的相似之处。 AMD 的新特性是 define()
函数,它允许模块在加载之前声明其依赖项。例如,定义可以是:
define('module/id/string', ['module', 'dependency', 'array'],
function(module, factory function) {
return ModuleContents;
});
因此,CommonJS 和 AMD 是 JavaScript 模块定义 API,它们具有不同的实现,但都来自相同的起源。
AMD 更适合浏览器,因为它支持模块依赖的异步加载。
RequireJS 是 AMD 的一个实现,同时试图保持 CommonJS 的精神(主要在模块标识符中)。
更让你困惑的是,RequireJS 虽然是 AMD 的实现,但提供了一个 CommonJS 包装器,因此几乎可以直接导入 CommonJS 模块以与 RequireJS 一起使用。
define(function(require, exports, module) {
var someModule = require('someModule'); // in the vein of node
exports.doSomethingElse = function() { return someModule.doSomething() + "bar"; };
});
CommonJS 不仅如此 - 它是一个为 JavaScript 定义通用 API 和生态系统的项目。 CommonJS 的一部分是 Module 规范。 Node.js 和 RingoJS 是服务器端 JavaScript 运行时,是的,它们都实现了基于 CommonJS 模块规范的模块。
AMD(异步模块定义)是另一种模块规范。 RequireJS 可能是最流行的 AMD 实现。与 CommonJS 的一个主要区别是 AMD 指定模块是异步加载的 - 这意味着模块是并行加载的,而不是通过等待加载完成来阻止执行。
由于这个原因,AMD 通常更多地用于客户端(浏览器内)JavaScript 开发,而 CommonJS 模块通常用于服务器端。但是,您可以在任一环境中使用任一模块规范 - 例如,RequireJS 提供 directions for running in Node.js 而 browserify 是可以在浏览器中运行的 CommonJS 模块实现。
简短的回答是:
CommonJS 和 AMD 是关于如何在 javascript 应用程序中声明模块及其依赖项的规范(或格式)。
RequireJS 是一个与 AMD 兼容的脚本加载程序库,curljs 是另一个示例。
符合 CommonJS:
// package/lib is a dependency we require
var lib = require( "package/lib" );
// behavior for our module
function foo(){
lib.log( "hello world!" );
}
// export (expose) foo to other modules as foobar
exports.foobar = foo;
符合 AMD 标准:
// package/lib is a dependency we require
define(["package/lib"], function (lib) {
// behavior for our module
function foo() {
lib.log( "hello world!" );
}
// export (expose) foo to other modules as foobar
return {
foobar: foo
}
});
该模块可以在其他地方使用:
require(["package/myModule"], function(myModule) {
myModule.foobar();
});
一些背景:
实际上,CommonJS 不仅仅是一个 API 声明,它只是处理它的一部分。 AMD 最初是作为 CommonJS 列表中模块格式的草案规范,但未达成完全共识,格式的进一步开发移至 amdjs group。围绕哪种格式更好的争论表明,CommonJS 试图涵盖更广泛的关注点,并且鉴于其同步性质,它更适合服务器端开发,而 AMD 更适合客户端(浏览器)开发,因为它具有异步性质和事实上,它源于 Dojo 的模块声明实现。
资料来源:
RequireJS - 为什么选择 AMD?
Addy Osmani - 学习 JavaScript 设计模式 - 现代模块化 JavaScript 设计模式
AMD compliant
实际上是 RequireJS,对吧?
超微:
一种浏览器优先的方法
选择异步行为和简化的向后兼容性
它没有任何文件 I/O 的概念。
它支持对象、函数、构造函数、字符串、JSON 和许多其他类型的模块。
通用JS:
一种服务器优先的方法
假设同步行为
涵盖更广泛的关注点,例如 I/O、文件系统、Promises 等。
支持展开的模块,感觉更接近 ES.next/Harmony 规范,让您摆脱 AMD 强制执行的 define() 包装器。
仅支持将对象作为模块。
将 JavaScript 程序模块化组织成多个文件并从 main js module
调用 child-modules
是很正常的。
问题是 JavaScript 不提供这个。甚至今天在 Chrome 和 FF 的最新浏览器版本中也没有。
但是,JavaScript 中是否有任何关键字可以调用另一个 JavaScript 模块?
对许多人来说,这个问题可能是世界的彻底崩溃,因为答案是否定的。
在 ES5(2009 年发布)中,JavaScript 没有诸如 import、include 或 require 之类的关键字。
ES6 拯救了一天(2015 年发布)提出 import 关键字(https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Statements/import),现在全部是 modern browsers support。
如果您使用 Babel 6.18.0 并仅使用 ES2015 选项进行编译
import myDefault from "my-module";
您将再次获得 require
。
"use strict";
var _myModule = require("my-module");
var _myModule2 = _interopRequireDefault(_myModule);
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
这是因为 require
表示模块将从 Node.js 加载。 Node.js 将处理从系统级文件读取到将函数包装到模块中的所有事情。
因为在 JavaScript 中,函数是表示模块的唯一包装器。
我对 CommonJS 和 AMD 感到很困惑?
CommonJS 和 AMD 只是两种不同的技术,用于克服 JavaScript “缺陷”以智能加载模块。
AMD
在 JavaScript 中引入以将 JavaScript 项目扩展为多个文件
主要用于基于浏览器的应用程序和库
流行的实现是 RequireJS、Dojo Toolkit
通用JS:
它是处理大型项目的大量功能、文件和模块的规范
Mozilla 于 2009 年 1 月推出的初始名称 ServerJS
2009 年 8 月更名为 CommonJS,以显示 API 更广泛的适用性
最初的实现是服务器、nodejs、基于桌面的库
例子
上层.js 文件
exports.uppercase = str => str.toUpperCase()
main.js 文件
const uppercaseModule = require('uppercase.js')
uppercaseModule.uppercase('test')
概括
AMD – 最古老的模块系统之一,最初由库 require.js 实现。
CommonJS – 为 Node.js 服务器创建的模块系统。
UMD – 另一个模块系统,建议作为通用系统,与 AMD 和 CommonJS 兼容。
资源:
https://exploringjs.com/es6/ch_modules.html#sec_modules-in-javascript
维基百科
不定期副业成功案例分享