Node 中如何引入一個模塊及其細節

本文收錄於 GitHub 山月行博客: shfshanyue/blog，內含我在實際工做中碰到的問題、關於業務的思考及在全棧方向上的學習

• 前端工程化系列
• Node進階系列

在 node 環境中，有兩個內置的全局變量無需引入便可直接使用，而且無處不見，它們構成了 nodejs 的模塊體系: module 與 require。如下是一個簡單的示例

const fs = require('fs')

const add = (x, y) => x + y

module.exports = add

雖然它們在日常使用中僅僅是引入與導出模塊，但稍稍深刻，即可見乾坤之大。在業界可用它們作一些比較 trick 的事情，雖然我不大建議使用這些黑科技，但稍微瞭解仍是頗有必要。

1. 如何在不重啓應用時熱加載模塊？如 require 一個 json 文件時會產生緩存，可是重寫文件時如何 watch
2. 如何經過不侵入代碼進行打印日誌
3. 循環引用會產生什麼問題？

module wrapper

當咱們使用 node 中寫一個模塊時，實際上該模塊被一個函數包裹，以下所示:

(function(exports, require, module, __filename, __dirname) {
  // 全部的模塊代碼都被包裹在這個函數中
  const fs = require('fs')

  const add = (x, y) => x + y

  module.exports = add
});

所以在一個模塊中自動會注入如下變量：

• exports
• require
• module
• __filename
• __dirname

module

調試最好的辦法就是打印，咱們想知道 module 是何方神聖，那就把它打印出來！

const fs = require('fs')

const add = (x, y) => x + y

module.exports = add

console.log(module)

• module.id: 若是是 . 表明是入口模塊，不然是模塊所在的文件名，可見以下的 koa
• module.exports: 模塊的導出

module.exports 與 exports

module.exports 與 exports 有什麼關係？

從如下源碼中能夠看到 module wrapper 的調用方 module._compile 是如何注入內置變量的，所以根據源碼很容易理解一個模塊中的變量：

• exports: 其實是 module.exports 的引用
• require: 大多狀況下是 Module.prototype.require
• module
• __filename
• __dirname: path.dirname(__filename)

// <node_internals>/internal/modules/cjs/loader.js:1138

Module.prototype._compile = function(content, filename) {
  // ...
  const dirname = path.dirname(filename);
  const require = makeRequireFunction(this, redirects);
  let result;

  // 從中能夠看出：exports = module.exports
  const exports = this.exports;
  const thisValue = exports;
  const module = this;
  if (requireDepth === 0) statCache = new Map();
  if (inspectorWrapper) {
    result = inspectorWrapper(compiledWrapper, thisValue, exports,
                              require, module, filename, dirname);
  } else {
    result = compiledWrapper.call(thisValue, exports, require, module,
                                  filename, dirname);
  }
  // ...
}

require

經過 node 的 REPL 控制檯，或者在 VSCode 中輸出 require 進行調試，能夠發現 require 是一個極其複雜的對象

從以上 module wrapper 的源碼中也能夠看出 require 由 makeRequireFunction 函數生成，以下

// <node_internals>/internal/modules/cjs/helpers.js:33

function makeRequireFunction(mod, redirects) {
  const Module = mod.constructor;

  let require;
  if (redirects) {
    // ...
  } else {
    // require 其實是 Module.prototype.require
    require = function require(path) {
      return mod.require(path);
    };
  }

  function resolve(request, options) { // ... }

  require.resolve = resolve;

  function paths(request) {
    validateString(request, 'request');
    return Module._resolveLookupPaths(request, mod);
  }

  resolve.paths = paths;

  require.main = process.mainModule;

  // Enable support to add extra extension types.
  require.extensions = Module._extensions;

  require.cache = Module._cache;

  return require;
}

關於 require 更詳細的信息能夠去參考官方文檔: Node API: require

require(id)

require 函數被用做引入一個模塊，也是日常最多見最經常使用到的函數

// <node_internals>/internal/modules/cjs/loader.js:1019

Module.prototype.require = function(id) {
  validateString(id, 'id');
  if (id === '') {
    throw new ERR_INVALID_ARG_VALUE('id', id,
                                    'must be a non-empty string');
  }
  requireDepth++;
  try {
    return Module._load(id, this, /* isMain */ false);
  } finally {
    requireDepth--;
  }
}

而 require 引入一個模塊時，實際上經過 Module._load 載入，大體的總結以下：

1. 若是 Module._cache 命中模塊緩存，則直接取出 module.exports，加載結束
2. 若是是 NativeModule，則 loadNativeModule 加載模塊，如 fs、http、path 等模塊，加載結束
3. 不然，使用 Module.load 加載模塊，固然這個步驟也很長，下一章節再細講

// <node_internals>/internal/modules/cjs/loader.js:879

Module._load = function(request, parent, isMain) {
  let relResolveCacheIdentifier;
  if (parent) {
    // ...
  }

  const filename = Module._resolveFilename(request, parent, isMain);

  const cachedModule = Module._cache[filename];

  // 若是命中緩存，直接取緩存
  if (cachedModule !== undefined) {
    updateChildren(parent, cachedModule, true);
    return cachedModule.exports;
  }

  // 若是是 NativeModule，加載它
  const mod = loadNativeModule(filename, request);
  if (mod && mod.canBeRequiredByUsers) return mod.exports;

  // Don't call updateChildren(), Module constructor already does.
  const module = new Module(filename, parent);

  if (isMain) {
    process.mainModule = module;
    module.id = '.';
  }

  Module._cache[filename] = module;
  if (parent !== undefined) { // ... }

  let threw = true;
  try {
    if (enableSourceMaps) {
      try {
        // 若是不是 NativeModule，加載它
        module.load(filename);
      } catch (err) {
        rekeySourceMap(Module._cache[filename], err);
        throw err; /* node-do-not-add-exception-line */
      }
    } else {
      module.load(filename);
    }
    threw = false;
  } finally {
    // ...
  }

  return module.exports;
};

require.cache

當代碼執行 require(lib) 時，會執行 lib 模塊中的內容，並做爲一份緩存，下次引用時再也不執行模塊中內容。

這裏的緩存指的就是 require.cache，也就是上一段指的 Module._cache

// <node_internals>/internal/modules/cjs/loader.js:899

require.cache = Module._cache;

這裏有個小測試:

有兩個文件: index.js 與 utils.js。 utils.js 中有一個打印操做，當 index.js 引用 utils.js 屢次時， utils.js 中的打印操做會執行幾回。代碼示例以下

index.js

// index.js

// 此處引用兩次
require('./utils')
require('./utils')

utils.js

// utils.js
console.log('被執行了一次')

答案是隻執行了一次，所以 require.cache，在 index.js 末尾打印 require，此時會發現一個模塊緩存

// index.js

require('./utils')
require('./utils')

console.log(require)

那回到本章剛開始的問題：

如何不重啓應用熱加載模塊呢？

答：刪掉 Module._cache，但同時會引起問題，如這種 一行 delete require.cache 引起的內存泄漏血案

因此說嘛，這種黑魔法大幅修改核心代碼的東西開發環境玩一玩就能夠了，千萬不要跑到生產環境中去，畢竟黑魔法是不可控的。

總結

1. 模塊中執行時會被 module wrapper 包裹，並注入全局變量 require 及 module 等
2. module.exports 與 exports 的關係其實是 exports = module.exports
3. require 其實是 module.require
4. require.cache 會保證模塊不會被執行屢次
5. 不要使用 delete require.cache 這種黑魔法

關注我

本文收錄於 GitHub 山月行博客: shfshanyue/blog，內含我在實際工做中碰到的問題、關於業務的思考及在全棧方向上的學習

• 前端工程化系列
• Node進階系列

歡迎關注公衆號【全棧成長之路】，定時推送 Node 原創及全棧成長文章

<figure> <img width="240" src="https://shanyue.tech/qrcode.jpg" alt="歡迎關注"> <figcaption>歡迎關注全棧成長之路</figcaption></figure>