如何将Socket.IO实例导出到独立文件并正常调用？

我尝试将Socket.IO实例分离到独立文件，以便任意文件导入使用，但遇到两个核心问题：

• 从index.js导出的io实例在其他文件中是无效的空对象
• 尝试创建socket.js分离代码时出现循环依赖警告，且emit函数无反应（函数阻塞但无报错）

当前index.js中的Socket.IO代码可正常运行，但跨文件调用时无法正常触发事件。

问题代码展示 #

actions.js（使用外部io实例的文件） #

const cron = require('node-cron')
const io = require('../index').io
module.exports.startActions = async (sessionID, userID, actionType, area = '', resume=false) => {
   /* setup code, no socket.io usage */
  const task = cron.schedule('*/6 * * * * *', async () => {
        /*
        all tasks run smoothly
        */
        // 无论io是否显示为对象，这段代码都不执行
        io.to(sessionID).emit('action-tick', {
            message: 'action tick',
            actionType: actionType,
            time: Date.now(),
            interval: 6, // seconds
            actionsLeft: actionsRemaining
        })
        console.log('emitted') // 从未打印
    }, {
        name: sessionID
    })
  }
}

当前index.js（Socket.IO可正常运行） #

const express = require('express'); 
const bodyParser = require('body-parser');
const app = express(); 
const PORT = 3000; 

const cors = require('cors')
const fs = require('fs')

const http = require('http')

const socketIO = require('socket.io');
const server = http.createServer(app)


const session = require('express-session')
const mongoStore = require('connect-mongo'); // 原代码遗漏的导入

const sessionConfig = session({
    secret: '[secret key]',
    cookie: {
        httpOnly: false,
        secure:  false, 
        sameSite: 'lax',
        maxAge: 1000*60*60*24,
    },
    saveUninitialized: false,
    resave: false,
    store: mongoStore.create({
        mongoUrl: process.env.DB_CONNECT_URI,
    })
})

app.use(sessionConfig)


app.use(cors({
    origin: "http://localhost:5173",
    credentials: true,
}))
app.use(bodyParser.json());


server.listen(PORT, (error) =>{ 
    if(!error) 
        console.log("Server is Successfully Running, and App is listening on port " + PORT) 
    else 
        console.log("Error occurred, server can't start", error); 
    } 
);

const io = socketIO(server)
io.engine.use(sessionConfig)

io.use((socket, next) => {
const checkSession = (socket) => {
        if (!socket.request.session) {
        console.log('no session, logging out')
        io.to(socket.id).emit('logout')
    } else {
        console.log('credentials good')
    }
}
})

io.on('connection', (socket) => {
// 所有socket.on逻辑均可正常运行
})

module.exports.io = io  // 其他文件导入时通常是{}，无实际作用
module.exports.server = server

尝试分离的socket.js（存在循环依赖和实例无效问题） #

const server = require('./index').server

const io = new Server(server, {
// 尝试过各种合理的CORS配置
    cors: {
        origin: "http://localhost:5173", 
        methods: ["GET", "POST"],
        credentials: true,
    }

})

module.exports = io

解决方案 #

1. 重构socket.js：延迟初始化+实例获取函数 #

通过延迟初始化消除循环依赖，同时提供安全的实例获取方式：

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

// 初始化Socket.IO实例
function initIO(server, sessionConfig) {
  if (!io) {
    io = new Server(server, {
      cors: {
        origin: "http://localhost:5173",
        methods: ["GET", "POST"],
        credentials: true,
      }
    });

    // 挂载session中间件
    io.engine.use(sessionConfig);

    // Socket连接中间件（修复原代码未调用next()的问题）
    io.use((socket, next) => {
      const checkSession = () => {
        if (!socket.request.session) {
          console.log('no session, logging out')
          socket.emit('logout')
        } else {
          console.log('credentials good')
        }
      };
      checkSession();
      next(); // 必须调用next()，否则连接会被阻塞
    });

    // Socket连接事件处理
    io.on('connection', (socket) => {
      // 将原index.js中的socket.on逻辑迁移到这里
      console.log(`user connected: ${socket.id}`);
      // 其他事件处理代码...
    });
  }
  return io;
}

// 获取已初始化的IO实例
function getIO() {
  if (!io) {
    throw new Error('Socket.IO未初始化，请先调用initIO');
  }
  return io;
}

module.exports = { initIO, getIO };

2. 修改index.js：调用initIO初始化实例 #

在index.js中创建server后，初始化Socket.IO：

const express = require('express'); 
const bodyParser = require('body-parser');
const app = express(); 
const PORT = 3000; 

const cors = require('cors')
const http = require('http')
const session = require('express-session')
const mongoStore = require('connect-mongo');

const sessionConfig = session({
    secret: '[secret key]',
    cookie: {
        httpOnly: false,
        secure: false, 
        sameSite: 'lax',
        maxAge: 1000*60*60*24,
    },
    saveUninitialized: false,
    resave: false,
    store: mongoStore.create({
        mongoUrl: process.env.DB_CONNECT_URI,
    })
})

app.use(sessionConfig)
app.use(cors({
    origin: "http://localhost:5173",
    credentials: true,
}))
app.use(bodyParser.json());

// 创建HTTP服务器
const server = http.createServer(app)

// 导入并初始化Socket.IO
const { initIO } = require('./socket');
const io = initIO(server, sessionConfig);

server.listen(PORT, (error) =>{ 
    if(!error) 
        console.log("Server is Successfully Running, and App is listening on port " + PORT) 
    else 
        console.log("Error occurred, server can't start", error); 
});

// 可选：导出实例供其他文件使用
module.exports.io = io;
module.exports.server = server;

3. 修改actions.js：使用getIO获取有效实例 #

const cron = require('node-cron')
const { getIO } = require('../socket');

module.exports.startActions = async (sessionID, userID, actionType, area = '', resume=false) => {
   /* setup code, no socket.io usage */
  const task = cron.schedule('*/6 * * * * *', async () => {
        /*
        all tasks run smoothly
        */
        const io = getIO();
        io.to(sessionID).emit('action-tick', {
            message: 'action tick',
            actionType: actionType,
            time: Date.now(),
            interval: 6, // seconds
            actionsLeft: actionsRemaining
        })
        console.log('emitted') // 现在可正常打印
    }, {
        name: sessionID
    })
  }
}

关键修复点 #

• 消除循环依赖：通过延迟初始化，让index.js创建server后再初始化Socket.IO，避免socket.js直接引用index.js
• 修复中间件阻塞：原io.use中未调用next()，导致Socket连接被卡住，必须调用next()让流程继续
• 确保实例有效性：使用getIO()确保获取的是已经初始化完成的Socket.IO实例，避免导入时实例未创建导致的空对象问题

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