Node.js中require的工作原理浅析


Posted in Javascript onJune 24, 2014

几乎所有的Node.js开发人员可以告诉你`require()`函数做什么,但我们又有多少人真正知道它是如何工作的?我们每天都使用它来加载库和模块,但它的行为,对于我们来说反而是一个谜。

出于好奇,我钻研了node的核心代码来找出在引擎下发生了什么事。但这并不是一个单一的功能,我在node的模块系统的找到了module.js。该文件包含一个令人惊讶的强大的且相对陌生的核心模块,控制每个文件的加载,编译和缓存。`require()`,它的横空出世,只是冰山的一角。

module.js

function Module(id, parent) {

  this.id = id;

  this.exports = {};

  this.parent = parent;

  // ...

在module.js在Node.js内部主要承担两个角色。首先,它为所有的Node.js模块提供了一个基础。每个文件是基本模块new出的一个新实例,即使在该文件已经运行之后,仍然存在。这就是为什么我们能够性为module.exports附加属并在需要时返回它们。

该模块的第二大任务是处理node的模块加载机制。我们使用的独立操作的“require”函数实际上是一个抽象概念的module.require,这本身就是只是一个简单的关于Module._load功能的封装。此load方法处理每个文件的实际加载,并在那里开始我们的旅程。

Module._load

Module._load = function(request, parent, isMain) {

  // 1. Check Module._cache for the cached module. 

  // 2. Create a new Module instance if cache is empty.

  // 3. Save it to the cache.

  // 4. Call module.load() with your the given filename.

  //    This will call module.compile() after reading the file contents.

  // 5. If there was an error loading/parsing the file, 

  //    delete the bad module from the cache

  // 6. return module.exports

};

Module._load负责加载新的模块和管理模块的缓存。缓存加载的每个模块减少冗余文件的读取次数,并可以显著地加快您应用程序的速度。此外,共享模块实例允许单例特性的模块,保持在项目中的状态。

如果某个模块没有在缓存中存在,Module._load将创建该文件的一个新的基本模块。然后,它会告诉模块在将它们发送到module._compile之前阅读新文件的内容。[1]

如果您注意到上面的步骤#6,你会看到module.exports已被返回给用户。这就是为什么当你在定义公共接口使用时,你使用exports和module.exports,因为Module._load将接下来返回require的内容。我很惊讶,这里没有更多的功能,但如果有的话那更好。

module._compile

Module.prototype._compile = function(content, filename) {

  // 1. Create the standalone require function that calls module.require.

  // 2. Attach other helper methods to require.

  // 3. Wraps the JS code in a function that provides our require,

  //    module, etc. variables locally to the module scope.

  // 4. Run that function

};

· 这是真正的奇迹发生的地方。首先,一个特殊的独立操作的require函数是为该模块创建的。这是我们需要的并且都熟悉的功能。而函数本身只是一个在Module.require的封装,它也包含了一些便于我们使用的鲜为人知的辅助方法:

· require():加载一个外部模块
· require.resolve():解析一个模块名到它的绝对路径
· require.main:主模块
· require.cache:所有缓存好的模块
· ·require.extensions:根据其扩展名,对于每个有效的文件类型可使用的编制方法

一旦require准备好了,整个加载的源代码就会被封装在一个新的函数里,可以接受require,module,exports和所有其他暴露的变量作为参数。这是一个仅仅为封装模块的而创建的函数,以便于在防止与Node.js的环境产生冲突。

(function (exports, require, module, __filename, __dirname) {

  // YOUR CODE INJECTED HERE!

});

该Module._compile方法是同步执行的,所以对Module._load的调用只能等到这段代码运行结束,并将module.exprts返回给用户。

结论

因此,我们已经了解了require的全部代码,并已经初步了解它是如何工作的。

如果你已经按照这一切的方式做了,那么你已经为最后的秘密做好准备:require('module')。这是正确的,该模块系统本身可以通过模块系统被加载。盗梦空间。这可能听起来很奇怪,但它可以让用户空间同模块加载系统互动起来,并不需要钻研Node.js核心。受欢迎的模块都像这样被建立。[2]

如果您想了解更多,请自己查看module.js源代码。还有很多东西足够你头痛一段时间了。第一个可以告诉我什么是NODE_MODULE_CONTEXTS“以及它为什么被添加的人可以得到加分奖励 :)

[1] module._compile方法只用于运行JavaScript文件。 JSON文件需通过JSON.parse() 解析并返回

