备案控制台
开发者社区 开发与运维 文章 正文

CommonJs详解

2022-05-12 117
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： CommonJs详解

CommonJs详解



1 概述


Node 应用由模块组成，采用 CommonJS 模块规范。

每个文件就是一个模块，有自己的作用域。在一个文件里面定义的变量、函数、类，都是私有的，对其他文件不可见。


function Module(id, parent) {
  this.id = id;
  this.exports = {};
  this.parent = parent;
  // ...
• 1
• 2
• 3
• 4
• 5


每个模块内部，都有一个module对象，代表当前模块。它有以下属性。

module.id 模块的识别符，通常是带有绝对路径的模块文件名。

module.filename 模块的文件名，带有绝对路径。

module.loaded 返回一个布尔值，表示模块是否已经完成加载。

module.parent 返回一个对象，表示调用该模块的模块。

module.children 返回一个数组，表示该模块要用到的其他模块。

module.exports 表示模块对外输出的值。


2 module对象

下面是一个示例文件，最后一行输出module变量。


// example.js
var jquery = require('jquery');
exports.$ = jquery;
console.log(module);
• 1
• 2
• 3
• 4


执行这个文件，命令行会输出如下信息。


{ id: '.',
  exports: { '$': [Function] },
  parent: null,
  filename: '/path/to/example.js',
  loaded: false,
  children:
   [ { id: '/path/to/node_modules/jquery/dist/jquery.js',
       exports: [Function],
       parent: [Circular],
       filename: '/path/to/node_modules/jquery/dist/jquery.js',
       loaded: true,
       children: [],
       paths: [Object] } ],
  paths:
   [ '/home/user/deleted/node_modules',
     '/home/user/node_modules',
     '/home/node_modules',
     '/node_modules' ]
}




如果在命令行下调用某个模块，比如node something.js，那么module.parent就是null。如果是在脚本之中调用，比如require('./something.js')，那么module.parent就是调用它的模块。利用这一点，可以判断当前模块是否为入口脚本


if (!module.parent) {
    // ran with `node something.js`
    app.listen(8088, function() {
        console.log('app listening on port 8088');
    })
} else {
    // used with `require('/.something.js')`
    module.exports = app;
}
• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9


2.1 module.exports属性

module.exports属性表示当前模块对外输出的接口，其他文件加载该模块，实际上就是读取module.exports变量。


var EventEmitter = require('events').EventEmitter;
module.exports = new EventEmitter();
setTimeout(function() {
  module.exports.emit('ready');
}, 1000);
• 1
• 2
• 3
• 4
• 5
• 6


上面模块会在加载后1秒后，发出ready事件。其他文件监听该事件，可以写成下面这样。


var a = require('./a');
a.on('ready', function() {
  console.log('module a is ready');
});
• 1
• 2
• 3
• 4


2.2 exports变量


为了方便，Node为每个模块提供一个exports变量，指向module.exports。这等同在每个模块头部，有一行这样的命令。


var exports = module.exports;
• 1


造成的结果是，在对外输出模块接口时，可以向exports对象添加方法。


exports.area = function (r) {
  return Math.PI * r * r;
};
exports.circumference = function (r) {
  return 2 * Math.PI * r;
};
• 1
• 2
• 3
• 4
• 5
• 6
• 7


注意，不能直接将exports变量指向一个值，因为这样等于切断了exports与module.exports的联系。


exports = function(x) {console.log(x)};
• 1


上面这样的写法是无效的，因为exports不再指向module.exports了。

下面的写法也是无效的。


exports.hello = function() {
  return 'hello';
};
module.exports = 'Hello world';
• 1
• 2
• 3
• 4
• 5


上面代码中，hello函数是无法对外输出的，因为module.exports被重新赋值了。

这意味着，如果一个模块的对外接口，就是一个单一的值，不能使用exports输出，只能使用module.exports输出。


module.exports = function (x){ console.log(x);};
• 1


如果你觉得，exports与module.exports之间的区别很难分清，一个简单的处理方法，就是放弃使用exports，只使用module.exports。


3 AMD规范与CommonJS规范的兼容性



CommonJS规范加载模块是同步的，也就是说，只有加载完成，才能执行后面的操作。

AMD规范则是非同步加载模块，允许指定回调函数。由于Node.js主要用于服务器编程，模块文件一般都已经存在于本地硬盘，所以加载起来比较快，不用考虑非同步加载的方式，所以CommonJS规范比较适用。但是，如果是浏览器环境，要从服务器端加载模块，这时就必须采用非同步模式，因此浏览器端一般采用AMD规范。

AMD规范使用define方法定义模块，下面就是一个例子：


define(['package/lib'], function(lib){
  function foo(){
    lib.log('hello world!');
  }
  return {
    foo: foo
  };
});
• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9


AMD规范允许输出的模块兼容CommonJS规范，这时define方法需要写成下面这样：


define(function (require, exports, module){
  var someModule = require("someModule");
  var anotherModule = require("anotherModule");
  someModule.doTehAwesome();
  anotherModule.doMoarAwesome();
  exports.asplode = function (){
    someModule.doTehAwesome();
    anotherModule.doMoarAwesome();
  };
});
• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11
• 12


4 require命令

4.1 基本用法


Node使用CommonJS模块规范，内置的require命令用于加载模块文件。

require命令的基本功能是，读入并执行一个JavaScript文件，然后返回该模块的exports对象。如果没有发现指定模块，会报错。


// example.js
var invisible = function () {
  console.log("invisible");
}
exports.message = "hi";
exports.say = function () {
  console.log(message);
}
• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10


运行下面的命令，可以输出exports对象。


var example = require('./example.js');
example
// {
//   message: "hi",
//   say: [Function]
// }
• 1
• 2
• 3
• 4
• 5
• 6


如果模块输出的是一个函数，那就不能定义在exports对象上面，而要定义在module.exports变量上面。


module.exports = function () {
  console.log("hello world")
}
require('./example2.js')()
• 1
• 2
• 3
• 4
• 5


上面代码中，require命令调用自身，等于是执行module.exports，因此会输出 hello world。


4.2 加载规则


require命令用于加载文件，后缀名默认为.js。


var foo = require('foo');
//  等同于
var foo = require('foo.js');
• 1
• 2
• 3


根据参数的不同格式，require命令去不同路径寻找模块文件。

（1）如果参数字符串以“/”开头，则表示加载的是一个位于绝对路径的模块文件。比如，require('/home/marco/foo.js')将加载/home/marco/foo.js。

（2）如果参数字符串以“./”开头，则表示加载的是一个位于相对路径（跟当前执行脚本的位置相比）的模块文件。比如，require('./circle')将加载当前脚本同一目录的circle.js。

（3）如果参数字符串不以“./“或”/“开头，则表示加载的是一个默认提供的核心模块（位于Node的系统安装目录中），或者一个位于各级node_modules目录的已安装模块（全局安装或局部安装）。

举例来说，脚本/home/user/projects/foo.js执行了require('bar.js')命令，Node会依次搜索以下文件。

/usr/local/lib/node/bar.js

/home/user/projects/node_modules/bar.js

/home/user/node_modules/bar.js

/home/node_modules/bar.js

/node_modules/bar.js

这样设计的目的是，使得不同的模块可以将所依赖的模块本地化。

（4）如果参数字符串不以“./“或”/“开头，而且是一个路径，比如require('example-module/path/to/file')，则将先找到example-module的位置，然后再以它为参数，找到后续路径。

（5）如果指定的模块文件没有发现，Node会尝试为文件名添加.js、.json、.node后，再去搜索。.js件会以文本格式的JavaScript脚本文件解析，.json文件会以JSON格式的文本文件解析，.node文件会以编译后的二进制文件解析。

（6）如果想得到require命令加载的确切文件名，使用require.resolve()方法。


4.3 目录的加载规则


通常，我们会把相关的文件会放在一个目录里面，便于组织。这时，最好为该目录设置一个入口文件，让require方法可以通过这个入口文件，加载整个目录。

在目录中放置一个package.json文件，并且将入口文件写入main字段。下面是一个例子。


// package.json
{ "name" : "some-library",
  "main" : "./lib/some-library.js" }
• 1
• 2
• 3


require发现参数字符串指向一个目录以后，会自动查看该目录的package.json文件，然后加载main字段指定的入口文件。如果package.json文件没有main字段，或者根本就没有package.json文件，则会加载该目录下的index.js文件或index.node文件。


4.4 模块的缓存


第一次加载某个模块时，Node会缓存该模块。以后再加载该模块，就直接从缓存取出该模块的module.exports属性。


require('./example.js');
require('./example.js').message = "hello";
require('./example.js').message
// "hello"
• 1
• 2
• 3
• 4


上面代码中，连续三次使用require命令，加载同一个模块。第二次加载的时候，为输出的对象添加了一个message属性。但是第三次加载的时候，这个message属性依然存在，这就证明require命令并没有重新加载模块文件，而是输出了缓存。

如果想要多次执行某个模块，可以让该模块输出一个函数，然后每次require这个模块的时候，重新执行一下输出的函数。

所有缓存的模块保存在require.cache之中，如果想删除模块的缓存，可以像下面这样写。


// 删除指定模块的缓存
delete require.cache[moduleName];
// 删除所有模块的缓存
Object.keys(require.cache).forEach(function(key) {
  delete require.cache[key];
})
• 1
• 2
• 3
• 4
• 5
• 6
• 7


注意，缓存是根据绝对路径识别模块的，如果同样的模块名，但是保存在不同的路径，require命令还是会重新加载该模块。


4.5 环境变量NODE_PATH


Node执行一个脚本时，会先查看环境变量NODE_PATH。它是一组以冒号分隔的绝对路径。在其他位置找不到指定模块时，Node会去这些路径查找。

可以将NODE_PATH添加到.bashrc。


export NODE_PATH="/usr/local/lib/node"
• 1


所以，如果遇到复杂的相对路径，比如下面这样。


var myModule = require('../../../../lib/myModule');
• 1


有两种解决方法，一是将该文件加入node_modules目录，二是修改NODE_PATH环境变量，package.json文件可以采用下面的写法。


{
  "name": "node_path",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "start": "NODE_PATH=lib node index.js"
  },
  "author": "",
  "license": "ISC"
}
• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11


NODE_PATH是历史遗留下来的一个路径解决方案，通常不应该使用，而应该使用node_modules目录机制。


4.6 模块的循环加载


如果发生模块的循环加载，即A加载B，B又加载A，则B将加载A的不完整版本。


// a.js
exports.x = 'a1';
console.log('a.js ', require('./b.js').x);
exports.x = 'a2';
// b.js
exports.x = 'b1';
console.log('b.js ', require('./a.js').x);
exports.x = 'b2';
// main.js
console.log('main.js ', require('./a.js').x);
console.log('main.js ', require('./b.js').x);
• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11
• 12
• 13


上面代码是三个JavaScript文件。其中，a.js加载了b.js，而b.js又加载a.js。这时，Node返回a.js的不完整版本，所以执行结果如下。


$ node main.js
b.js  a1
a.js  b2
main.js  a2
main.js  b2
• 1
• 2
• 3
• 4
• 5


修改main.js，再次加载a.js和b.js。


// main.js
console.log('main.js ', require('./a.js').x);
console.log('main.js ', require('./b.js').x);
console.log('main.js ', require('./a.js').x);
console.log('main.js ', require('./b.js').x);
• 1
• 2
• 3
• 4
• 5


执行上面代码，结果如下。


$ node main.js
b.js  a1
a.js  b2
main.js  a2
main.js  b2
main.js  a2
main.js  b2
• 1
• 2
• 3
• 4
• 5
• 6
• 7


