Node.js中如何在REST接口中获取Socket.io的IO实例并实现协同调用

问题描述 #

我正在Node.js应用中使用Socket.io包，希望在REST接口调用里访问IO实例。目前我的代码结构如下：

index.js #

const app = express();
const newServer = require('http').Server(app);
const { Server } = require('socket.io');
const io = new Server(newServer);
app.use("/restApiCall", require("./apis"));
newServer.listen(8002, () => {
 console.log(`Server listening to port 8002`);
});

apis.js #

const express = require("express");
const router = express.Router();
const SubmoduleController = require("./controllers/subModule.js");
router.route('/abc').post(SubmoduleController.updateAbc);

subModule.js #

module.exports = {
 updateAbc: async function (req, res, next) {
 /*** 此处我希望获取Socket.io的IO实例并向UI发送消息 ***/
 }
}

IO实例定义在index.js中，但REST接口代码分布在不同文件里，请问该怎么传递这个实例实现需求？

解决方案 #

我给你分享几个Node.js项目里常用的Socket.io实例共享方案，你可以根据项目规模和代码结构选最合适的：

方法1：把IO实例挂载到Express的app对象上 #

这是最快捷的方式，因为Express的req对象可以通过req.app访问主app实例，我们只需要先把io挂载上去：

修改index.js：

const app = express();
const newServer = require('http').Server(app);
const { Server } = require('socket.io');
const io = new Server(newServer);

// 将io实例挂载到app对象上
app.set('io', io);

app.use("/restApiCall", require("./apis"));
newServer.listen(8002, () => {
 console.log(`Server listening to port 8002`);
});

然后在subModule.js里通过req.app.get('io')获取实例：

module.exports = {
 updateAbc: async function (req, res, next) {
  // 获取io实例
  const io = req.app.get('io');
  // 向所有客户端广播消息
  io.emit('update-abc', { message: 'ABC数据已更新' });
  
  // 处理你的业务逻辑...
  res.status(200).json({ success: true });
 }
}

方法2：创建单独的Socket.io模块导出IO实例 #

这种方式更适合中大型项目，模块化程度更高，把io的初始化逻辑抽离成单独文件：

新建socket.js文件：

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

module.exports = {
  // 初始化socket.io并绑定到http服务器
  init: (httpServer) => {
    io = new Server(httpServer);
    return io;
  },
  // 获取已初始化的io实例
  getIO: () => {
    if (!io) {
      throw new Error('Socket.io未初始化，请先调用init方法');
    }
    return io;
  }
};

修改index.js：

const app = express();
const newServer = require('http').Server(app);
const socket = require('./socket');

// 初始化socket.io
const io = socket.init(newServer);

app.use("/restApiCall", require("./apis"));
newServer.listen(8002, () => {
 console.log(`Server listening to port 8002`);
});

然后在subModule.js里直接导入获取：

const socket = require('../../socket'); // 根据你的文件路径调整

module.exports = {
 updateAbc: async function (req, res, next) {
  const io = socket.getIO();
  // 向特定房间发送消息（如果需要）
  io.to('user-room-123').emit('update', { data: req.body });
  
  // 业务逻辑处理...
  res.sendStatus(200);
 }
}

方法3：通过路由传递IO实例（依赖注入） #

这种方式更显式，适合需要明确管理依赖的场景，在导入路由时把io实例传进去：

修改apis.js，让路由接收io参数：

const express = require("express");
const router = express.Router();
const SubmoduleController = require("./controllers/subModule.js");

// 定义一个函数，接收io实例并返回配置好的路由
module.exports = (io) => {
  router.route('/abc').post((req, res, next) => {
    // 把io挂载到req对象上，方便控制器使用
    req.io = io;
    SubmoduleController.updateAbc(req, res, next);
  });
  
  return router;
};

修改index.js，传递io给路由：

const app = express();
const newServer = require('http').Server(app);
const { Server } = require('socket.io');
const io = new Server(newServer);

// 导入路由时传入io实例
app.use("/restApiCall", require("./apis")(io));

newServer.listen(8002, () => {
 console.log(`Server listening to port 8002`);
});

然后在subModule.js里通过req.io获取：

module.exports = {
 updateAbc: async function (req, res, next) {
  const io = req.io;
  io.emit('system-notice', { content: '有新的更新操作' });
  
  // 业务处理...
  res.json({ status: 'success' });
 }
}

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