commonJS详解

commonJS概述

全部代码都运行在模块做用域，不会污染全局做用域。
模块能够屡次加载，可是只会在第一次加载时运行一次，而后运行结果就被缓存了，之后再加载，就直接读取缓存结果。要想让模块再次运行，必须清除缓存。
模块加载的顺序，按照其在代码中出现的顺序。

2.module对象

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

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

2.1 module.exports属性

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

2.2 exports变量

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

1	var exports = module.exports;（commonJS隐式作了这个赋值）

这样作的好处是，在对外输出模块接口时，能够向exports对象添加方法暴露出去。
所以若是改变了module.exports，但还想使用export.xxx的方式暴露一些东西，那就只好咱们本身来写exports = module.exports;
栗：

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

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

CommonJS规范加载模块是同步的，只有加载完成，才能执行后面的操做。AMD规范则是非同步加载模块，容许指定回调函数。因为Node.js主要用于服务器编程，模块文件通常都已经存在于本地硬盘，因此加载起来比较快，不用考虑非同步加载的方式，因此CommonJS规范比较适用。可是，若是是浏览器环境，要从服务器端加载模块，这时就必须采用非同步模式，所以浏览器端通常采用AMD规范。

1 2 3 4 5

define(['package/lib'], function(lib){  function foo(){     lib.log('hello world!');   }  return {    foo: foo   }; });

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

1 2 3 4 5 6 7 8

define(function (require, exports, module){  var someModule = require("someModule");  var anotherModule = require("anotherModule");   someModule.doTehAwesome();   anotherModule.doMoarAwesome();   exports.asplode = function (){     someModule.doTehAwesome();     anotherModule.doMoarAwesome();   }; });

4.require命令

4.1基本用法

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

1 2 3 4 5

// example.jsvar invisible = function () {  console.log("invisible"); } exports.message = "hi"; exports.say = function () {  console.log(message); }

运行下面的命令，能够输出exports对象。

1	//someelse.jsvar example = require('./example.js');console.log(example);// {//   message: "hi",//   say: [Function]// }

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

1 2	//example2.jsmodule.exports = function () {  console.log("hello world") }require('./example2.js')()

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

4.2加载规则

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

1	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会依次搜索如下文件。

1 2 3 4 5

/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字段。下面是一个例子。

1 2	// package.json{ "name" : "some-library",  "main" : "./lib/some-library.js" } require发现参数字符串指向一个目录之后，会自动查看该目录的package.json文件，而后加载main字段指定的入口文件。若是package.json文件没有main字段，或者根本就没有package.json文件，则会加载该目录下的index.js文件或index.node文件。

4.4模块的缓存

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

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

上面代码中，连续三次使用require命令，加载同一个模块。第二次加载的时候，为输出的对象添加了一个message属性。可是第三次加载的时候，这个message属性依然存在，这就证实require命令并无从新加载模块文件，而是输出了缓存。
若是想要屡次执行某个模块，可让该模块输出一个函数，而后每次require这个模块的时候，从新执行一下输出的函数。
全部缓存的模块保存在require.cache之中，若是想删除模块的缓存，能够像下面这样写。

1 2	// 删除指定模块的缓存delete require.cache[moduleName];// 删除全部模块的缓存Object.keys(require.cache).forEach(function(key) {  delete require.cache[key]; })

注意，缓存是根据绝对路径识别模块的，若是一样的模块名，可是保存在不一样的路径，require命令仍是会从新加载该模块。

4.5环境变量NODE_PATH

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

1 2	能够将NODE_PATH添加到.bashrc。 export NODE_PATH="/usr/local/lib/node"

因此，若是遇到复杂的相对路径，好比下面这样：

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

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

1 2	{  "name": "node_path",  "version": "1.0.0",  "description": "",  "main": "index.js",  "scripts": {    "start": "NODE_PATH=lib node index.js"   },  "author": "",  "license": "ISC"}

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

4.6模块的循环加载

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

1 2 3

// a.jsexports.x = 'a1';console.log('a.js ', require('./b.js').x); exports.x = 'a2';// b.jsexports.x = 'b1';console.log('b.js ', require('./a.js').x); exports.x = 'b2';// main.jsconsole.log('main.js ', require('./a.js').x);console.log('main.js ', require('./b.js').x);

上面代码是三个JavaScript文件。其中，a.js加载了b.js，而b.js又加载a.js。这时，Node返回a.js的不完整版本，因此执行结果以下。(也就是说，虽然这样去require看似会形成a.js和b.js循环引用，但commonJS会在将循环的点剪断循环，并对剪断处所在的a.js终止执行，b获得了第一个x值。)

1 2 3 4 5

$ node main.js b.js  a1 a.js  b2 main.js  a2 main.js  b2

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

1	// main.jsconsole.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 6 7

$ node main.js b.js  a1 a.js  b2 main.js  a2 main.js  b2 main.js  a2 main.js  b2

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

4.7 require.main

require方法有一个main属性，能够用来判断模块是直接执行，仍是被调用执行。
直接执行的时候（node module.js），require.main属性指向模块自己。

1	require.main === module// true

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