Node中如何引入一个模块及其细节 _Node

文章插图

在 node 环境中，有两个内置的全局变量无需引入即可直接使用，并且无处不见，它们构成了 nodejs 的模块体系: module 与 require 。以下是一个简单的示例
const fs = require('fs')const add = (x, y) => x + ymodule.exports = add 虽然它们在平常使用中仅仅是引入与导出模块，但稍稍深入，便可见乾坤之大。在业界可用它们做一些比较 trick 的事情，虽然我不大建议使用这些黑科技，但稍微了解还是很有必要。

如何在不重启应用时热加载模块？如 require 一个 json 文件时会产生缓存，但是重写文件时如何 watch
如何通过不侵入代码进行打印日志
循环引用会产生什么问题？

module wrApper
当我们使用 node 中写一个模块时，实际上该模块被一个函数包裹，如下所示:

(function(exports, require, module, __filename, __dirname) {// 所有的模块代码都被包裹在这个函数中const fs = require('fs')const add = (x, y) => x + ymodule.exports = add});

因此在一个模块中自动会注入以下变量：

exports
require
module
__filename
__dirname

module
调试最好的办法就是打印，我们想知道 module 是何方神圣，那就把它打印出来！
const fs = require('fs')const add = (x, y) => x + ymodule.exports = addconsole.log(module)

文章插图

module.id: 如果是 . 代表是入口模块，否则是模块所在的文件名，可见如下的 koa
module.exports: 模块的导出

文章插图

koa module
module.exports 与 exports
? `module.exports` 与 `exports` 有什么关系？[1] ?
从以下源码中可以看到 module wrapper 的调用方 module._compile 是如何注入内置变量的，因此根据源码很容易理解一个模块中的变量：

exports: 实际上是 module.exports 的引用
require: 大多情况下是 Module.prototype.require
module
__filename
__dirname: path.dirname(__filename)

// <node_internals>/internal/modules/cjs/loader.js:1138Module.prototype._compile = function(content, filename) {// ...const dirname = path.dirname(filename);const require = makeRequireFunction(this, redirects);let result;// 从中可以看出：exports = module.exportsconst exports = this.exports;const thisValue = https://www.isolves.com/it/cxkf/bk/2020-07-28/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 是一个极其复杂的对象

文章插图

require
从以上 module wrapper 的源码中也可以看出 require 由 makeRequireFunction 函数生成，如下

// <node_internals>/internal/modules/cjs/helpers.js:33function makeRequireFunction(mod, redirects) {const Module = mod.constructor;let require;if (redirects) {// ...} else {// require 实际上是 Module.prototype.requirerequire = 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[2] ?
【Node中如何引入一个模块及其细节】require(id)
require 函数被用作引入一个模块，也是平常最常见最常用到的函数

// <node_internals>/internal/modules/cjs/loader.js:1019Module.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 载入，大致的总结如下：