快捷導(dǎo)航

Node.js中require的工作原理淺析

更新時(shí)間：2014年06月24日 10:40:19 投稿：junjie

這篇文章主要介紹了Node.js中require的工作原理淺析,通過(guò)分析node.js的源碼得到本文,需要的朋友可以參考下

幾乎所有的Node.js開發(fā)人員可以告訴你`require()`函數(shù)做什么，但我們又有多少人真正知道它是如何工作的？我們每天都使用它來(lái)加載庫(kù)和模塊，但它的行為，對(duì)于我們來(lái)說(shuō)反而是一個(gè)謎。

出于好奇，我鉆研了node的核心代碼來(lái)找出在引擎下發(fā)生了什么事。但這并不是一個(gè)單一的功能，我在node的模塊系統(tǒng)的找到了module.js。該文件包含一個(gè)令人驚訝的強(qiáng)大的且相對(duì)陌生的核心模塊，控制每個(gè)文件的加載，編譯和緩存。`require（）`，它的橫空出世，只是冰山的一角。

module.js

復(fù)制代碼代碼如下:

function Module(id, parent) {

  this.id = id;

  this.exports = {};

  this.parent = parent;

  // ...

在module.js在Node.js內(nèi)部主要承擔(dān)兩個(gè)角色。首先，它為所有的Node.js模塊提供了一個(gè)基礎(chǔ)。每個(gè)文件是基本模塊new出的一個(gè)新實(shí)例，即使在該文件已經(jīng)運(yùn)行之后，仍然存在。這就是為什么我們能夠性為module.exports附加屬并在需要時(shí)返回它們。

該模塊的第二大任務(wù)是處理node的模塊加載機(jī)制。我們使用的獨(dú)立操作的“require”函數(shù)實(shí)際上是一個(gè)抽象概念的module.require，這本身就是只是一個(gè)簡(jiǎn)單的關(guān)于Module._load功能的封裝。此load方法處理每個(gè)文件的實(shí)際加載，并在那里開始我們的旅程。

Module._load

復(fù)制代碼代碼如下:

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負(fù)責(zé)加載新的模塊和管理模塊的緩存。緩存加載的每個(gè)模塊減少冗余文件的讀取次數(shù)，并可以顯著地加快您應(yīng)用程序的速度。此外，共享模塊實(shí)例允許單例特性的模塊，保持在項(xiàng)目中的狀態(tài)。

如果某個(gè)模塊沒有在緩存中存在，Module._load將創(chuàng)建該文件的一個(gè)新的基本模塊。然后，它會(huì)告訴模塊在將它們發(fā)送到module._compile之前閱讀新文件的內(nèi)容。[1]

如果您注意到上面的步驟＃6，你會(huì)看到module.exports已被返回給用戶。這就是為什么當(dāng)你在定義公共接口使用時(shí)，你使用exports和module.exports，因?yàn)镸odule._load將接下來(lái)返回require的內(nèi)容。我很驚訝，這里沒有更多的功能，但如果有的話那更好。

module._compile

復(fù)制代碼代碼如下:

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

};

· 這是真正的奇跡發(fā)生的地方。首先，一個(gè)特殊的獨(dú)立操作的require函數(shù)是為該模塊創(chuàng)建的。這是我們需要的并且都熟悉的功能。而函數(shù)本身只是一個(gè)在Module.require的封裝，它也包含了一些便于我們使用的鮮為人知的輔助方法：

· require()：加載一個(gè)外部模塊
· require.resolve()：解析一個(gè)模塊名到它的絕對(duì)路徑
· require.main：主模塊
· require.cache：所有緩存好的模塊
· ·require.extensions：根據(jù)其擴(kuò)展名，對(duì)于每個(gè)有效的文件類型可使用的編制方法

一旦require準(zhǔn)備好了，整個(gè)加載的源代碼就會(huì)被封裝在一個(gè)新的函數(shù)里，可以接受require,module,exports和所有其他暴露的變量作為參數(shù)。這是一個(gè)僅僅為封裝模塊的而創(chuàng)建的函數(shù)，以便于在防止與Node.js的環(huán)境產(chǎn)生沖突。

復(fù)制代碼代碼如下:

(function (exports, require, module, __filename, __dirname) {

  // YOUR CODE INJECTED HERE!

});

該Module._compile方法是同步執(zhí)行的，所以對(duì)Module._load的調(diào)用只能等到這段代碼運(yùn)行結(jié)束，并將module.exprts返回給用戶。

結(jié)論

因此，我們已經(jīng)了解了require的全部代碼，并已經(jīng)初步了解它是如何工作的。

如果你已經(jīng)按照這一切的方式做了，那么你已經(jīng)為最后的秘密做好準(zhǔn)備：require('module')。這是正確的，該模塊系統(tǒng)本身可以通過(guò)模塊系統(tǒng)被加載。盜夢(mèng)空間。這可能聽起來(lái)很奇怪，但它可以讓用戶空間同模塊加載系統(tǒng)互動(dòng)起來(lái)，并不需要鉆研Node.js核心。受歡迎的模塊都像這樣被建立。[2]

如果您想了解更多，請(qǐng)自己查看module.js源代碼。還有很多東西足夠你頭痛一段時(shí)間了。第一個(gè)可以告訴我什么是NODE_MODULE_CONTEXTS“以及它為什么被添加的人可以得到加分獎(jiǎng)勵(lì) :)

[1] module._compile方法只用于運(yùn)行JavaScript文件。 JSON文件需通過(guò)JSON.parse() 解析并返回

[2]然而，這兩個(gè)模塊都建立在私有模塊的方法，如Module._resolveLookupPaths和Module._findPath。你可以認(rèn)為這并沒有好多了...

您可能感興趣的文章: