Node學(xué)習(xí)之路:require()工作原理

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

post header image

介紹

掌握的基本知識(shí)

進(jìn)階

高級(jí)

幾乎所有的Node.js開(kāi)發(fā)者都可以說(shuō)出require()的作用,但是又有多少人真正知道require()是如何工作的呢深员。我們幾乎每天都會(huì)使用它去加載庫(kù)和模塊降淮,但是它的原理還是一個(gè)謎。

因?yàn)楹闷妫也榭戳薔ode的核心源碼去尋找答案钻注。但是我不是找到了一個(gè)函數(shù)片仿,而是找到了Node的核心模塊:module.js。這個(gè)文件驚人的強(qiáng)大陆淀,它包含了文件的加載考余,編譯,并且可以緩存所有使用過(guò)的文件轧苫。對(duì)外使用的require()只是冰山一角楚堤。

module.js

function Module(id, parent) {
  this.id = id;
  this.exports = {};
  this.parent = parent;
  // ...

module.js里的模塊類型在Node.js中有兩個(gè)主要的作用。第一含懊,它為所有的Node.js模塊提供了一個(gè)函數(shù)用于編譯身冬。每一個(gè)文件在這個(gè)基礎(chǔ)模塊中運(yùn)行后都會(huì)返回一個(gè)新的實(shí)例,即使這個(gè)文件運(yùn)行了也還是會(huì)存在岔乔。這就是為什么我們可以隨時(shí)使用 module.exports并且可以返回它酥筝。

這個(gè)模塊的第二個(gè)主要的作用就是管理Node模塊加載機(jī)制。這個(gè)獨(dú)立的require函數(shù)其實(shí)是module.require的一個(gè)引用雏门,而module.require只是一個(gè)把Module._load簡(jiǎn)單包裹了一下(wapper)嘿歌。這個(gè)函數(shù)才是真正控制文件的加載的,接下來(lái)我們通過(guò)這個(gè)函數(shù)繼續(xù)我們的探索剿配。

Module._load

Module._load = function(request, parent, isMain) {
  // 1\. 檢查 Module._cache 是否有緩存
  // 2\. 如果沒(méi)有緩存則創(chuàng)建一個(gè)新的模塊實(shí)例
  // 3\. 將模塊實(shí)例保存到緩存中
  // 4\. 通過(guò)給予的filename去調(diào)用module.load()搅幅,然后調(diào)用module.compile()去讀取文件內(nèi)容
  // 5\. 如果文件的載入和解析過(guò)程中發(fā)生錯(cuò)誤,刪除緩存中的該模塊
  // 6\. 返回 module.exports
};

Module._load是一個(gè)負(fù)責(zé)新模塊的加載和管理模塊緩存的函數(shù)呼胚。緩存所有加載過(guò)的模塊可以減少文件的重復(fù)加載并且明顯地加快你的應(yīng)用茄唐。此外,共享模塊的實(shí)例可以把模塊像單例來(lái)使用,可以在整個(gè)項(xiàng)目的運(yùn)行中都可以保存它的狀態(tài)沪编。

如果一個(gè)模塊不存在在緩存中呼盆,Module._load 會(huì)為這個(gè)文件創(chuàng)建一個(gè)新的基礎(chǔ)模塊。Module._load會(huì)通知模塊去讀取新的文件的內(nèi)容蚁廓,然后把內(nèi)容送到module._compile访圃。[1]

如果你看了上面的#6,那么你就會(huì)看到module.exports會(huì)被返回給用戶相嵌。這就是為什么你可以通過(guò)exportsmodule.exports創(chuàng)建一個(gè)對(duì)外的公共接口腿时,而這些就是Module._load做的事情,然后通過(guò)require返回出去饭宾。我很驚訝于除此之外沒(méi)有其他的神奇的地方了批糟,但是沒(méi)有什么比它更加簡(jiǎn)潔更加好的了。

module._compile

Module.prototype._compile = function(content, filename) {
  // 1\. 創(chuàng)建一個(gè)獨(dú)立的require函數(shù)看铆,該函數(shù)可以調(diào)用module.require徽鼎。
  // 2\. 給require加上其他幫助性的函數(shù)Attach other helper methods to require.
  // 3\. 將代碼包裹在一個(gè)函數(shù)中,并提供了require弹惦,module等變量在模塊作用域中否淤。
  // 4\. 運(yùn)行這個(gè)函數(shù)
};

這里就是見(jiàn)證奇跡的地方。第一棠隐,一個(gè)特殊的單獨(dú)的require函數(shù)被創(chuàng)造用于這個(gè)模塊石抡。這個(gè)require函數(shù)就是我們最熟悉的那個(gè)函數(shù)。這個(gè)函數(shù)只是把 Module.require包裹了一下助泽,它也包含了一些鮮為人知的幫助性的屬性和方法供我們使用:

  • require(): 加載一個(gè)外部模塊

  • require.resolve(): 通過(guò)解析一個(gè)模塊絕對(duì)路徑來(lái)生成模塊的name

  • require.main: 主要模塊

  • require.cache: 所有模塊的緩存

  • require.extensions: 每一個(gè)有效文件的編譯函數(shù)都是基于這個(gè)來(lái)做擴(kuò)展

一旦require完成了汁雷,整個(gè)加載好的源碼會(huì)被包裹在一個(gè)新的函數(shù)里面,同時(shí)傳入require, module, exports和其對(duì)外的變量作為新函數(shù)的參數(shù)报咳。這樣就創(chuàng)造了一個(gè)新的函數(shù)作用域,這樣可以避免污染Node的全局環(huán)境挖藏。

(function (exports, require, module, __filename, __dirname) {
  // 你的代碼會(huì)被放在這里
});

最后暑刃,這個(gè)包含了模塊的函數(shù)會(huì)被運(yùn)行。整個(gè)Module._compile方法的執(zhí)行時(shí)同步的膜眠,所以Module._load會(huì)等待Module._compile執(zhí)行完岩臣,然后會(huì)返回module.exports給用戶。

結(jié)論

至此宵膨,我們已經(jīng)看完了require的代碼架谎,通過(guò)這一圈的代碼就創(chuàng)造出了我們一開(kāi)始想要去了解的那個(gè)require 函數(shù)。

如果你了解了上面所有的內(nèi)容辟躏,那么你將會(huì)了解到require('module')最后的秘密谷扣。沒(méi)錯(cuò),就是模塊系統(tǒng)本身也可以通過(guò)模塊系統(tǒng)加載進(jìn)來(lái)的。一開(kāi)始会涎,這個(gè)可能聽(tīng)上去有些奇怪裹匙,但是這樣可以讓用戶不用了解Node.js的核心原理就可以使用加載系統(tǒng)加載自己的模塊。流行的模塊例如mockery and rewire就是這樣構(gòu)建的末秃。

如果你想了解更多的細(xì)節(jié)概页,你可以瀏覽module.js源碼。你會(huì)得到更多的信息也會(huì)了解的更多练慕,我將會(huì)給第一個(gè)回答出什么是‘NODE_MODULE_CONTEXTS’并且為什么要加上這個(gè)的人加分惰匙。


[1] module._compile函數(shù)只是用于運(yùn)行JavaScript文件。JSON文件會(huì)簡(jiǎn)單地通過(guò) JSON.parse()解析然后返回铃将。

[2] 當(dāng)然這些模塊都是由一些私有的函數(shù)方法構(gòu)建的项鬼,例如Module._resolveLookupPaths and Module._findPath。你可以想一想是否可以有更好的辦法...

請(qǐng)開(kāi)啟你的Javascript然后瀏覽 comments powered by Disqus.

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末麸塞,一起剝皮案震驚了整個(gè)濱河市秃臣,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌哪工,老刑警劉巖奥此,帶你破解...
    沈念sama閱讀 216,372評(píng)論 6 498
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異雁比,居然都是意外死亡稚虎,警方通過(guò)查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,368評(píng)論 3 392
  • 文/潘曉璐 我一進(jìn)店門(mén)偎捎,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)蠢终,“玉大人,你說(shuō)我怎么就攤上這事茴她⊙胺鳎” “怎么了?”我有些...
    開(kāi)封第一講書(shū)人閱讀 162,415評(píng)論 0 353
  • 文/不壞的土叔 我叫張陵丈牢,是天一觀的道長(zhǎng)祭钉。 經(jīng)常有香客問(wèn)我,道長(zhǎng)己沛,這世上最難降的妖魔是什么慌核? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 58,157評(píng)論 1 292
  • 正文 為了忘掉前任,我火速辦了婚禮申尼,結(jié)果婚禮上垮卓,老公的妹妹穿的比我還像新娘。我一直安慰自己师幕,他們只是感情好粟按,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,171評(píng)論 6 388
  • 文/花漫 我一把揭開(kāi)白布。 她就那樣靜靜地躺著,像睡著了一般钾怔。 火紅的嫁衣襯著肌膚如雪碱呼。 梳的紋絲不亂的頭發(fā)上,一...
    開(kāi)封第一講書(shū)人閱讀 51,125評(píng)論 1 297
  • 那天宗侦,我揣著相機(jī)與錄音愚臀,去河邊找鬼。 笑死矾利,一個(gè)胖子當(dāng)著我的面吹牛姑裂,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播男旗,決...
    沈念sama閱讀 40,028評(píng)論 3 417
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼舶斧,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了察皇?” 一聲冷哼從身側(cè)響起茴厉,我...
    開(kāi)封第一講書(shū)人閱讀 38,887評(píng)論 0 274
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎什荣,沒(méi)想到半個(gè)月后矾缓,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,310評(píng)論 1 310
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡稻爬,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,533評(píng)論 2 332
  • 正文 我和宋清朗相戀三年嗜闻,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片桅锄。...
    茶點(diǎn)故事閱讀 39,690評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡琉雳,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出友瘤,到底是詐尸還是另有隱情翠肘,我是刑警寧澤,帶...
    沈念sama閱讀 35,411評(píng)論 5 343
  • 正文 年R本政府宣布辫秧,位于F島的核電站锯茄,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏茶没。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,004評(píng)論 3 325
  • 文/蒙蒙 一晚碾、第九天 我趴在偏房一處隱蔽的房頂上張望抓半。 院中可真熱鬧,春花似錦格嘁、人聲如沸笛求。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 31,659評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)探入。三九已至狡孔,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間蜂嗽,已是汗流浹背苗膝。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 32,812評(píng)論 1 268
  • 我被黑心中介騙來(lái)泰國(guó)打工, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留植旧,地道東北人辱揭。 一個(gè)月前我還...
    沈念sama閱讀 47,693評(píng)論 2 368
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像病附,于是被迫代替她去往敵國(guó)和親问窃。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,577評(píng)論 2 353

