您当前的位置:首页 > 电脑百科 > 程序开发 > 编程百科

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

时间:2020-07-28 15:55:31  来源:  作者:
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) 
Node中如何引入一个模块及其细节

 

  • module.id: 如果是 . 代表是入口模块,否则是模块所在的文件名,可见如下的 koa
  • module.exports: 模块的导出
Node中如何引入一个模块及其细节

 

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: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 是一个极其复杂的对象

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

 

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[2] ❞

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) 
Node中如何引入一个模块及其细节

 

那回到本章刚开始的问题:

❝ 如何不重启应用热加载模块呢? ❞

答:「删掉 Module._cache」,但同时会引发问题,如这种 一行 delete require.cache 引发的内存泄漏血案[3]

所以说嘛,这种黑魔法大幅修改核心代码的东西开发环境玩一玩就可以了,千万不要跑到生产环境中去,毕竟黑魔法是不可控的。

总结

  1. 模块中执行时会被 module wrapper 包裹,并注入全局变量 require 及 module 等
  2. module.exports 与 exports 的关系实际上是 exports = module.exports
  3. require 实际上是 module.require
  4. require.cache 会保证模块不会被执行多次
  5. 不要使用 delete require.cache 这种黑魔法


Tags:Node   点击:()  评论:()
声明:本站部分内容及图片来自互联网,转载是出于传递更多信息之目的,内容观点仅代表作者本人,如有任何标注错误或版权侵犯请与我们联系(Email:2595517585@qq.com),我们将及时更正、删除,谢谢。
▌相关推荐
Node是个啥?  写个东西还是尽量面面俱到吧,所以有关基本概念的东西我也从网上选择性地拿了下来,有些地方针对自己的理解有所改动,对这些概念性的东西有过了解的可选择跳过这段...【详细内容】
2021-12-15  Tags: Node  点击:(21)  评论:(0)  加入收藏
在网页中渲染公式一直是泛学术工具绕不开的一个功能,最近更新产品功能,正巧遇到了这个需求,于是使用容器方式简单实现了一个相对靠谱的公式渲染服务。分享出来,希望能够帮到有类...【详细内容】
2021-12-01  Tags: Node  点击:(10)  评论:(0)  加入收藏
在此前写的文章“从零基础入门进行小程序开发实战”中,已经介绍过背单词的小程序,因为没有备案的服务器资源只能使用系统后台提供的缓存功能存储用户数据。缓存有大小限制,而且...【详细内容】
2021-07-27  Tags: Node  点击:(108)  评论:(0)  加入收藏
最近在工作中遇到了一个场景:要做一个静态的网站,里面的内容是由设计编写的.md格式的内容。设计将编好的文档统一放在常用的Google Drive里面,如下图 然后我需要将这些文档下载...【详细内容】
2021-06-09  Tags: Node  点击:(148)  评论:(0)  加入收藏
框架语言:nodejs 包:express fs目的通过nodejs实现一个大文件的断点下载的服务。代码由于没啥复杂的,这里直接上代码。 http断点下载是通过range来判断文件的起始位置的。其基...【详细内容】
2021-04-27  Tags: Node  点击:(199)  评论:(0)  加入收藏
一、安装环境1、本机系统:Windows 10 Pro(64位) 2、Node.js:v12.14.1(64位)二、安装Node.js步骤1、下载对应你系统的Node.js版本: https://nodejs.org/en/download/ 2、选安装目录...【详细内容】
2020-11-26  Tags: Node  点击:(105)  评论:(0)  加入收藏
inode介绍Linux在Linux操作系统中,将文件系统分为2部分,一部分为数据区,一部分为元数据区,这里的元数据就是inode,它存取文件的创建者,文件的创建日期,修改日期,访问日期,文件大小等...【详细内容】
2020-11-05  Tags: Node  点击:(191)  评论:(0)  加入收藏
首先你要现在你的电脑上安装好node.js 地址:https://nodejs.org/en/download/ 安装好了会出现这个: 然后写代码://使用Node搭建一个简单的http服务器//加载http模块let http...【详细内容】
2020-10-23  Tags: Node  点击:(100)  评论:(0)  加入收藏
简介在本文中,我们将介绍如何用Node.js和Express来使用 Handlebars 模板引擎。还会介绍什么是模板引擎,以及如何使用把 Handlebars 建服务器端渲染(SSR) web应用程序。我们还...【详细内容】
2020-10-19  Tags: Node  点击:(68)  评论:(0)  加入收藏
一、存储机制1、基础描述NameNode运行时元数据需要存放在内存中,同时在磁盘中备份元数据的fsImage,当元数据有更新或者添加元数据时,修改内存中的元数据会把操作记录追加到edit...【详细内容】
2020-10-12  Tags: Node  点击:(70)  评论:(0)  加入收藏
▌简易百科推荐
摘 要 (OF作品展示)OF之前介绍了用python实现数据可视化、数据分析及一些小项目,但基本都是后端的知识。想要做一个好看的可视化大屏,我们还要学一些前端的知识(vue),网上有很多比...【详细内容】
2021-12-27  项目与数据管理    Tags:Vue   点击:(1)  评论:(0)  加入收藏
程序是如何被执行的&emsp;&emsp;程序是如何被执行的?许多开发者可能也没法回答这个问题,大多数人更注重的是如何编写程序,却不会太注意编写好的程序是如何被运行,这并不是一个好...【详细内容】
2021-12-23  IT学习日记    Tags:程序   点击:(9)  评论:(0)  加入收藏
阅读收获✔️1. 了解单点登录实现原理✔️2. 掌握快速使用xxl-sso接入单点登录功能一、早期的多系统登录解决方案 单系统登录解决方案的核心是cookie,cookie携带会话id在浏览器...【详细内容】
2021-12-23  程序yuan    Tags:单点登录(   点击:(8)  评论:(0)  加入收藏
下载Eclipse RCP IDE如果你电脑上还没有安装Eclipse,那么请到这里下载对应版本的软件进行安装。具体的安装步骤就不在这赘述了。创建第一个标准Eclipse RCP应用(总共分为六步)1...【详细内容】
2021-12-22  阿福ChrisYuan    Tags:RCP应用   点击:(7)  评论:(0)  加入收藏
今天想简单聊一聊 Token 的 Value Capture,就是币的价值问题。首先说明啊,这个话题包含的内容非常之光,Token 的经济学设计也可以包含诸多问题,所以几乎不可能把这个问题说的清...【详细内容】
2021-12-21  唐少华TSH    Tags:Token   点击:(9)  评论:(0)  加入收藏
实现效果:假如有10条数据,分组展示,默认在当前页面展示4个,点击换一批,从第5个开始继续展示,到最后一组,再重新返回到第一组 data() { return { qList: [], //处理后...【详细内容】
2021-12-17  Mason程    Tags:VUE   点击:(14)  评论:(0)  加入收藏
什么是性能调优?(what) 为什么需要性能调优?(why) 什么时候需要性能调优?(when) 什么地方需要性能调优?(where) 什么时候来进行性能调优?(who) 怎么样进行性能调优?(How) 硬件配...【详细内容】
2021-12-16  软件测试小p    Tags:性能调优   点击:(19)  评论:(0)  加入收藏
Tasker 是一款适用于 Android 设备的高级自动化应用,它可以通过脚本让重复性的操作自动运行,提高效率。 不知道从哪里听说的抖音 app 会导致 OLED 屏幕烧屏。于是就现学现卖,自...【详细内容】
2021-12-15  ITBang    Tags:抖音防烧屏   点击:(23)  评论:(0)  加入收藏
11 月 23 日,Rust Moderation Team(审核团队)在 GitHub 上发布了辞职公告,即刻生效。根据公告,审核团队集体辞职是为了抗议 Rust 核心团队(Core team)在执行社区行为准则和标准上...【详细内容】
2021-12-15  InfoQ    Tags:Rust   点击:(24)  评论:(0)  加入收藏
一个项目的大部分API,测试用例在参数和参数值等信息会有很多相似的地方。我们可以复制API,复制用例来快速生成,然后做细微调整既可以满足我们的测试需求1.复制API:在菜单发布单...【详细内容】
2021-12-14  AutoMeter    Tags:AutoMeter   点击:(20)  评论:(0)  加入收藏
最新更新
栏目热门
栏目头条