require() 原始碼解讀

阮一峰發表於2015-05-20
UI原始碼

2009年，Node.js 專案誕生，所有模組一律為 CommonJS 格式。

時至今日，Node.js 的模組倉庫 npmjs.com ，已經存放了15萬個模組，其中絕大部分都是 CommonJS 格式。

這種格式的核心就是 require 語句，模組通過它載入。學習 Node.js ，必學如何使用 require 語句。本文通過原始碼分析，詳細介紹 require 語句的內部執行機制，幫你理解 Node.js 的模組機制。

一、require() 的基本用法

分析原始碼之前，先介紹 require 語句的內部邏輯。如果你只想瞭解 require 的用法，只看這一段就夠了。

下面的內容翻譯自《Node使用手冊》。

當 Node 遇到 require(X) 時，按下面的順序處理。

（1）如果 X 是內建模組（比如 require('http'）)
　　a. 返回該模組。
　　b. 不再繼續執行。

（2）如果 X 以 "./" 或者 "/" 或者 "../" 開頭
　　a. 根據 X 所在的父模組，確定 X 的絕對路徑。
　　b. 將 X 當成檔案，依次查詢下面檔案，只要其中有一個存在，就返回該檔案，不再繼續執行。

  • X
  • X.js
  • X.json
  • X.node

　　c. 將 X 當成目錄，依次查詢下面檔案，只要其中有一個存在，就返回該檔案，不再繼續執行。

  • X/package.json（main欄位）
  • X/index.js
  • X/index.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 對應的檔案或目錄，就丟擲一個錯誤。

二、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 屬性一致，都是模組的絕對路徑。

三、模組例項的 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()：載入模組

四、模組的絕對路徑

下面是 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

五、載入模組

有了模組的絕對路徑，就可以載入該模組了。下面是 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 變數的值輸出。

（完）

相關文章