上面代码中，第二次加载a.js和b.js时，会直接从缓存读取exports属性，所以a.js和b.js内部的console.log语句都不会执行了。


4.7 require.main


require方法有一个main属性，可以用来判断模块是直接执行，还是被调用执行。

直接执行的时候（node module.js），require.main属性指向模块本身。


require.main === module
// true
• 1
• 2


调用执行的时候（通过require加载该脚本执行），上面的表达式返回false。


5 模块的加载机制

CommonJS模块的加载机制是，输入的是被输出的值的拷贝。也就是说，一旦输出一个值，模块内部的变化就影响不到这个值。请看下面这个例子。

下面是一个模块文件lib.js。


// lib.js
var counter = 3;
function incCounter() {
  counter++;
}
module.exports = {
  counter: counter,
  incCounter: incCounter,
};
• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9


上面代码输出内部变量counter和改写这个变量的内部方法incCounter。

然后，加载上面的模块。


// main.js
var counter = require('./lib').counter;
var incCounter = require('./lib').incCounter;
console.log(counter);  // 3
incCounter();
console.log(counter); // 3
• 1
• 2
• 3
• 4
• 5
• 6
• 7


上面代码说明，counter输出以后，lib.js模块内部的变化就影响不到counter了。


5.1 require的内部处理流程


require命令是CommonJS规范之中，用来加载其他模块的命令。它其实不是一个全局命令，而是指向当前模块的module.require命令，而后者又调用Node的内部命令Module._load。


Module._load = function(request, parent, isMain) {
  // 1. 检查 Module._cache，是否缓存之中有指定模块
  // 2. 如果缓存之中没有，就创建一个新的Module实例
  // 3. 将它保存到缓存
  // 4. 使用 module.load() 加载指定的模块文件，
  //    读取文件内容之后，使用 module.compile() 执行文件代码
  // 5. 如果加载/解析过程报错，就从缓存删除该模块
  // 6. 返回该模块的 module.exports
};
• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9


上面的第4步，采用module.compile()执行指定模块的脚本，逻辑如下。


Module.prototype._compile = function(content, filename) {
  // 1. 生成一个require函数，指向module.require
  // 2. 加载其他辅助方法到require
  // 3. 将文件内容放到一个函数之中，该函数可调用 require
  // 4. 执行该函数
};
• 1
• 2
• 3
• 4
• 5
• 6


