Node.js中Socket.io循环依赖报错及模块找不到问题求助

问题根源 #

循环依赖的核心原因是server.js与authController.js互相导入：比如server.js初始化Socket.io后导入authController，而authController又试图从server.js中获取io实例，此时模块加载未完成，就会触发non-existent property 'io'警告；MODULE_NOT_FOUND则大概率是执行命令时文件路径或名称拼写错误。

具体解决方案 #

方案1：将Socket.io实例注入控制器 #

避免互相导入，改为从server.js主动传递io实例给控制器：

1. 修改server.js：

const express = require('express');
const http = require('http');
const { Server } = require('socket.io');
const authController = require('./authController');

const app = express();
const server = http.createServer(app);
const io = new Server(server);

// 将io实例注入authController
authController.initSocket(io);

server.listen(3000, () => {
  console.log('Server running on port 3000');
});

2. 修改authController.js：

let io;

// 接收并保存io实例
exports.initSocket = (socketInstance) => {
  io = socketInstance;
};

// 发送消息示例（可直接使用io）
exports.sendMessage = (req, res) => {
  const { message, userId } = req.body;
  io.emit('new-message', { userId, message });
  res.status(200).json({ success: true });
};

// 登录、注册等其他逻辑...

方案2：抽离独立的Socket.io模块 #

把Socket.io的初始化逻辑单独放在一个文件，让两个模块都从这里获取实例：

1. 创建socket.js：

const { Server } = require('socket.io');
let io;

// 初始化io实例
exports.init = (server) => {
  io = new Server(server);
  return io;
};

// 提供获取io的方法
exports.getIO = () => {
  if (!io) {
    throw new Error('Socket.io未初始化');
  }
  return io;
};

2. 修改server.js：

const express = require('express');
const http = require('http');
const socketService = require('./socket');
const authController = require('./authController');

const app = express();
const server = http.createServer(app);

// 初始化Socket.io
socketService.init(server);

server.listen(3000, () => {
  console.log('Server running on port 3000');
});

3. 修改authController.js：

const socketService = require('./socket');

exports.sendMessage = (req, res) => {
  const { message, userId } = req.body;
  const io = socketService.getIO();
  io.emit('new-message', { userId, message });
  res.status(200).json({ success: true });
};

// 其他逻辑...

解决MODULE_NOT_FOUND错误 #

执行node --trace-warnings命令时，确保在项目根目录运行，且文件名/路径正确，例如：

node --trace-warnings server.js

检查是否有拼写错误，或目标文件是否确实存在于当前目录。

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