详解小程序循环require之坑


Posted in Javascript onMarch 08, 2019

1. 循环require

在JavaScript中,模块之间可能出现相互引用的情况,例如现在有三个模块,他们之间的相互引用关系如下,大致的引用关系可以表示为 A -> B -> C -> A,要完成模块A,它依赖于模块C,但是模块C反过来又依赖于模块A,此时就出现了循环require。

// a.js
const B = require('./b.js');

console.log('B in A', B);
const A = {
  name: 'A',
  childName: B.name,
};
module.exports = A;
// b.js
const C = require('./c.js');

console.log('C in B', C);
const B = {
  name: 'B',
  childName: C.name,
}
module.exports = B;
// c.js
const A = require('./a.js');

console.log('A in C', A);
const C = {
  name: 'C',
  childName: A.name,
};
module.exports = C;

那JS引擎会一直循环require下去吗?答案是不会的,如果我们以a.js为入口执行程序,C在引用A时,a.js已经执行,不会再重新执行a.js,因此c.js获得的A对象是一个空对象(因为a.js还没执行完成)。

2. 小程序中的坑

在正常情况下,JS引擎是可以解析循环require的情形的。但是在一些低版本的小程序中,居然出现程序一直循环require的情况,最终导致栈溢出而报错,实在是天坑。

那如何解决呢,很遗憾,目前并未找到完美的方法来解决,只能找到程序中的循环require的代码,并进行修改。为了快速定位程序中的循环引用,写了一段NodeJs检测代码来检测进行检测。

const fs = require('fs');
const path = require('path');
const fileCache = {};
const requireLink = [];

if (process.argv.length !== 3) {
 console.log(`please run as: node ${__filename.split(path.sep).pop()} file/to/track`);
 return;
}

const filePath = process.argv[2];
const absFilePath = getFullFilePath(filePath);
if (absFilePath) {
 resolveRequires(absFilePath, 0);
} else {
 console.error('file not exist:', filePath);
}

/**
 * 递归函数,解析文件的依赖
 * @param {String} file 引用文件的路径
 * @param {Number} level 文件所在的引用层级
 */
function resolveRequires(file, level) {
 requireLink[level] = file;
 for (let i = 0; i < level; i ++) {
  if (requireLink[i] === file) {
   console.log('**** require circle detected ****');
   console.log(requireLink.slice(0, level + 1));
   console.log();
   return;
  }
 }
 const requireFiles = getRequireFiles(file);
 requireFiles.forEach(file => resolveRequires(file, level + 1));
}

/**
 * 获取文件依赖的文件
 * @param {String} filePath 引用文件的路径
 */
