common.js

概述

所有代码都运行在模块作用域,不会污染全局作用域。
模块可以多次加载,但是只会在第一次加载时运行一次,然后运行结果就被缓存了,以后再加载,就直接读取缓存结果。要想让模块再次运行,必须清除缓存。
模块加载的顺序,按照其在代码中出现的顺序。
CommonJS 规范的主要内容有,一个单独的文件就是一个模块。每一个模块都是一个单独的作用域,模块必须通过 module.exports 导出对外的变量或接口,通过 require() 来导入其他模块的输出到当前模块作用域中,下面讲述一下 NodeJs 中 CommonJS 的模块化机制。

module对象

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

console.log(module.id) //模块的识别符,通常是带有绝对路径的模块文件名。
console.log(module.filename) //模块的文件名,带有绝对路径。console.log(module.loaded) //返回一个布尔值,表示模块是否已经完成加载。
console.log(module.parent) //返回一个对象,表示调用该模块的模块。
console.log(module.children) //返回一个数组,表示该模块要用到的其他模块。
console.log(module.exports) //表示模块对外输出的值。
module.exports属性

exports 和 module.exports 是指向同一个东西的变量,即是 module.exports = exports = {},所以你也可以这样导出模块
module.exports属性表示当前模块对外输出的接口,其他文件加载该模块,实际上就是读取module.exports变量。

//add.js
exports.add = function(a, b) {
  return a + b;
};

但是如果直接修改 exports 的指向是无效的,例如:

// add.js
exports = function(a, b) {
  return a + b;
};
// main.js
var add = require("./add.js");

此时得到的 add 是一个空对象,因为 require 导入的是,对应模块的 module.exports 的内容,在上面的代码中,虽然一开始 exports = module.exports,但是当执行如下代码的时候,其实就将 exports 指向了 function,而 module.exports 的内容并没有改变,所以这个模块的导出为空对象。

exports = function(a, b) {
  return a + b;
};
exports变量

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

var exports = module.exports;(commonJS隐式做了这个赋值)

这样做的好处是,在对外输出模块接口时,可以向exports对象添加方法暴露出去。
因此如果改变了module.exports,但还想使用export.xxx的方式暴露一些东西,那就只好我们自己来写exports = module.exports;
栗:

module.exports = songthing;//接下来把exports指回来exports = module.exports;//常见写法是:exports = module.exports = something;

require命令

Node使用CommonJS模块规范,内置的require命令用于加载模块文件。
require命令的基本功能是,读入并执行一个JavaScript文件,然后返回该模块的exports对象。如果没有发现指定模块,会报错。(说白了就是将另一个文件中暴露的值,引用到本文件中。)

 example.jsvar invisible = function () {  console.log("invisible");
}
exports.message = "hi";
exports.say = function () {  console.log(message);}
加载规则

在 NodeJs 中引入模块 (require),需要经历如下 3 个步骤:

路径分析
文件定位
编译执行
与前端浏览器会缓存静态脚本文件以提高性能一样,NodeJs 对引入过的模块都会进行缓存,以减少二次引入时的开销。不同的是,浏览器仅缓存文件,而在 NodeJs 中缓存的是编译和执行后的对象。


image.png
var foo = require('foo');//  等同于var foo = require('foo.js');

根据参数的不同格式,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()方法。

模块编译

在定位到文件后,首先会检查该文件是否有缓存,有的话直接读取缓存,否则,会新创建一个 Module 对象,其定义如下:

function Module(id, parent) {
  this.id = id; // 模块的识别符,通常是带有绝对路径的模块文件名。
  this.exports = {}; // 表示模块对外输出的值
  this.parent = parent; // 返回一个对象,表示调用该模块的模块。
  if (parent && parent.children) {
    this.parent.children.push(this);
  }
  this.filename = null;
  this.loaded = false; // 返回一个布尔值,表示模块是否已经完成加载。
  this.childrent = []; // 返回一个数组,表示该模块要用到的其他模块。
}

require 操作代码如下所示:

Module.prototype.require = function(id) {
  // 检查模块标识符
  if (typeof id !== "string") {
    throw new ERR_INVALID_ARG_TYPE("id", "string", id);
  }
  if (id === "") {
    throw new ERR_INVALID_ARG_VALUE("id", id, "must be a non-empty string");
  }
  // 调用模块加载方法
  return Module._load(id, this, /* isMain */ false);
};

