nodejs笔记-模块机制

1.为什么要CommonJS规范

javascript存在的缺点

  • 没有模块系统
  • 标准库比较少
  • 没有标准接口
  • 缺乏包管理系统

CommonJS规范的提出,弥补了javascript没有标准的缺陷,以达到像Python、Ruby、Java具备的开发大型应用的基础能力,这样javascript不仅仅能在客户端应用还能开发以下应用:

  • 服务端应用
  • 命令行工具
  • 桌面图形界面应用
  • 混合应用

2.CommonJS的模块规范

1.模块引入

使用require()来引入 ,接受一个模块标识。

let math = require('math');

2.定义模块

上下文提供里exports对象用于导出模块或变量,并且是唯一导出出口。在模块中存在一个module对象,代表模块自身,exports是它的一个属性。在nodejs中一个文件就是一个模块,把方法挂在exports对象上作为属性即可定义导出

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

在另一个文件require使用

const math = require('./math');
let res = math.add(1, 2, 3);
console.log(res)
//6

3.模块标识

模块标识为require()的参数必须是符合小驼峰命名的字符串,或以.、..开头的相对路径,或绝对路径,可以是没有.js后缀的js文件。
模块中定义的全局变量只作用于该文件内部,不污染其他模块。

4.Node模块实现

Node中引入模块需经历以下步骤:

  1. 路径分析
  2. 文件定位
  3. 编译执行

Node中模块分为两类: 1.Node提供的 "核心模块",2.用户编写的 "文件模块"
核心模块Node源码编译时已经编译成二进制执行文件,Node启动时直接加载进内存中,不需要文件定位和编译执行两个步骤,且在路径分析中优先判断,加载速度最快。

1.优先从缓存加载

Node会对引入过的模块进行缓存,核心模块和文件模块相同的模块在二次加载时一律从缓存优先加载(第一优先级),核心模块缓存检测优先于文件模块缓存检测。

2.路径分析文件定位

1.模块标识符分析

标识符分类:

  • 核心模块,如http、fs、path等
  • .或..开始的相对路径文件模块
  • 以/开头的绝对路径模块
  • 非路径形式的文件模块,如自定义的connect模块 一个文件或一个包
2.自定义模块
console.log(module.paths)
//[ 'c:\\Users\\maikuraki\\Desktop\\nodejs\\node_modules',
  'c:\\Users\\maikuraki\\Desktop\\node_modules',
  'c:\\Users\\maikuraki\\node_modules',
  'c:\\Users\\node_modules',
  'c:\\node_modules' ]

Node会逐个路径尝试知道找到目标文件,模块路径越深耗时越多。

3.文件定位

标识符可以不包含文件扩展,这种情况下Node会安装.js、.json、.node次序补全扩展名。
如果是个包Node会检测里面的package.json文件Node通过JOSN.parse()解析出包的描述对象去除main属性指向的文件进行定位,如果没有该属性默认查找index.js、index.json、index.node。

3.模块编译

在Node中每个文件模块都是一个对象。
编译和执行是引入文件模块的最后一个阶段,定位到一个文件后,Node会新建一个模块对象,然后根据路径载入并编译。不同扩展名载入方式:

  • .js 通过fs模块读取后编译执行
  • .node 这是C/C++编写的扩展文件,通过dlopen()方法加载最后编译生成文件
  • .json 通过fs模块读取文件使用JSON.parse()解析并返回
  • 其他扩展名文件 当做.js文件载入
1.javascript模块的编译

在编译过程中Node对获取的javascript文件进行的头尾包装

(function(exports, require, module, __filename, __dirname) {
    exports.add = (x, y) => {
        return x + y;
    }
})

这样每个模块文件直接都进行了作用域隔离,这就是Node对CommonJS规范的实现。

2.C/C++模块编译

Node调用process.dlopen()来进行加载执行,windows和*nix平台下dlopen()通过不同方式实现,通过libuv兼容层进行封装。

3.JSON文件编译

Node使用fs模块读取json文件内容,使用JSON.parse()得到对象然后给他赋给模块对象的exports属性。

4.核心模块

核心模块分为C/C++编写和javascript编写,C/C++存放在Node项目的src文件下,javascript文件存在lib目录下。
核心模块中有些模块核心部分使用C/C++完成其他使用javascript实现包装导出。由纯C/C++编写的部分称为内建模块,例:buffer、crypto、evals、fs、os等模块部分使用C/C++编写。

依赖层关系: 内建模块(C/C++) ---> 核心模块(javascript)---> 文件模块

核心模块的引入流程
以os原生模块引入为例

NODE_MODULE(node_os,reg_func) ---> get_builtin_module('node_os') ---> process.binding('os') ---> NativeModule.require('os') ---> require('os')

5.C/C++扩展模块

1.扩展模块在不同平台上编译和加载过程

Windows
C/C++源码 ---> VC++ --编译源码--> .dll文件 --生成.node文件--> 加载.dll文件 --dlopen()加载--> 导出给javascript使用
*nix
C/C++源码 ---> g++/gcc --编译源码--> .so文件 --生成.node文件--> 加载.so文件 --dlopen()加载--> 导出给javascript使用

2.编译条件
  • node-gyp工具
  • V8引擎C++库
  • libuv库
  • Node内部库
  • 其他库
3.C/C++扩展模块的加载

require()引入.node文件过程

javascript(require('./hello.node')) ---> 原生模块(process.dlopen('./hello.node',exports)) ---> libuv(uv_dlopen()/uv_dlsym()) ---> [{*nix: dlopen()/dlsym(), Windows : loadLibraryExW()/GetProcAddress()}]

6.包与NPM

包结构:

  • package.json 包描述文件
  • bin 存放可执行位二进制文件
  • lib 存放javascript文件
  • doc 存放文档
  • test 存放单元测试

7.前后端公用模块

1.AMD规范

AMD规范是CommonJS规范的一个延伸,定义模块方法:

define(id?, dependencies?, factory);

define(function() {
    let exports = {};
    exports.sayHello = () => {
        console.log(`hello form module: ${module.id}`);
    }
    return exports;
})
2.CMD规范

CMD与AMD规范的主要区别在于定义模块和依赖引入的部分。AMD需要在声明的时候指定所有依赖,通过形参传递依赖到模块中:

define(['dep1', 'dep2'], function() {
    return function() {}
})

于AMD规范相比,CMD模块更接近与Node对CommonJS规范的定义:

define(factory);

在依赖部分,CMD支持动态引入:

define(function(require, exports, module) {
    // module code
})

require,exports,module通过形参传递给模块,在需要依赖模块时随时调用require()引入。

兼容多种模块规范

((name, definition) => {
    //检测是否为AMD或者CMD
    let hasDefine = typeof define === 'function',
        //检测是否为Node
        hasExports = typeof module !== 'undefined' && 'module.exports';
    if(hasDefine) {
        //AMD或CMD环境
        define(definition);
    }else if(hasExports) {
        //定义为普通Node模块
        module.exports = definition();
    }else {
        //将模块执行结果挂载在window对象下
        this[name] = definition;
    }
})('hello', function() {
    let hello = () => {};
    return helllo;
})
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,362评论 5 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,330评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,247评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,560评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,580评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,569评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,929评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,587评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,840评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,596评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,678评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,366评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,945评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,929评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,165评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,271评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,403评论 2 342

推荐阅读更多精彩内容