在Node 中引入模块,需要经历三个步骤
- 路径分析
- 文件定位
- 编译执行
在Node中,模块分为两类:一类是Node提供的模块,称为核心模块;一类是用户编写的模块,称为文件模块。
核心模块部分在Node源码的编译过程中,编译进了二进制执行文件。在Node进程启动时,部分核心模块就被直接加载进内存中,所以这部分核心模块引入时,文件定位和编译执行两个步骤可以省略掉,并且在路径分析中优先判断,所以它的加载速度是最快的。
文件模块则是在运行时动态加载,需要完整的路径分析、文件定位、编译执行过程,速度比核心模块慢。
优先从缓存加载
无论是核心模块还是文件模块,require()
方法对相同模块的二次加载都一律采用缓存优先的方式,不同之处在于核心模块的缓存检查优先于文件模块的缓存检查。
路径分析和文件定位
模块标识符分析
require()
方法接受一个标识符作为参数。标识符在Node中主要分为一下几类:
核心模块,例如http、fs、path等
.或..开始的相对路径文件模块
以/开始的绝对路径文件模块
非路径形式的文件模块,例如自定义模块
核心模块
核心模块加载优先级仅次于缓存,它在Node源码编译过程中已经编译为二进制代码,其加载过程最快
路径形式的文件模块
在分析路径模块时,require()
方法会将路径转换为真实的路径,并以真实路径作为索引,将编译执行后的结果放在缓存中,文件模块给Node 指明了确切的文件位置,所以查找过程中可以节约大量时间,其加载速度慢于核心模块
自定义模块
自定义模块指的是非核心模块,也不是路径形式的标识符。它是一种特殊的文件模块,可能是一个文件或者包的形式,这类模块是加载最慢的一种。
*** Node 定位文件模块的查找策略*** 具体表现为一个路径组成的数组。可以手动尝试一下:
在任意目录下执行输入node进入node环境,然后输入module.paths
在mac 下会得到下面一个数组输出
> module.paths
[ '/Users/fanrongrong/repl/node_modules',
'/Users/fanrongrong/node_modules',
'/Users/node_modules',
'/node_modules',
'/Users/fanrongrong/.node_modules',
'/Users/fanrongrong/.node_libraries',
'/Users/fanrongrong/.nvm/versions/node/v8.9.3/lib/node' ]
>
模块路径的生成规则
当前文件目录下的node_modules目录
父目录下的node_modules目录
父目录的父目录下的node_modules目录,沿着路径逐级递归,直到跟目录
mac 会查找用户模块下的.node_modules和.node_libraries 目录,window会查找环境变量$HOME下的这两个目录
node 的安装目录下的node_modules (全局安装的包默认在这里,可以通过npm root -g查看路径)
文件定位
文件扩展名分析
require()
在分析标识符的过程中,允许在标识符中不包含文件扩展名,这种情况下Node会按照.js、.json、.node的次序补足扩展名
目录分析和包
在分析标识符的过程中,require()
通过分析文件扩展名之后,可能没有查找到对应的文件却得到了一个目录,此时Node会将目录当作一个包来处理。
包处理规则:Node在当前目录查找package.json文件,通过JSON.parse()解析出包的描述对象,从中取出main属性指定的文件名进行定位,如果文件名缺少扩展名,会进入扩展名分析步骤,如果main指定的文件名错误,或没有package.json文件,Node会将index当作默认文件名,然后依次查找index.js、index.json、index.node,如果目录分析中没有定位到任何文件,在自定义模块进入下一个模块的路径分析,如果模块的路径数组都遍历完依然没有找的目标文件,则会抛出查找失败的异常。
模块编译
去看源码
Node会新建一个模块对象,然后根据路径载入并编译,对于不同的文件扩展名,载入的方式也不同。
- .js 文件。通过fs模块同步读取文件后编译执行
- .node 文件。这是用c++编写的扩展文件,通过
dlopen()
方法加载最后编译生成的文件 - .json文件。通过fs模块同步读取文件后,用
JSON.parse()
解析返回结果 - 其余文件均当作js文件引入
每一个编译成功的模块都会将其文件路径作为索引缓存在Module._cache对象上。
其中,Module._extensions 会被赋值给require()
的extensions
属性。通过console(require.extensions)
可以查看已有的加载方式;
JavaScript模块的编译
在编译过程中,Node对获取的JavaScript 文件内容进行包装,如下:
(function (exports, require, module, __filename, __dirname) {
var math = require('math')
exports.area = function () {
return Math.PI * radius * radius2
}
})
包与NPM
包结构
- package.json: 包描述文件
- bin : 存放可执行二进制文件目录
- lib: 存放JavaScript 代码的目录
包描述文件
- main 模块引入方法require方法会优先检查这个字段,并将它入口,如果不存在就查找index.js、index.node、index.json
- bin 配置好bin 字段当npm install 包名 -g 时可以将脚本添加到执行路径中
安装依赖包
全局安装模式
- 根据bin字段的配置,将实际的脚本链接到与node 可执行文件相同的路径下:
"bin": {
"express": "./bin/express"
}
通过全局安装的模块都会被安装到一个统一目录下,一搬都是node的安装目录下的lib/node_modules 下
node的包引用
node commonjs 规范引用包方式
node 在8.0版之前都是遵循commenjs 规范进行的包引用(exports/module.exprots, require)
exports是module.exports 的一个引用,所以导出时可以使用exports.xxxx = xxx 的方式,而不能使用exports = xxxx的方式,可以使用module.exports = xxx的方式
这种方式是运行时加载,换句话说是在 NodeJS 脚本执行时才加载进来
node 8.0 之后加入ES方式的引用包方式(import, export)
使用ES方式需要在启动node时加入参数 --experimental-modules
这种方式引用是在静态分析时候就确定了引用关系,就像目标模块建立了一个符号链接,或者说建立了一个指针。这种加载方式加载效率应该略高于 CommonJS。
例子:
// a.js
var n = 3;
exports.n = 3
exports.add = () => {
n++;
}
// b.js
var mod = require('./a.js');
console.log(mod.n);
mod.add();
console.log(mod.n);
// a.mjs
export let n = 3;
export let add = () => {
n++;
}
// b.mjs
import {
n,
add
} from './a.mjs'
console.log(n);
add();
console.log(n);