Node学习之路:require()工作原理

原文:http://thenodeway.io/posts/how-require-actually-works/

post header image

介绍

掌握的基本知识

进阶

高级

几乎所有的Node.js开发者都可以说出require()的作用,但是又有多少人真正知道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模块提供了一个函数用于编译。每一个文件在这个基础模块中运行后都会返回一个新的实例,即使这个文件运行了也还是会存在。这就是为什么我们可以随时使用 module.exports并且可以返回它。

这个模块的第二个主要的作用就是管理Node模块加载机制。这个独立的require函数其实是module.require的一个引用,而module.require只是一个把Module._load简单包裹了一下(wapper)。这个函数才是真正控制文件的加载的,接下来我们通过这个函数继续我们的探索。

Module._load

Module._load = function(request, parent, isMain) {
  // 1\. 检查 Module._cache 是否有缓存
  // 2\. 如果没有缓存则创建一个新的模块实例
  // 3\. 将模块实例保存到缓存中
  // 4\. 通过给予的filename去调用module.load(),然后调用module.compile()去读取文件内容
  // 5\. 如果文件的载入和解析过程中发生错误,删除缓存中的该模块
  // 6\. 返回 module.exports
};

Module._load是一个负责新模块的加载和管理模块缓存的函数。缓存所有加载过的模块可以减少文件的重复加载并且明显地加快你的应用。此外,共享模块的实例可以把模块像单例来使用,可以在整个项目的运行中都可以保存它的状态。

如果一个模块不存在在缓存中,Module._load 会为这个文件创建一个新的基础模块。Module._load会通知模块去读取新的文件的内容,然后把内容送到module._compile。[1]

如果你看了上面的#6,那么你就会看到module.exports会被返回给用户。这就是为什么你可以通过exportsmodule.exports创建一个对外的公共接口,而这些就是Module._load做的事情,然后通过require返回出去。我很惊讶于除此之外没有其他的神奇的地方了,但是没有什么比它更加简洁更加好的了。

module._compile

Module.prototype._compile = function(content, filename) {
  // 1\. 创建一个独立的require函数,该函数可以调用module.require。
  // 2\. 给require加上其他帮助性的函数Attach other helper methods to require.
  // 3\. 将代码包裹在一个函数中,并提供了require,module等变量在模块作用域中。
  // 4\. 运行这个函数
};

这里就是见证奇迹的地方。第一,一个特殊的单独的require函数被创造用于这个模块。这个require函数就是我们最熟悉的那个函数。这个函数只是把 Module.require包裹了一下,它也包含了一些鲜为人知的帮助性的属性和方法供我们使用:

  • require(): 加载一个外部模块

  • require.resolve(): 通过解析一个模块绝对路径来生成模块的name

  • require.main: 主要模块

  • require.cache: 所有模块的缓存

  • require.extensions: 每一个有效文件的编译函数都是基于这个来做扩展

一旦require完成了,整个加载好的源码会被包裹在一个新的函数里面,同时传入require, module, exports和其对外的变量作为新函数的参数。这样就创造了一个新的函数作用域,这样可以避免污染Node的全局环境。

(function (exports, require, module, __filename, __dirname) {
  // 你的代码会被放在这里
});

最后,这个包含了模块的函数会被运行。整个Module._compile方法的执行时同步的,所以Module._load会等待Module._compile执行完,然后会返回module.exports给用户。

结论

至此,我们已经看完了require的代码,通过这一圈的代码就创造出了我们一开始想要去了解的那个require 函数。

如果你了解了上面所有的内容,那么你将会了解到require('module')最后的秘密。没错,就是模块系统本身也可以通过模块系统加载进来的。一开始,这个可能听上去有些奇怪,但是这样可以让用户不用了解Node.js的核心原理就可以使用加载系统加载自己的模块。流行的模块例如mockery and rewire就是这样构建的。

如果你想了解更多的细节,你可以浏览module.js源码。你会得到更多的信息也会了解的更多,我将会给第一个回答出什么是‘NODE_MODULE_CONTEXTS’并且为什么要加上这个的人加分。


[1] module._compile函数只是用于运行JavaScript文件。JSON文件会简单地通过 JSON.parse()解析然后返回。

[2] 当然这些模块都是由一些私有的函数方法构建的,例如Module._resolveLookupPaths and Module._findPath。你可以想一想是否可以有更好的办法...

请开启你的Javascript然后浏览 comments powered by Disqus.

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 199,440评论 5 467
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 83,814评论 2 376
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 146,427评论 0 330
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,710评论 1 270
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,625评论 5 359
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,014评论 1 275
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,511评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,162评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,311评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,262评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,278评论 1 328
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,989评论 3 316
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,583评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,664评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,904评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,274评论 2 345
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,856评论 2 339

推荐阅读更多精彩内容

  • Node.js是目前非常火热的技术,但是它的诞生经历却很奇特。 众所周知,在Netscape设计出JavaScri...
    w_zhuan阅读 3,605评论 2 41
  • Node.js是目前非常火热的技术,但是它的诞生经历却很奇特。 众所周知,在Netscape设计出JavaScri...
    Myselfyan阅读 4,060评论 2 58
  • 1 Node.js模块的实现 之前在网上查阅了许多介绍Node.js的文章,可惜对于Node.js的模块机制大都着...
    zlx_2017阅读 1,215评论 0 1
  • topics: 1.The Node.js philosophy 2.The reactor pattern 3....
    宫若石阅读 1,046评论 0 1
  • 1 Node.js模块的实现# 之前在网上查阅了许多介绍Node.js的文章,可惜对于Node.js的模块机制大都...
    七寸知架构阅读 2,047评论 1 50