详细分析Node.js 模块系统


Posted in Javascript onJune 28, 2020

为了让Node.js的文件可以相互调用,Node.js提供了一个简单的模块系统。

模块是Node.js 应用程序的基本组成部分,文件和模块是一一对应的。换言之,一个 Node.js 文件就是一个模块,这个文件可能是JavaScript 代码、JSON 或者编译过的C/C++ 扩展。

创建模块

在 Node.js 中,创建一个模块非常简单,如下我们创建一个 main.js 文件,代码如下:

var hello = require('./hello');
hello.world();

以上实例中,代码 require('./hello') 引入了当前目录下的 hello.js 文件(./ 为当前目录,node.js 默认后缀为 js)。

Node.js 提供了 exports 和 require 两个对象,其中 exports 是模块公开的接口,require 用于从外部获取一个模块的接口,即所获取模块的 exports 对象。

接下来我们就来创建 hello.js 文件,代码如下:

exports.world = function() {
 console.log('Hello World');
}

在以上示例中,hello.js 通过 exports 对象把 world 作为模块的访问接口,在 main.js 中通过 require('./hello') 加载这个模块,然后就可以直接访 问 hello.js 中 exports 对象的成员函数了。

有时候我们只是想把一个对象封装到模块中,格式如下:

module.exports = function() {
 // ...
}

例如:

//hello.js 
function Hello() { 
  var name; 
  this.setName = function(thyName) { 
    name = thyName; 
  }; 
  this.sayHello = function() { 
    console.log('Hello ' + name); 
  }; 
}; 
module.exports = Hello;

这样就可以直接获得这个对象了:

//main.js 
var Hello = require('./hello'); 
hello = new Hello(); 
hello.setName('BYVoid'); 
hello.sayHello();

模块接口的唯一变化是使用 module.exports = Hello 代替了exports.world = function(){}。 在外部引用该模块时,其接口对象就是要输出的 Hello 对象本身,而不是原先的 exports。

服务端的模块放在哪里

也许你已经注意到,我们已经在代码中使用了模块了。像这样:

var http = require("http");

...

http.createServer(...);

Node.js 中自带了一个叫做 http 的模块,我们在我们的代码中请求它并把返回值赋给一个本地变量。

这把我们的本地变量变成了一个拥有所有 http 模块所提供的公共方法的对象。

Node.js 的 require 方法中的文件查找策略如下:

由于 Node.js 中存在 4 类模块(原生模块和3种文件模块),尽管 require 方法极其简单,但是内部的加载却是十分复杂的,其加载优先级也各自不同。如下图所示:

详细分析Node.js 模块系统

从文件模块缓存中加载

尽管原生模块与文件模块的优先级不同,但是都会优先从文件模块的缓存中加载已经存在的模块。

从原生模块加载

原生模块的优先级仅次于文件模块缓存的优先级。require 方法在解析文件名之后,优先检查模块是否在原生模块列表中。以http模块为例,尽管在目录下存在一个 http/http.js/http.node/http.json 文件,require("http") 都不会从这些文件中加载,而是从原生模块中加载。

原生模块也有一个缓存区,同样也是优先从缓存区加载。如果缓存区没有被加载过,则调用原生模块的加载方式进行加载和执行。

从文件加载

当文件模块缓存中不存在,而且不是原生模块的时候,Node.js 会解析 require 方法传入的参数,并从文件系统中加载实际的文件,加载过程中的包装和编译细节在前一节中已经介绍过,这里我们将详细描述查找文件模块的过程,其中,也有一些细节值得知晓。

require方法接受以下几种参数的传递:

  • http、fs、path等,原生模块。
  • ./mod或../mod,相对路径的文件模块。
  • /pathtomodule/mod,绝对路径的文件模块。
  • mod,非原生模块的文件模块。

在路径 Y 下执行 require(X) 语句执行顺序:

1. 如果 X 是内置模块
   a. 返回内置模块
   b. 停止执行
2. 如果 X 以 '/' 开头
   a. 设置 Y 为文件根路径
3. 如果 X 以 './' 或 '/' or '../' 开头
   a. LOAD_AS_FILE(Y + X)
   b. LOAD_AS_DIRECTORY(Y + X)
4. LOAD_NODE_MODULES(X, dirname(Y))
5. 抛出异常 "not found"

LOAD_AS_FILE(X)
1. 如果 X 是一个文件, 将 X 作为 JavaScript 文本载入并停止执行。
2. 如果 X.js 是一个文件, 将 X.js 作为 JavaScript 文本载入并停止执行。
3. 如果 X.json 是一个文件, 解析 X.json 为 JavaScript 对象并停止执行。
4. 如果 X.node 是一个文件, 将 X.node 作为二进制插件载入并停止执行。

LOAD_INDEX(X)
1. 如果 X/index.js 是一个文件,  将 X/index.js 作为 JavaScript 文本载入并停止执行。
2. 如果 X/index.json 是一个文件, 解析 X/index.json 为 JavaScript 对象并停止执行。
3. 如果 X/index.node 是一个文件,  将 X/index.node 作为二进制插件载入并停止执行。