编译过程主要做了以下的操作:
1,将 JavaScript 代码用函数体包装,隔离作用域,例如:

exports.add = (function(a, b) {
  return a + b;
}

会被转换为

(
  function(exports, require, modules, __filename, __dirname) {
    exports.add = function(a, b) {
      return a + b;
    };
  }
);

2,执行函数,注入模块对象的 exports 属性,require 全局方法,以及对象实例,__filename, __dirname,然后执行模块的源码。
3,返回模块对象 exports 属性。

目录的加载规则

通常,我们会把相关的文件会放在一个目录里面,便于组织。这时,最好为该目录设置一个入口文件,让require方法可以通过这个入口文件,加载整个目录。
在目录中放置一个package.json文件,并且将入口文件写入main字段。下面是一个例子。

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

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

模块的缓存

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

require('./example.js');
require('./example.js').message = "hello";
require('./example.js').message// "hello"

上面代码中,连续三次使用require命令,加载同一个模块。第二次加载的时候,为输出的对象添加了一个message属性。但是第三次加载的时候,这个message属性依然存在,这就证明require命令并没有重新加载模块文件,而是输出了缓存。
如果想要多次执行某个模块,可以让该模块输出一个函数,然后每次require这个模块的时候,重新执行一下输出的函数。
所有缓存的模块保存在require.cache之中,如果想删除模块的缓存,可以像下面这样写。

 删除指定模块的缓存delete require.cache[moduleName];
删除所有模块的缓存Object.keys(require.cache).forEach(function(key) {  delete require.cache[key];
})

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

模块的循环加载

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

// a.js
console.log('a starting');
exports.done = false;
const b = require('./b.js');
console.log('in a, b.done = %j', b.done);
exports.done = true;
console.log('a done');
// b.js
console.log('b starting');
exports.done = false;
const a = require('./a.js');
console.log('in b, a.done = %j', a.done);
exports.done = true;
console.log('b done');
// main.js
console.log('main starting');
const a = require('./a.js');
const b = require('./b.js');
console.log('in main, a.done=%j, b.done=%j', a.done, b.done);

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

main starting
a starting
b starting
in b, a.done = false
b done
in a, b.done = true
a done
in main, a.done=true, b.done=true

CommonJs 模块的两个特性。第一,加载时执行;第二,已加载的模块会进行缓存,不会重复加载。下程序的执行过程

  • main.js 执行,输出 main starting
  • main.js 加载 a.js,执行 a.js 并输出 a starting,导出 done = false
  • a.js 加载 b.js,执行 b.js 并输出 b starting,导出 done = false
  • b.js 加载 a.js,由于之前 a.js 已加载过一次因此不会重复加载,缓存中 a.js 导出的done = false,因此,b.js 输出 in b, a.done = false
  • b.js 导出 done = true,并输出 b done
  • b.js 执行完毕,执行权交回给 a.js,执行 a.js,并输出 in a, b.done = true
  • a.js 导出 done = true,并输出 a done
  • a.js 执行完毕,执行权交回给 main.js,main.js 加载 b.js,由于之前 b.js 已加载过一次,不会重复执行
  • main.js 输出 in main, a.done=true, b.done=true
    从上面的执行过程中,我们可以看到,在 CommonJS 规范中,当遇到 require() 语句时,会执行 require 模块中的代码,并缓存执行的结果,当下次再次加载时不会重复执行,而是直接取缓存的结果。正因为此,出现循环依赖时才不会出现无限循环调用的情况。虽然这种模块加载机制可以避免出现循环依赖时报错的情况,但稍不注意就很可能使得代码并不是像我们想象的那样去执行。因此在写代码时还是需要仔细的规划,以保证循环模块的依赖能正确工作
    除了仔细的规划还有什么办法可以避免出现循环依赖吗?一个不太优雅的方法是在循环依赖的每个模块中先写 exports 语句,再写 require 语句,利用 CommonJS 的缓存机制,在 require() 其他模块之前先把自身要导出的内容导出,这样就能保证其他模块在使用时可以取到正确的值

推荐阅读更多精彩内容