Node的模块机制

模块机制

CommonJS的模块规范

• 模块引用

var math = require('math')

• 模块定义
  上下文提供了exports对象用于导出当前模块的方法或者变量，并且它是唯一导出的出口，在模块中还存在一个module对象，代表模块自身，而exports是moudule的属性

exports.add = function(){
    var sum = 0 ,
    i = 0,
    args = arguments,
    l = args.length;
    while(i<l>){
        sum += args[i++];
    }
    return sum;
}

• 模块标识
  模块标识其实就是传递给require()方法的参数，它必须是符合小驼峰命名的字符串，或者以.、..开头的相对路径或者绝对路径，可以没有文件名后缀.js

Node的模块实现

在Node中，模块分为两类：

• Node提供的模块，称为核心模块
• 用户编写的模块，称为文件模块

在Node中引入模块，一般需要经历如下三个步骤

• 路径分析
• 文件定位
• 编译执行

核心模块与文件模块在加载上的区别

核心模块部分在Node源代码的编译过程中，编译进了二进制执行文件，在Node进程启动时，部分核心模块被直接加载进内存中，所以忽略文件地位和编译执行这两个步骤，并在路径分析中优先判断，因此加载速度是最快的。

优先从缓存加载
require()方法对相同模块的二次加载都一律采用缓存优先的方式，这是第一优先级的，不同的是处在于核心模块的缓存检查先于文件模块的缓存检查

路径分析和文件定位

• 模块标识符分析
  模块标识符分为以下几类：
  • 核心模块，如http、fs等
  • .或..开始的相对路径文件模块
  • 以/开始的绝对路径文件模块
  • 非路径形式的文件模块

核心模块
优先级仅次于缓存加载，加载过程最快
路径形式的文件模块
都被当作是文件模块来处理，分析文件模块时，require()方法会将路径转为真实路径，并以真实路径作为索引，将编译执行后的结果存放到缓存中。
由于文件模块给Node指明了确切的文件位置，所以节约时间，加载速度慢于核心模块
自定义模块
自定义模块是没有用路径方式指明的文件模块，这类模块查找是最费时的。
它的生成方式与Javascript的原型链或作用链的查找方式十分类似，逐个尝试模块路径中的路径，直到找到目标文件为止。

• 文件定位
  从缓存加载的优化策略使得二次引入时不需要路径分心、文件定位和编译执行的过程。

  • 文件扩展名分析

  不包含文件扩展名——》按.js,.json.node补足扩展名——》需要调用fs模块阻塞地判断文件是否存在——》性能降低
  技巧：如果是.node或.json文件，带上扩展名，会加快一点速度
  - 目录分析和包
  >在分析标识符的过程中，require()通过分析文件扩展名之后，可能没有查找到对应文件，但却得到一个目录。Node会在当前目录下查找package.json，通过JSON.parse()解析出包描述符对象，从中去除main属性指定的文件名进行定位。
  而如果main属性指定的文件名有误，或者压根没有package.json文件，Node会将index当作默认文件名，然后依次查找index.js,index.json,index.node
  如果在目录分析的过程中没有定位成功任何文件，则会抛出查找失败的错误

• 模块编译
  每个文件模块都是一个对象，如下

function Module(id,parent){
    this.id = id;
    this.exports ={};
    this.parent = parent;
    if(parent && parent.children){
        parent.children.push(this);
    }
    this.filename = null;
    this.loaded = false;
    this.children = [];
}

每个编译成功的模块都会将其文件路径作为索引缓存在Module._cache对象上。
Javascript模块的编译
事实上，在编译的过程中，Node对获取的Javascript文件内容进行了头尾包装

(function(exports,require,module,_filename,_dirname){
    var math = require('math');
    exports.area = function(radius){
        return Math.PI*radius*radius;
    };
});

这样每个模块文件之间都进行了作用域隔离，通过vm原生模块的runInThisContext()方法执行，返回一个具体的function对象。最后将当前模块对象的exports属性、require()方法、module(模块对象自身),以及在文件定位中得到的完整文件路径和文件目录作为参数传递给这个function()执行

包与NPM

包结构

完全符合CommonJS规范的宝目录应该包含如下文件：

• package.json：包描述文件
• bin：用于存放可执行二进制文件的目录
• lib：用于存放Javscript代码的目录
• doc：用于存放文档的目录
• test：用于存放单元测试用例的代码

NPM

• 安装依赖包
  • 全局模式安装
    -g 是将一个包安装为全局可用的可执行命令，它根据包描述文件中的bin字段配置，将实际脚本链接到与Node可执行文件相同的路径下。
  • 从本地安装
    本地安装只需为NPM指明package.json文件所在的位置即可，另外本地安装的文件的可执行命令需要到对应的bin文件夹下执行
  • 从非官方源安装
    通过镜像源进行安装，在执行命令是，添加--registry=http://registry.url即可
• NPM钩子命令
  package.json中的scripts字段的提出就是让包在安装或者卸载等过程中提供钩子机制

"script":{
    "preinstall":"preinstall.js",
    "install":"install.js",
    "uninstall":"uninstall.js",
    "test":"test.js"
}

以上内容参考《深入浅出Node.js》一书
CommonsJS、AMD、CMD和ES6模块规范往后再作统一整理和比较