推薦閱讀更多精彩內(nèi)容

  • Node.js是目前非惩昊Γ火熱的技術(shù)域庇,但是它的誕生經(jīng)歷卻很奇特。 眾所周知覆积,在Netscape設(shè)計(jì)出JavaScri...
    w_zhuan閱讀 3,613評(píng)論 2 41
  • Node.js是目前非程螅火熱的技術(shù),但是它的誕生經(jīng)歷卻很奇特技健。 眾所周知写穴,在Netscape設(shè)計(jì)出JavaScri...
    Myselfyan閱讀 4,071評(píng)論 2 58
  • 1 Node.js模塊的實(shí)現(xiàn) 之前在網(wǎng)上查閱了許多介紹Node.js的文章,可惜對(duì)于Node.js的模塊機(jī)制大都著...
    zlx_2017閱讀 1,241評(píng)論 0 1
  • topics: 1.The Node.js philosophy 2.The reactor pattern 3....
    宮若石閱讀 1,078評(píng)論 0 1
  • 1 Node.js模塊的實(shí)現(xiàn)# 之前在網(wǎng)上查閱了許多介紹Node.js的文章,可惜對(duì)于Node.js的模塊機(jī)制大都...
    七寸知架構(gòu)閱讀 2,058評(píng)論 1 50