LOAD_AS_DIRECTORY(X)
1. 如果 X/package.json 是一个文件,
   a. 解析 X/package.json, 并查找 "main" 字段。
   b. let M = X + (json main 字段)
   c. LOAD_AS_FILE(M)
   d. LOAD_INDEX(M)
2. LOAD_INDEX(X)

LOAD_NODE_MODULES(X, START)
1. let DIRS=NODE_MODULES_PATHS(START)
2. for each DIR in DIRS:
   a. LOAD_AS_FILE(DIR/X)
   b. LOAD_AS_DIRECTORY(DIR/X)

NODE_MODULES_PATHS(START)
1. let PARTS = path split(START)
2. let I = count of PARTS - 1
3. let DIRS = []
4. while I >= 0,
   a. if PARTS[I] = "node_modules" CONTINUE
   b. DIR = path join(PARTS[0 .. I] + "node_modules")
   c. DIRS = DIRS + DIR
   d. let I = I - 1
5. return DIRS

以上就是详细分析Node.js 模块系统的详细内容,更多关于Node.js模块系统的资料请关注三水点靠木其它相关文章!

Javascript 相关文章推荐
jquery清空表单数据示例分享
Feb 13 Javascript
通过js来制作复选框的全选和不选效果
May 22 Javascript
java和javascript获取word文档的书签位置对比
Jun 19 Javascript
node.js中的buffer.slice方法使用说明
Dec 10 Javascript
jquery代码实现多选、不同分享功能
Jul 31 Javascript
jQuery的remove()方法使用详解
Aug 11 Javascript
JavaScript实现解析INI文件内容的方法
Nov 17 Javascript
jQuery封装placeholder效果实现方法,让低版本浏览器支持该效果
Jul 08 jQuery
Android 自定义view仿微信相机单击拍照长按录视频按钮
Jul 19 Javascript
js实现select下拉框选择
Jan 11 Javascript
vue 内联样式style中的background用法说明
Aug 05 Javascript
原生JavaScript实现进度条
Feb 19 Javascript
微信小程序实现拨打电话功能的示例代码
Jun 28 #Javascript
js瀑布流布局的实现
Jun 28 #Javascript
JavaScript如何使用插值实现图像渐变
Jun 28 #Javascript
vue实现登录拦截
Jun 29 #Javascript
Laravel 如何在blade文件中使用Vue组件的示例代码
Jun 28 #Javascript
JavaScript多种图形实现代码实例
Jun 28 #Javascript
从Node.js事件触发器到Vue自定义事件的深入讲解
Jun 26 #Javascript
You might like
fleaphp rolesNameField bug解决方法
2011/04/23 PHP
php实现文件下载(支持中文文名)
2013/12/04 PHP
ThinkPHP通过AJAX返回JSON的两种实现方法
2014/12/18 PHP
CodeIgniter常用知识点小结
2016/05/26 PHP
浅谈PHP SHA1withRSA加密生成签名及验签
2019/03/18 PHP
自定义jQuery选项卡插件实例
2013/03/27 Javascript
showModelDialog弹出文件下载窗口的使用示例
2013/11/19 Javascript
JS(JQuery)操作Array的相关方法介绍
2014/02/11 Javascript
jQuery+css3动画属性制作猎豹浏览器宽屏banner焦点图
2015/03/16 Javascript
跟我学习javascript的arguments对象
2015/11/16 Javascript
Sea.JS知识总结
2016/05/05 Javascript
JavaScript实现倒计时跳转页面功能【实用】
2016/12/13 Javascript
详解webpack2+React 实例demo
2017/09/11 Javascript
原生JS上传大文件显示进度条 php上传文件代码
2020/03/27 Javascript
Vue项目中使用Vux的安装过程
2018/05/01 Javascript
使用electron实现百度网盘悬浮窗口功能的示例代码
2018/10/24 Javascript
JavaScript继承与聚合实例详解
2019/01/22 Javascript
基于Vue实现平滑过渡的拖拽排序功能
2019/06/12 Javascript
JS数组方法slice()用法实例分析
2020/01/18 Javascript
JS造成内存泄漏的几种情况实例分析
2020/03/02 Javascript
js实现鼠标拖曳效果
2020/12/30 Javascript
python实现定时同步本机与北京时间的方法
2015/03/24 Python
python实现同时给多个变量赋值的方法
2015/04/30 Python
Python利用带权重随机数解决抽奖和游戏爆装备问题
2016/06/16 Python
解决PyCharm中光标变粗的问题
2017/08/05 Python
[原创]pip和pygal的安装实例教程
2017/12/07 Python
python正则实现计算器功能
2017/12/14 Python
Python3.5常见内置方法参数用法实例详解
2019/04/29 Python
Python3简单爬虫抓取网页图片代码实例
2019/08/26 Python
opencv之颜色过滤只留下图片中的红色区域操作
2020/06/05 Python
商务英语专业毕业生自荐信
2013/11/05 职场文书
模具数控专业自荐信
2014/01/27 职场文书
党员组织关系介绍信
2014/02/13 职场文书
总经理秘书岗位职责
2014/03/17 职场文书
个人批评与自我批评总结
2014/10/17 职场文书
python基础之模块的导入
2021/10/24 Python