详细分析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 相关文章推荐
特殊字符、常规符号及其代码对照表
Jun 26 Javascript
JS如何将UTC格式时间转本地格式
Sep 04 Javascript
js读取注册表的键值示例
Sep 25 Javascript
ff chrome和ie下全局动态定位的异同及全局高度的取法
Jun 30 Javascript
浅析AngularJs HTTP响应拦截器
Dec 28 Javascript
jQuery自定义图片缩放拖拽插件imageQ实现方法(附demo源码下载)
May 27 Javascript
JS模仿腾讯图片站的图片翻页按钮效果完整实例
Jun 21 Javascript
JQuery实现图片轮播效果
May 08 jQuery
Angular4项目中添加i18n国际化插件ngx-translate的步骤详解
Jul 02 Javascript
解决iView中时间控件选择的时间总是少一天的问题
Mar 15 Javascript
JS实现判断图片是否加载完成的方法分析
Jul 31 Javascript
用webpack4开发小程序的实现方法
Jun 04 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
php的4种常见运行方式
2015/03/20 PHP
php根据用户语言跳转相应网页
2015/11/04 PHP
laravel withCount 统计关联数量的方法
2019/10/10 PHP
jQuery LigerUI 使用教程入门篇
2012/01/18 Javascript
js实现背景图片感应鼠标变化的方法
2015/02/28 Javascript
JavaScript的设计模式经典之代理模式
2016/02/24 Javascript
Node.js实用代码段之正确拼接Buffer
2016/03/17 Javascript
js事件处理程序跨浏览器解决方案
2016/03/27 Javascript
微信小程序 image组件binderror使用例子与js中的onerror区别
2017/02/15 Javascript
基于vue实现分页/翻页组件paginator示例
2017/03/09 Javascript
浅谈在fetch方法中添加header后遇到的预检请求问题
2017/08/31 Javascript
jQuery选择器之子元素过滤选择器
2017/09/28 jQuery
Vue CLI 3搭建vue+vuex最全分析(推荐)
2018/09/27 Javascript
angular中子控制器向父控制器传值的实例
2018/10/08 Javascript
17道题让你彻底理解JS中的类型转换
2019/08/08 Javascript
详解ES6数组方法find()、findIndex()的总结
2020/05/12 Javascript
微信小程序实现上传照片代码实例解析
2020/08/04 Javascript
node.js基础知识汇总
2020/08/25 Javascript
[03:10]2014DOTA2 TI马来劲旅Titan首战告捷目标只是8强
2014/07/10 DOTA
[52:10]LGD vs Optic Supermajor小组赛D组胜者组决赛 BO3 第二场 6.3
2018/06/04 DOTA
[00:09]DOTA2全国高校联赛 精彩活动引爆全场
2018/05/30 DOTA
Python itertools模块详解
2015/05/09 Python
在Python的Django框架中更新数据库数据的方法
2015/07/17 Python
python使用tkinter库实现五子棋游戏
2019/06/18 Python
从numpy数组中取出满足条件的元素示例
2019/11/26 Python
Python猜数字算法题详解
2020/03/01 Python
Python Matplotlib简易教程(小白教程)
2020/07/28 Python
基于Django集成CAS实现流程详解
2020/11/28 Python
HTML5实现动画效果的方式汇总
2016/02/29 HTML / CSS
荷兰皇家航空公司官方网站:KLM Royal Dutch Airlines
2017/12/07 全球购物
内科护士节演讲稿
2014/09/11 职场文书
班主任开场白
2015/06/01 职场文书
2016公司中秋节寄语
2015/12/07 职场文书
《金钱的魔力》教学反思
2016/02/20 职场文书
《春酒》教学反思
2016/02/22 职场文书
MySQL表锁、行锁、排它锁及共享锁的使用详解
2022/04/02 MySQL