原文: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
會被返回給用戶。這就是為什么你可以通過exports
和module.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()
: 通過解析一個模塊絕對路徑來生成模塊的namerequire.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.