Node學習之路：require()工作原理

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

介紹

• Node學習之路

掌握的基本知識

• 理解回調函數中的錯誤優先

• 測試要點

進階

• 單例模式

• 設計自定義類型

• 工廠模式

高級

• require() 工作原理

• 危險的模塊設計模式

幾乎所有的Node.js開發者都可以說出require()的作用，但是又有多少人真正知道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模塊提供了一個函數用於編譯。每一個文件在這個基礎模塊中運行後都會返回一個新的實例，即使這個文件運行了也還是會存在。這就是爲什麼我們可以隨時使用 module.exports並且可以返回它。

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

Module._load

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

Module._load是一個負責新模塊的加載和管理模塊緩存的函數。緩存所有加載過的模塊可以減少文件的重複加載並且明顯地加快你的應用。此外，共享模塊的實例可以把模塊像單例來使用，可以在整個項目的運行中都可以保存它的狀態。

如果一個模塊不存在在緩存中，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\. 創建一個獨立的require函數，該函數可以調用module.require。
  // 2\. 給require加上其他幫助性的函數Attach other helper methods to require.
  // 3\. 將代碼包裹在一個函數中，並提供了require，module等變量在模塊作用域中。
  // 4\. 運行這個函數
};

這裏就是見證奇蹟的地方。第一，一個特殊的單獨的require函數被創造用於這個模塊。這個require函數就是我們最熟悉的那個函數。這個函數只是把 Module.require包裹了一下，它也包含了一些鮮爲人知的幫助性的屬性和方法供我們使用：

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

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

• require.main: 主要模塊

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

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

一旦require完成了，整個加載好的源碼會被包裹在一個新的函數裏面，同時傳入require, module, exports和其對外的變量作爲新函數的參數。這樣就創造了一個新的函數作用域，這樣可以避免污染Node的全局環境。

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

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

結論

至此，我們已經看完了require的代碼，通過這一圈的代碼就創造出了我們一開始想要去了解的那個require 函數。

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

如果你想了解更多的細節，你可以瀏覽module.js源碼。你會得到更多的信息也會了解的更多，我將會給第一個回答出什麼是‘NODE_MODULE_CONTEXTS’並且爲什麼要加上這個的人加分。

---

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

[2] 當然這些模塊都是由一些私有的函數方法構建的，例如Module._resolveLookupPaths and Module._findPath。你可以想一想是否可以有更好的辦法…

請開啓你的Javascript然後瀏覽 comments powered by Disqus.