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

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

post header image

介紹

掌握的基本知識

進階

高級

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

因為好奇,我查看了Node的核心源碼去尋找答案。但是我不是找到了一個函數(shù),而是找到了Node的核心模塊:module.js。這個文件驚人的強大,它包含了文件的加載,編譯,并且可以緩存所有使用過的文件。對外使用的require()只是冰山一角。

module.js

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

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

這個模塊的第二個主要的作用就是管理Node模塊加載機制。這個獨立的require函數(shù)其實是module.require的一個引用,而module.require只是一個把Module._load簡單包裹了一下(wapper)。這個函數(shù)才是真正控制文件的加載的,接下來我們通過這個函數(shù)繼續(xù)我們的探索。

Module._load

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

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

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

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

module._compile

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

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

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

  • require.resolve(): 通過解析一個模塊絕對路徑來生成模塊的name

  • require.main: 主要模塊

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

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

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

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

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

結(jié)論

至此,我們已經(jīng)看完了require的代碼,通過這一圈的代碼就創(chuàng)造出了我們一開始想要去了解的那個require 函數(shù)。

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

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


[1] module._compile函數(shù)只是用于運行JavaScript文件。JSON文件會簡單地通過 JSON.parse()解析然后返回。

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

請開啟你的Javascript然后瀏覽 comments powered by Disqus.

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 230,527評論 6 544
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 99,687評論 3 429
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事?!?“怎么了?”我有些...
    開封第一講書人閱讀 178,640評論 0 383
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經(jīng)常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,957評論 1 318
  • 正文 為了忘掉前任,我火速辦了婚禮,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當(dāng)我...
    茶點故事閱讀 72,682評論 6 413
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 56,011評論 1 329
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 44,009評論 3 449
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 43,183評論 0 290
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 49,714評論 1 336
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 41,435評論 3 359
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,665評論 1 374
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 39,148評論 5 365
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 44,838評論 3 350
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,251評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,588評論 1 295
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,379評論 3 400
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 48,627評論 2 380

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

  • Node.js是目前非?;馃岬募夹g(shù),但是它的誕生經(jīng)歷卻很奇特。 眾所周知,在Netscape設(shè)計出JavaScri...
    w_zhuan閱讀 3,635評論 2 41
  • Node.js是目前非?;馃岬募夹g(shù),但是它的誕生經(jīng)歷卻很奇特。 眾所周知,在Netscape設(shè)計出JavaScri...
    Myselfyan閱讀 4,086評論 2 58
  • 1 Node.js模塊的實現(xiàn) 之前在網(wǎng)上查閱了許多介紹Node.js的文章,可惜對于Node.js的模塊機制大都著...
    zlx_2017閱讀 1,275評論 0 1
  • topics: 1.The Node.js philosophy 2.The reactor pattern 3....
    宮若石閱讀 1,115評論 0 1
  • 1 Node.js模塊的實現(xiàn)# 之前在網(wǎng)上查閱了許多介紹Node.js的文章,可惜對于Node.js的模塊機制大都...
    七寸知架構(gòu)閱讀 2,082評論 1 50