幾乎所有的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。你可以認為這並沒有好多了...