Node.js链式require引入models/index导出Game为undefined问题排查

该问题100%是Node.js CommonJS模块规范的循环依赖加载机制导致的，单独执行node db/game-db.js不会触发循环，而在Express项目启动时存在其他依赖链路形成了循环，才会出现该异常。

CommonJS处理循环依赖的逻辑是：当A模块和B模块互相依赖时，模块加载到一半时遇到另一个模块的require请求，会直接返回当前模块已完成赋值的exports对象快照，不会等待模块完全执行完毕。

你遇到的典型触发场景如下：
假设你的项目中存在如下依赖链路：

1. Express入口文件启动时，先加载了models/index.js
2. models/index.js按顺序执行导出，先导出其他模块（比如User: require('./user')）
3. user.js的顶层代码中引入了db/game-db.js
4. db/game-db.js的顶层代码引入../models拿Game属性，此时models/index.js还没执行到Game: require('./game')的赋值逻辑，exports对象里还没有Game属性，因此拿到的就是undefined

另一种场景是game.js的顶层代码直接/间接引入了db/game-db.js，形成了完整的循环依赖链，也会触发该问题。

• 先在db/game-db.js中打印完整的models导出对象，确认是否是部分属性缺失：

  console.log('当前models导出内容：', require('../models'))
  const GameModel = require('../models').Game
  

• 启动项目时添加Node.js原生参数打印循环依赖链路，直接定位问题：

  node --trace-cycle 你的项目入口文件.js # 一般是app.js或index.js
  

• 手动排查依赖链：重点核对models目录下的所有文件、db目录下的所有文件是否存在互相引用的情况，以及models/index.js的导出顺序。

1. 调整models/index.js的导出顺序，把Game的导出放到所有可能触发循环依赖的模块之前：

   module.exports = {
       Game: require('./game'), // 放最前面
       User: require('./user'),
       // 其他导出
   }
   

2. 把循环依赖的require调用从模块顶层移到函数内部延迟加载，避免模块初始化阶段形成循环：
   比如如果user.js需要用到db/game-db.js的方法，就不要在顶部写require，放到具体调用的函数内部即可。
3. 直接用require('../models/game')的方式引入，避开走models/index.js的导出链路，从根源避开循环依赖的影响。

内容的提问来源于stack exchange，提问作者spcb