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 相关文章推荐
跟着Jquery API学Jquery之一 选择器
Apr 07 Javascript
ExtJs事件机制基本代码模型和流程解析
Oct 24 Javascript
struts2+jquery+json实现异步加载数据(自写)
Jun 24 Javascript
Javascript 命名空间模式
Nov 01 Javascript
Javascript基础教程之if条件语句
Jan 18 Javascript
jqueryMobile 动态添加元素,展示刷新视图的实现方法
May 28 Javascript
jquery插件treegrid树状表格的使用方法详解(.Net平台)
Jan 03 Javascript
angular实现商品筛选功能
Feb 01 Javascript
Vue.js中用webpack合并打包多个组件并实现按需加载
Feb 17 Javascript
小程序云函数调用API接口的方法
May 17 Javascript
中高级前端必须了解的JS中的内存管理(推荐)
Jul 04 Javascript
手把手教你实现 Promise的使用方法
Sep 02 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引用地址改变变量值的问题
2012/03/23 PHP
PHP正则表达式之定界符和原子介绍
2012/10/05 PHP
ThinkPHP实现将SESSION存入MYSQL的方法
2014/07/22 PHP
php中使用array_filter()函数过滤空数组的实现代码
2014/08/19 PHP
PHP符合PSR编程规范的实例分享
2016/12/21 PHP
js 操作css实现代码
2009/06/11 Javascript
js操作IE浏览器弹出浏览文件夹可以返回目录路径
2014/07/14 Javascript
javascript实现的右下角弹窗实例
2015/04/24 Javascript
谈谈Jquery ajax中success和complete有哪些不同点
2015/11/20 Javascript
详解JavaScript UTC时间转换方法
2016/01/07 Javascript
javascript的document中的动态添加标签实现方法
2016/10/24 Javascript
详解vue axios中文文档
2017/09/12 Javascript
微信小程序表单弹窗实例
2018/07/19 Javascript
IntelliJ IDEA编辑器配置vue高亮显示
2019/09/26 Javascript
JavaScript实现背景自动切换小案例
2019/09/27 Javascript
elementui更改el-dialog关闭按钮的图标d的示例代码
2020/08/04 Javascript
Python实现统计英文单词个数及字符串分割代码
2015/05/28 Python
分享Python字符串关键点
2015/12/13 Python
Python3使用requests发闪存的方法
2016/05/11 Python
numpy中的ndarray方法和属性详解
2019/05/27 Python
Django  ORM 练习题及答案
2019/07/19 Python
解析python的局部变量和全局变量
2019/08/15 Python
Python any()函数的使用方法
2019/10/28 Python
CSS3实现跳动的动画效果
2016/09/12 HTML / CSS
CSS3动画效果回调处理详解
2014/12/10 HTML / CSS
Html5页面中的返回实现的方法
2018/02/26 HTML / CSS
HTML5中的websocket实现直播功能
2018/05/21 HTML / CSS
美国最大的网上冲印店:Shutterfly
2017/01/01 全球购物
少儿节目主持串词
2014/04/02 职场文书
机关干部三严三实心得体会
2014/10/13 职场文书
2015年安康杯竞赛活动总结
2015/03/26 职场文书
卡特教练观后感
2015/06/08 职场文书
幼儿教师继续教育培训心得体会
2016/01/19 职场文书
阿里云服务器搭建Php+Apache运行环境的详细过程
2021/05/15 PHP
解决Mysql报错 Table 'mysql.user' doesn't exist
2022/05/06 MySQL
html用代码制作虚线框怎么做? dw制作虚线圆圈的技巧
2022/12/24 HTML / CSS