上面的第1步和第2步，require函数及其辅助方法主要如下。


require(): 加载外部模块

require.resolve()：将模块名解析到一个绝对路径

require.main：指向主模块

require.cache：指向所有缓存的模块

require.extensions：根据文件的后缀名，调用不同的执行函数


一旦require函数准备完毕，整个所要加载的脚本内容，就被放到一个新的函数之中，这

样可以避免污染全局环境。该函数的参数包括require、module、exports，以及其他一些参数。


(function (exports, require, module, __filename, __dirname) {
  // YOUR CODE INJECTED HERE!
});


文章标签：
云解析DNS
JavaScript
前端开发
数据格式
缓存
JSON
在下月亮有何贵干
目录
相关文章
1941623231718325
|
4天前
|
缓存 JavaScript 前端开发
JavaScript模块化：CommonJS与ES Modules的对比与使用
【4月更文挑战第22天】本文探讨了JavaScript模块化的两种规范——CommonJS和ES Modules。CommonJS适用于Node.js，通过`require`同步加载模块，而ES Modules（ES6模块）用于前端，支持异步加载和静态导入导出。CommonJS有缓存，ES Modules无缓存。在选择时，Node.js环境常用CommonJS，但趋势正转向ES Modules，前端项目推荐使用ES Modules以利用其优化性能的优势。
1941623231718325
14 0
一个车迷
|
4天前
|
JavaScript 前端开发
说说你对ES6模块化的理解？和commonJS的区别？
ES6模块化（也称为ES2015模块化）是ECMAScript 6中引入的一种模块化规范，用于在JavaScript中组织和管理代码。它提供了一种更优雅和强大的方式来定义、引入和导出模块。
一个车迷
23 0
你都不懂
|
4天前
|
JavaScript
JS模块化规范之ES6及UMD
JS模块化规范之ES6及UMD
你都不懂
36 3
SailingByte
|
10月前
|
设计模式 前端开发 JavaScript
CJS,AMD,UMD和ESM区别
说到 CJS, AMD, UMD 和 ESM 四者的区别，不得不提一下模块这个概念。 CJS CJS（CommonJs） 适用于后端 Node。 Node 与 Javascript 最开始是没有模块这
SailingByte
242 0
前端小魔女
|
Rust 编译器 Go
你真的了解ESM吗？
模块兼容性 推荐阅读指数⭐️⭐️⭐️ ESM是个啥 推荐阅读指数⭐️⭐️⭐️⭐️ 在浏览器中使用ESM 推荐阅读指数⭐️⭐️⭐️⭐️ 模块指定符 推荐阅读指数⭐️⭐️⭐️⭐️⭐️ 默认情况下，模块是defer的 推荐阅读指数⭐️⭐️⭐️⭐️⭐️ 动态导入 推荐阅读指数⭐️⭐️⭐️⭐️⭐️ import.meta 推荐阅读指数⭐️⭐️⭐️⭐️⭐️ 优化建议 推荐阅读指数⭐️⭐️⭐️ 网站中使用ESM 推荐阅读指数⭐️⭐️⭐️
前端小魔女
107 0
你真的了解ESM吗？
游客pb2xwjvbsnpdo
|
前端开发 JavaScript 编译器
ES6、Babel
这篇文章我们主要讲两个方面的知识： 1、讲解ES6里面比较难理解的，但面试经常会问到的相关知识。 2、讲解Babel的原理以及如何使用Babel。
游客pb2xwjvbsnpdo
103 0
游客cmz32nke7bpic
|
缓存 自然语言处理 JavaScript
commonJS和ES6模块化的区别
在 ES6 之前，社区制定了一些模块加载方案，最主要的有 CommonJS 和 AMD 两种。前者用于服务器，后者用于浏览器。ES6 在语言标准的层面上，实现了模块功能，而且实现得相当简单，完全可以取代 CommonJS 和 AMD 规范，成为浏览器和服务器通用的模块解决方案。
游客cmz32nke7bpic
754 0
bqospzg5rfs7g
|
存储 JavaScript 前端开发
CommonJS规范介绍|学习笔记
快速学习CommonJS规范介绍
bqospzg5rfs7g
82 0
胡哥有话说
|
JavaScript 前端开发
JavaScript模块化-CommonJS、AMD、CMD、UMD、ES6
JavaScript模块化-CommonJS、AMD、CMD、UMD、ES6
胡哥有话说
139 0
答神~
|
Web App开发 JavaScript 前端开发
一文读懂前端模块化(CommonJS、AMD、CMD、UMD、ES6)
一文读懂前端模块化(CommonJS、AMD、CMD、UMD、ES6)
答神~
1012 0