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 相关文章推荐
javascript 支持链式调用的异步调用框架Async.Operation
Aug 04 Javascript
IE 下的只读 innerHTML
Aug 21 Javascript
$.ajax返回的JSON无法执行success的解决方法
Sep 09 Javascript
在javascript中关于节点内容加强
Apr 11 Javascript
js自动查找select下拉的菜单并选择(示例代码)
Feb 26 Javascript
温习Javascript基础语法之词法结构
May 31 Javascript
AngularJS基于MVC的复杂操作实例讲解
Dec 31 Javascript
浅谈Javascript常用正则表达式应用
Mar 08 Javascript
如何为你的JavaScript代码日志着色详解
Apr 08 Javascript
基于JS开发微信网页录音功能的实例代码
Apr 30 Javascript
vue 路由守卫(导航守卫)及其具体使用
Feb 25 Javascript
javascript开发实现贪吃蛇游戏
Jul 31 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
Discuz!5的PHP代码高亮显示插件(黑暗中的舞者更新)
2007/01/29 PHP
php下通过伪造http头破解防盗链的代码
2010/07/03 PHP
Discuz Uchome ajaxpost小技巧
2011/01/04 PHP
php array_filter除去数组中的空字符元素
2020/06/21 PHP
一个简单的网页密码登陆php代码
2012/07/17 PHP
去掉destoon资讯内容页keywords关键字自带的文章标题的方法
2014/08/21 PHP
PHP Streams(流)详细介绍及使用
2015/05/12 PHP
ThinkPHP中html:list标签用法分析
2016/01/09 PHP
php 多进程编程父进程的阻塞与非阻塞实例分析
2020/02/22 PHP
PHP实现简单日历类编写
2020/08/28 PHP
认识延迟时间为0的setTimeout
2008/05/16 Javascript
juqery 学习之三 选择器 子元素与表单
2010/11/25 Javascript
jQuery学习之prop和attr的区别示例介绍
2013/11/15 Javascript
JQuery.get提交页面不跳转的解决方法
2015/01/13 Javascript
浅谈javascript属性onresize
2015/04/20 Javascript
javascript实现英文首字母大写
2015/04/23 Javascript
Jquery使用css方法改变样式实例
2015/05/18 Javascript
javascript高级选择器querySelector和querySelectorAll全面解析
2016/04/07 Javascript
5个最顶级jQuery图表类库插件【jquery插件库】
2016/05/05 Javascript
Node.js用readline模块实现输入输出
2016/12/16 Javascript
jQuery使用ajax方法解析返回的json数据功能示例
2017/01/10 Javascript
有关JS中的0,null,undefined,[],{},'''''''',false之间的关系
2017/02/14 Javascript
nodejs结合socket.io实现websocket通信功能的方法
2018/01/12 NodeJs
微信小程序数据存储与取值详解
2018/01/30 Javascript
vue响应式更新机制及不使用框架实现简单的数据双向绑定问题
2019/06/27 Javascript
原生JavaScript写出Tabs标签页的实例代码
2020/07/20 Javascript
Python 的内置字符串方法小结
2016/03/15 Python
Python使用matplotlib的pie函数绘制饼状图功能示例
2018/01/08 Python
python 一维二维插值实例
2020/04/22 Python
如何转换一个字符串到enum值
2014/04/12 面试题
师德师风自查总结
2014/10/14 职场文书
教育实习指导教师评语
2014/12/31 职场文书
2015年简历自我评价范文
2015/03/11 职场文书
大学生村官入党自传
2015/06/26 职场文书
SQLServer中JSON文档型数据的查询问题解决
2021/06/27 SQL Server
基于Python实现股票收益率分析
2022/04/02 Python