CommonJS规范

Posted 2020-12-14 smellpen

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

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

// example.js
var x = 5
var add = function(value){
    return value + x
}

上面代码中x和add方法是examle.js私有的，其他文件不可见。

如果想在多个文件分享变量，必须定义为global对象的属性

global.warning = true

上门代码warning变量，可以被所有文件读取。但是这样写法并不推荐。

CommonJS规范规定，每个模块内部，module变量代表当前模块。这个变量是一个对象，他的exports属性（module.exports）是对外的接口。在家某个模块，其实是加载该模块的module.exports属性。

var x = 5
var add = function(value){
    return value + x
}
module.exports.x = x
module.exports.add = add

上面代码通过module.exports输出变量x和函数add

 

require方法用于加载模块

var example = require(‘./example.js‘)

console.log(example.x)    // 5
console.log(example.add(1))    // 6

 

CommonJS模块的特点

• 所有代码都运行在模块作用域，不会污染全局作用域
• 模块可以多次加载，但是只会在第一次加载时运行一次，然后运行结果就被缓存了，以后再加载，就直接读取缓存结果。想让模块再次运行，必须清除缓存
• 模块加载顺序，按照其在代码中出现的顺序

 

module对象

Node内部提供一个module构造函数。所有模块都是module的实例

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

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

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

 

module.exports属性

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

 

exports变量

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

var exports = module.exports

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

exports.area = function(r){
    return math.PI * r * r
}

exports.cicumference = function(r){
    return 2 * Math.pi * R
}

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

如果对于exports和module.exports之间区别很那分清，那就直接放弃使用exports，只使用module.exports

 

require命令

基本用法

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

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

 

加载规则

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

var foo = require(‘foo‘)
// 等同于
var foo = require(‘foo.js‘)

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

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

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

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

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

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

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

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

 

目录的加载规则

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

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

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

 

模块的缓存

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

1 require(‘./example.js‘)
2 require(‘./example.js‘).message = ‘hello‘
3 require(‘./example.js‘).message
4 // hello

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

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

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

// 删除指定模块的缓存
delete require.cache[moduleName]

// 删除所有模块缓存
Object.keys(require.cache).forEach(function(key){
    delete require.cache[key]
})

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

 

环境变量NODE_PATH

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

可以将NODE_PATH添加到.bashrc

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

所以遇到复杂的相对路径，比如

var myModule = require(‘../../../../lib/myModule‘);

有两种解决办法。一是将该文件加入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"
}

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

 

模块加载机制

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

// lib.js
var counter = 3
function incCounter() {
    counter++
}
module.exports = {
    counter: counter,
    incCounter:  incCounter
}

上面代码输出内部变量counter和改写这个变量的内部方法incCounter。然后加载上面模块

// main.js
var {counter, incCounter} = require(‘./lib‘)

console.log(counter)    // 3
incCounter()
console.log(counter)    // 3

 

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
}

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

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

上面第一步和第二部，require函数及其辅助方法主要如下

• require()加载外部模块
• require.resolve()将模块名解析到一个绝对路径
• require.main指向主模块
• require.cache指向所有缓存的模块
• require.extensions根据文件的后缀名，调用不同的执行函数

一旦require函数准备完毕，整个所要加载的脚本内容，就被都放在一个新的函数中，这样可以避免污染全局环境。该函数参数包括require、module、exports以及其他一些参数

（function(exports, require, module, __filename, __dirname){

　　// code injected here

}）

 

参考：https://javascript.ruanyifeng.com/nodejs/module.html