2009年，Node.js 項目誕生，全部模塊一概爲 CommonJS 格式。java
時至今日，Node.js 的模塊倉庫 npmjs.com ，已經存放了15萬個模塊，其中絕大部分都是 CommonJS 格式。node
這種格式的核心就是 require 語句，模塊經過它加載。學習 Node.js ，必學如何使用 require 語句。本文經過源碼分析，詳細介紹 require 語句的內部運行機制，幫你理解 Node.js 的模塊機制。git
1、require() 的基本用法
分析源碼以前，先介紹 require 語句的內部邏輯。若是你只想瞭解 require 的用法，只看這一段就夠了。github
下面的內容翻譯自《Node使用手冊》。npm
當 Node 遇到 require(X) 時，按下面的順序處理。json
（1）若是 X 是內置模塊（好比 require('http'）)
a. 返回該模塊。
b. 再也不繼續執行。api（2）若是 X 以 "./" 或者 "/" 或者 "../" 開頭
a. 根據 X 所在的父模塊，肯定 X 的絕對路徑。
b. 將 X 當成文件，依次查找下面文件，只要其中有一個存在，就返回該文件，再也不繼續執行。數組
- X
- X.js
- X.json
- X.node
c. 將 X 當成目錄，依次查找下面文件，只要其中有一個存在，就返回該文件，再也不繼續執行。
- X/package.json（main字段）
- X/index.js
- X.json
- X/index.node
（3）若是 X 不帶路徑
a. 根據 X 所在的父模塊，肯定 X 可能的安裝目錄。
b. 依次在每一個目錄中，將 X 當成文件名或目錄名加載。（4） 拋出 "not found"
請看一個例子。
當前腳本文件 /home/ry/projects/foo.js 執行了 require('bar') ，這屬於上面的第三種狀況。Node 內容運行過程以下。
首先，肯定 x 的絕對路徑多是下面這些位置，依次搜索每個目錄。
/home/ry/projects/node_modules/bar /home/ry/node_modules/bar /home/node_modules/bar /node_modules/bar
搜索時，Node 先將 bar 當成文件名，依次嘗試加載下面這些文件，只要有一個成功就返回。
bar
bar.js bar.json bar.node
若是都不成功，說明 bar 多是目錄名，因而依次嘗試加載下面這些文件。
bar/package.json（main字段） bar/index.js bar/index.json bar/index.node
若是在全部目錄中，都沒法找到 bar 對應的文件或目錄，就拋出一個錯誤。
2、Module 構造函數
瞭解內部邏輯之後，下面就來看源碼。
require 的源碼在 Node 的 lib/module.js 文件。爲了便於理解，本文引用的源碼是簡化過的，而且刪除了原做者的註釋。
function Module(id, parent) { this.id = id; this.exports = {}; this.parent = parent; this.filename = null; this.loaded = false; this.children = []; } module.exports = Module; var module = new Module(filename, parent);
上面代碼中，Node 定義了一個構造函數 Module，全部的模塊都是 Module 的實例。能夠看到，當前模塊（module.js）也是 Module 的一個實例。
每一個實例都有本身的屬性。下面經過一個例子，看看這些屬性的值是什麼。新建一個腳本文件 a.js 。
// a.js console.log('module.id: ', module.id); console.log('module.exports: ', module.exports); console.log('module.parent: ', module.parent); console.log('module.filename: ', module.filename); console.log('module.loaded: ', module.loaded); console.log('module.children: ', module.children); console.log('module.paths: ', module.paths);
運行這個腳本。
$ node a.js module.id: . module.exports: {} module.parent: null module.filename: /home/ruanyf/tmp/a.js module.loaded: false module.children: [] module.paths: [ '/home/ruanyf/tmp/node_modules', '/home/ruanyf/node_modules', '/home/node_modules', '/node_modules' ]
能夠看到，若是沒有父模塊，直接調用當前模塊，parent 屬性就是 null，id 屬性就是一個點。filename 屬性是模塊的絕對路徑，path 屬性是一個數組，包含了模塊可能的位置。另外，輸出這些內容時，模塊尚未所有加載，因此 loaded 屬性爲 false 。
新建另外一個腳本文件 b.js，讓其調用 a.js 。
// b.js var a = require('./a.js');
運行 b.js 。
$ node b.js module.id: /home/ruanyf/tmp/a.js module.exports: {} module.parent: { object } module.filename: /home/ruanyf/tmp/a.js module.loaded: false module.children: [] module.paths: [ '/home/ruanyf/tmp/node_modules', '/home/ruanyf/node_modules', '/home/node_modules', '/node_modules' ]
上面代碼中，因爲 a.js 被 b.js 調用，因此 parent 屬性指向 b.js 模塊，id 屬性和 filename 屬性一致，都是模塊的絕對路徑。
3、模塊實例的 require 方法
每一個模塊實例都有一個 require 方法。
Module.prototype.require = function(path) { return Module._load(path, this); };
由此可知，require 並非全局性命令，而是每一個模塊提供的一個內部方法，也就是說，只有在模塊內部才能使用 require 命令（惟一的例外是 REPL 環境）。另外，require 其實內部調用 Module._load 方法。
下面來看 Module._load 的源碼。
Module._load = function(request, parent, isMain) { // 計算絕對路徑 var filename = Module._resolveFilename(request, parent); // 第一步：若是有緩存，取出緩存 var cachedModule = Module._cache[filename]; if (cachedModule) { return cachedModule.exports; // 第二步：是否爲內置模塊 if (NativeModule.exists(filename)) { return NativeModule.require(filename); } // 第三步：生成模塊實例，存入緩存 var module = new Module(filename, parent); Module._cache[filename] = module; // 第四步：加載模塊 try { module.load(filename); hadException = false; } finally { if (hadException) { delete Module._cache[filename]; } } // 第五步：輸出模塊的exports屬性 return module.exports; };
上面代碼中，首先解析出模塊的絕對路徑（filename），以它做爲模塊的識別符。而後，若是模塊已經在緩存中，就從緩存取出；若是不在緩存中，就加載模塊。
所以，Module._load 的關鍵步驟是兩個。
- Module._resolveFilename() ：肯定模塊的絕對路徑
- module.load()：加載模塊
4、模塊的絕對路徑
下面是 Module._resolveFilename 方法的源碼。
Module._resolveFilename = function(request, parent) { // 第一步：若是是內置模塊，不含路徑返回 if (NativeModule.exists(request)) { return request; } // 第二步：肯定全部可能的路徑 var resolvedModule = Module._resolveLookupPaths(request, parent); var id = resolvedModule[0]; var paths = resolvedModule[1]; // 第三步：肯定哪個路徑爲真 var filename = Module._findPath(request, paths); if (!filename) { var err = new Error("Cannot find module '" + request + "'"); err.code = 'MODULE_NOT_FOUND'; throw err; } return filename; };
上面代碼中，在 Module.resolveFilename 方法內部，又調用了兩個方法 Module.resolveLookupPaths() 和 Module._findPath() ，前者用來列出可能的路徑，後者用來確認哪個路徑爲真。
爲了簡潔起見，這裏只給出 Module._resolveLookupPaths() 的運行結果。
[ '/home/ruanyf/tmp/node_modules', '/home/ruanyf/node_modules', '/home/node_modules', '/node_modules' '/home/ruanyf/.node_modules', '/home/ruanyf/.node_libraries'， '$Prefix/lib/node' ]
上面的數組，就是模塊全部可能的路徑。基本上是，從當前路徑開始一級級向上尋找 node_modules 子目錄。最後那三個路徑，主要是爲了歷史緣由保持兼容，實際上已經不多用了。
有了可能的路徑之後，下面就是 Module._findPath() 的源碼，用來肯定到底哪個是正確路徑。
Module._findPath = function(request, paths) { // 列出全部可能的後綴名：.js，.json, .node var exts = Object.keys(Module._extensions); // 若是是絕對路徑，就再也不搜索 if (request.charAt(0) === '/') { paths = ['']; } // 是否有後綴的目錄斜槓 var trailingSlash = (request.slice(-1) === '/'); // 第一步：若是當前路徑已在緩存中，就直接返回緩存 var cacheKey = JSON.stringify({request: request, paths: paths}); if (Module._pathCache[cacheKey]) { return Module._pathCache[cacheKey]; } // 第二步：依次遍歷全部路徑 for (var i = 0, PL = paths.length; i < PL; i++) { var basePath = path.resolve(paths[i], request); var filename; if (!trailingSlash) { // 第三步：是否存在該模塊文件 filename = tryFile(basePath); if (!filename && !trailingSlash) { // 第四步：該模塊文件加上後綴名，是否存在 filename = tryExtensions(basePath, exts); } } // 第五步：目錄中是否存在 package.json if (!filename) { filename = tryPackage(basePath, exts); } if (!filename) { // 第六步：是否存在目錄名 + index + 後綴名 filename = tryExtensions(path.resolve(basePath, 'index'), exts); } // 第七步：將找到的文件路徑存入返回緩存，而後返回 if (filename) { Module._pathCache[cacheKey] = filename; return filename; } } // 第八步：沒有找到文件，返回false return false; };
通過上面代碼，就能夠找到模塊的絕對路徑了。
有時在項目代碼中，須要調用模塊的絕對路徑，那麼除了 module.filename ，Node 還提供一個 require.resolve 方法，供外部調用，用於從模塊名取到絕對路徑。
require.resolve = function(request) { return Module._resolveFilename(request, self); }; // 用法 require.resolve('a.js') // 返回 /home/ruanyf/tmp/a.js
5、加載模塊
有了模塊的絕對路徑，就能夠加載該模塊了。下面是 module.load 方法的源碼。
Module.prototype.load = function(filename) { var extension = path.extname(filename) || '.js'; if (!Module._extensions[extension]) extension = '.js'; Module._extensions[extension](this, filename); this.loaded = true; };
上面代碼中，首先肯定模塊的後綴名，不一樣的後綴名對應不一樣的加載方法。下面是 .js 和 .json 後綴名對應的處理方法。
Module._extensions['.js'] = function(module, filename) { var content = fs.readFileSync(filename, 'utf8'); module._compile(stripBOM(content), filename); }; Module._extensions['.json'] = function(module, filename) { var content = fs.readFileSync(filename, 'utf8'); try { module.exports = JSON.parse(stripBOM(content)); } catch (err) { err.message = filename + ': ' + err.message; throw err; } };
這裏只討論 js 文件的加載。首先，將模塊文件讀取成字符串，而後剝離 utf8 編碼特有的BOM文件頭，最後編譯該模塊。
module._compile 方法用於模塊的編譯。
Module.prototype._compile = function(content, filename) { var self = this; var args = [self.exports, require, self, filename, dirname]; return compiledWrapper.apply(self.exports, args); };
上面的代碼基本等同於下面的形式。
(function (exports, require, module, __filename, __dirname) { // 模塊源碼 });
也就是說，模塊的加載實質上就是，注入exports、require、module三個全局變量，而後執行模塊的源碼，而後將模塊的 exports 變量的值輸出。
（完）