理解 Node.js 的模块加载

本文为阅读深入浅出 Node.js（三）：深入 Node.js 的模块机制>之后的总结。作为日常的知识储备，方便日后查看和消化。

起因

模块载入策略

文件模块

// bootstrap main module.
Module.runMain = function () {
  // Load the main module--the command line argument.
  Module._load(process.argv[1], null, true);
};

var module = new Module(id, parent);

(function (exports, require, module, __filename, __dirname) {
  // Your file content
});

模块查找优先级

原生模块

const http = require("http");

const httpFile = require("./http");

模块查找策略

1. 从当前文件目录开始查找 node_modules 目录

2. 然后依次进入父目录，查找父目录下的 node_modules 目录

3. 依次迭代，直到根目录下的 node_modules 目录

console.log(module.paths);
// 输出
[
  "/Users/hao/Work/github/node_module_test/node_modules",
  "/Users/hao/Work/github/node_modules",
  "/Users/hao/Work/node_modules",
  "/Users/hao/node_modules",
  "/Users/node_modules",
  "/node_modules",
];

1. 从 module path 数组中取出第一个目录作为查找基准。

2. 直接从目录中查找该文件，如果存在，则结束查找。如果不存在，则进行下一条查找。

3. 尝试添加.js、.json、.node 后缀后查找，如果存在文件，则结束查找。如果不存在，则进行下一条。

4. 尝试将 require 的参数作为一个包来进行查找，读取目录下的 package.json 文件，取得 main 参数指定的文件。

5. 尝试查找该文件，如果存在，则结束查找。如果不存在，则进行第 3 条查找。

6. 如果继续失败，则取出 module path 数组中的下一个目录作为基准查找，循环第 1 至 5 个步骤。

7. 如果继续失败，循环第 1 至 6 个步骤，直到 module path 中的最后一个值。

8. 如果仍然失败，则抛出异常。

CommonJs 包规范

1. 一个 package.json 文件应该存在于包顶级目录下

2. 二进制文件应该包含在 bin 目录下。

3. JavaScript 代码应该包含在 lib 目录下。

4. 文档应该在 doc 目录下。

5. 单元测试应该在 test 目录下。

为何有些模块可以在 Node.js 运行也可以在浏览器端运行

(function (exports, require, module, __filename, __dirname) {
  // Your file content
});

(function () {
  // Establish the root object, `window` in the browser, or `global` on the server.
  var root = this;
  var _ = function (obj) {
    return new wrapper(obj);
  };
  if (typeof exports !== "undefined") {
    if (typeof module !== "undefined" && module.exports) {
      exports = module.exports = _;
    }
    exports._ = _;
  } else if (typeof define === "function" && define.amd) {
    // Register as a named module with AMD.
    define("underscore", function () {
      return _;
    });
  } else {
    root["_"] = _;
  }
}.call(this));