[2]然而,这两个模块都建立在私有模块的方法,如Module._resolveLookupPaths和Module._findPath。你可以认为这并没有好多了...

Javascript 相关文章推荐
js设置cookie过期及清除浏览器对应名称的cookie
Oct 24 Javascript
javascript遍历控件实例详细解析
Jan 10 Javascript
浅谈javascript对象模型和function对象
Dec 26 Javascript
Bootstrap每天必学之轮播(Carousel)插件
Apr 25 Javascript
xmlplus组件设计系列之文本框(TextBox)(3)
May 03 Javascript
JS实现新建文件夹功能
Jun 17 Javascript
Vue工程模板文件 webpack打包配置方法
Dec 26 Javascript
3种vue路由传参的基本模式
Feb 22 Javascript
JS与CSS3实现图片响应鼠标移动放大效果示例
May 04 Javascript
简单了解小程序+node梳理登陆流程
Jun 24 Javascript
JS实现纵向轮播图(初级版)
Jan 18 Javascript
Vue项目配置跨域访问和代理proxy设置方式
Sep 08 Javascript
angularjs实现与服务器交互分享
Jun 24 #Javascript
完美兼容各大浏览器获取HTTP_REFERER方法总结
Jun 24 #Javascript
Javascript学习笔记之 函数篇(二) : this 的工作机制
Jun 24 #Javascript
Javascript学习笔记之 函数篇(一) : 函数声明和函数表达式
Jun 24 #Javascript
Javascript学习笔记之 对象篇(四) : for in 循环
Jun 24 #Javascript
Javascript学习笔记之 对象篇(三) : hasOwnProperty
Jun 24 #Javascript
js实现div闪烁原理及实现代码
Jun 24 #Javascript
You might like
php 将bmp图片转为jpg等其他任意格式的图片
2009/06/21 PHP
PHP实现抓取Google IP并自动修改hosts文件
2015/02/12 PHP
详解php的socket通信
2015/08/11 PHP
JavaScript实现打字效果的方法
2015/07/10 Javascript
javascript记住用户名和登录密码(两种方式)
2015/08/04 Javascript
使用jQuery ajaxupload插件实现无刷新上传文件
2017/04/23 jQuery
react-native 圆弧拖动进度条实现的示例代码
2018/04/12 Javascript
详解关于vue-area-linkage走过的坑
2018/06/27 Javascript
vue结合axios与后端进行ajax交互的方法
2018/07/06 Javascript
js自定义input文件上传样式
2018/10/26 Javascript
JS/HTML5游戏常用算法之碰撞检测 像素检测算法实例详解
2018/12/12 Javascript
JS基于ES6新特性async await进行异步处理操作示例
2019/02/02 Javascript
微信小程序错误this.setData报错及解决过程
2019/09/18 Javascript
layui 解决form表单点击无反应的问题
2019/10/25 Javascript
vue简单封装axios插件和接口的统一管理操作示例
2020/02/02 Javascript
jQuery开发仿QQ版音乐播放器
2020/07/10 jQuery
js通过canvas生成图片缩略图
2020/10/02 Javascript
TF-IDF与余弦相似性的应用(二) 找出相似文章
2017/12/21 Python
Python 实现字符串中指定位置插入一个字符
2018/05/02 Python
Python计算一个给定时间点前一个月和后一个月第一天的方法
2018/05/29 Python
简单了解python的内存管理机制
2019/07/08 Python
python 计算两个列表的相关系数的实现
2019/08/29 Python
openCV提取图像中的矩形区域
2020/07/21 Python
OSPF有什么优点?为什么OSPF比RIP收敛快?
2013/02/13 面试题
统计员岗位职责
2013/11/14 职场文书
学校办公室主任职责
2013/12/27 职场文书
小学生暑假感言
2014/02/06 职场文书
火锅店营销方案
2014/02/26 职场文书
日化店促销方案
2014/03/26 职场文书
乡镇群众路线教育实践活动整改措施
2014/10/04 职场文书
业务内勤岗位职责
2015/04/13 职场文书
祝寿主持词
2015/07/02 职场文书
《世界多美呀》教学反思
2016/02/22 职场文书
golang 如何用反射reflect操作结构体
2021/04/28 Golang
Pandas数据结构之Series的使用
2022/03/31 Python
了解MySQL查询语句执行过程(5大组件)
2022/08/14 MySQL