function getRequireFiles(filePath) {
 if (!fileCache[filePath]) {
  try {
   const fileBuffer = fs.readFileSync(filePath);
   fileCache[filePath] = fileBuffer.toString();
  } catch(err) {
   console.log('read file failed', filePath);
   return [];
  }
 }
 const fileContent = fileCache[filePath];

 // 引入模块的几种形式
 const requirePattern = /require\s*\(['"](.*?)['"]\)/g;
 const importPattern1 = /import\s+.*?\s+from\s+['"](.*?)['"]/g;
 const importPattern2 = /import\s+['"](.*?)['"]/g;

 const requireFilePaths = [];
 const baseDir = path.dirname(filePath);
 let match = null;
 while ((match = requirePattern.exec(fileContent)) !== null) {
  requireFilePaths.push(match[1]);
 }
 while ((match = importPattern1.exec(fileContent)) !== null) {
  requireFilePaths.push(match[1]);
 }
 while ((match = importPattern2.exec(fileContent)) !== null) {
  requireFilePaths.push(match[1]);
 }

 return requireFilePaths.map(fp => getFullFilePath(fp, baseDir)).filter(fp => !!fp);
}

/**
 * 获取文件的完整绝对路径
 * @param {String} filePath 文件路径
 * @param {String} baseDir 文件路径的相对路径
 */
function getFullFilePath(filePath, baseDir) {
 if (baseDir) {
  filePath = path.resolve(baseDir, filePath);
 } else {
  filePath = path.resolve(filePath);
 }

 if (fs.existsSync(filePath)) {
  const stat = fs.statSync(filePath);
  if (stat.isDirectory() && fs.existsSync(path.join(filePath, 'index.js'))) {
   return path.join(filePath, 'index.js');
  } else if (stat.isFile()){
   return filePath;
  }
 } else if (fs.existsSync(filePath + '.js')) {
  return filePath + '.js';
 }

 return '';
}

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

Javascript 相关文章推荐
jquery 获取标签名(tagName)示例代码
Jul 11 Javascript
jQuery对于显示和隐藏等常用状态的判断方法
Dec 13 Javascript
jquery实现点击label的同时触发文本框点击事件的方法
Jun 05 Javascript
jQuery倒计时代码(超简单)
Feb 27 Javascript
浅谈Vuex@2.3.0 中的 state 支持函数申明
Nov 22 Javascript
angularJs-$http实现百度搜索时的动态下拉框示例
Feb 27 Javascript
JavaScript轮播停留效果的实现思路
May 24 Javascript
解决angular2在双向数据绑定时[(ngModel)]无法使用的问题
Sep 13 Javascript
vue实现节点增删改功能
Sep 26 Javascript
在JavaScript中实现链式调用的实现
Dec 24 Javascript
原生js实现拖拽移动与缩放效果
Aug 24 Javascript
javascript遍历对象的五种方式实例代码
Oct 24 Javascript
详解js 创建对象的几种方法
Mar 08 #Javascript
浅谈Javascript常用正则表达式应用
Mar 08 #Javascript
validform表单验证的实现方法
Mar 08 #Javascript
webpack4.x下babel的安装、配置及使用详解
Mar 07 #Javascript
Webpack4 使用Babel处理ES6语法的方法示例
Mar 07 #Javascript
深入理解react 组件类型及使用场景
Mar 07 #Javascript
如何优雅地在vue中添加权限控制示例详解
Mar 07 #Javascript
You might like
PHP OPCode缓存 APC详细介绍
2010/10/12 PHP
php使用curl存储cookie的示例
2014/03/31 PHP
简单分析ucenter 会员同步登录通信原理
2014/08/25 PHP
PHP调试函数和日志记录函数分享
2015/01/31 PHP
PHP利用Mysql锁解决高并发的方法
2018/09/04 PHP
Laravel5.5 视图 - 创建视图和数据传递示例
2019/10/21 PHP
PHP7 windows支持
2021/03/09 PHP
jQuery 扩展对input的一些操作方法
2009/10/30 Javascript
javascript 鼠标拖动图标技术
2010/02/07 Javascript
Bootstrap被封装的弹层
2016/07/20 Javascript
轻松掌握JavaScript中介者模式
2016/08/26 Javascript
js编写的treeview使用方法
2016/11/11 Javascript
一个Js文件函数中调用另一个Js文件函数的方法演示
2017/08/14 Javascript
详解微信小程序调起键盘性能优化
2018/07/24 Javascript
详解用vue2.x版本+adminLTE开源框架搭建后台应用模版
2019/03/15 Javascript
node将geojson转shp返回给前端的实现方法
2019/05/29 Javascript
vue中通过使用$attrs实现组件之间的数据传递功能
2019/09/01 Javascript
JS函数本身的作用域实例分析
2020/03/16 Javascript
vue3自定义dialog、modal组件的方法
2021/01/04 Vue.js
vue3弹出层V3Popup实例详解
2021/01/04 Vue.js
[14:50]2018DOTA2亚洲邀请赛开幕式
2018/04/03 DOTA
详细解析Python当中的数据类型和变量
2015/04/25 Python
python 通过字符串调用对象属性或方法的实例讲解
2018/04/21 Python
python 将list转成字符串,中间用符号分隔的方法
2018/10/23 Python
Django 配置多站点多域名的实现步骤
2019/05/17 Python
详解python实现交叉验证法与留出法
2019/07/11 Python
解决PyCharm IDE环境下,执行unittest不生成测试报告的问题
2020/09/03 Python
美国领先的水果篮送货公司和新鲜水果供应商:The Fruit Company
2018/02/13 全球购物
戴森英国官网:Dyson英国
2019/05/07 全球购物
Johnson Fitness澳大利亚:高级健身器材
2021/03/16 全球购物
零件设计自荐信范文
2013/11/27 职场文书
《植物妈妈有办法》教学反思
2014/02/25 职场文书
小学数学教学经验交流材料
2014/05/22 职场文书
夫妻婚内购房协议书
2014/10/05 职场文书
房屋买卖委托书格式范本格式
2014/10/13 职场文书
批评与自我批评总结
2014/10/17 职场文书