如何在Node.js控制器中使用Socket.io的emit、广播功能及传递实例

下面给你几个直接能用的实现方式，适配你的业务场景：

方案1：把IO实例挂载到Express App上 #

1. 在index.js初始化IO后，把它和用户socket映射表挂载到Express的app对象上：

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

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

// 挂载IO实例到app
app.set('io', io);

// 存储用户ID与socket的映射（需要在用户连接时关联）
const userSocketMap = new Map();

io.on('connection', (socket) => {
  // 假设前端连接时通过query传递用户ID
  const userId = socket.handshake.query.userId;
  if (userId) {
    userSocketMap.set(userId, socket);
  }

  socket.on('disconnect', () => {
    userId && userSocketMap.delete(userId);
  });
});

// 把映射表也挂载到app
app.set('userSocketMap', userSocketMap);

2. 在updateUserBio控制器里，通过req.app.get()获取实例并使用：

// updateUserBio控制器
async function updateUserBio(req, res) {
  try {
    const { userId } = req.params;
    // 执行更新Bio的业务逻辑
    const updatedUser = await User.findByIdAndUpdate(userId, req.body, { new: true });

    // 获取IO实例和用户socket
    const io = req.app.get('io');
    const userSocketMap = req.app.get('userSocketMap');
    const targetSocket = userSocketMap.get(userId);

    // 给当前用户发成功通知
    targetSocket?.emit('bioUpdateSuccess', { bio: updatedUser.bio });
    // 广播给其他在线用户（如果需要）
    io.broadcast.emit('userBioUpdated', { userId, bio: updatedUser.bio });

    res.status(200).json(updatedUser);
  } catch (error) {
    const { userId } = req.params;
    const targetSocket = req.app.get('userSocketMap').get(userId);
    
    targetSocket?.emit('bioUpdateFailed', { error: error.message });
    res.status(500).json({ error: error.message });
  }
}

方案2：创建独立的Socket管理模块 #

1. 新建socketManager.js，统一管理Socket.IO实例和用户映射：

// socketManager.js
const { Server } = require('socket.io');

let io;
const userSocketMap = new Map();

// 初始化IO
function initIO(server) {
  io = new Server(server);
  
  io.on('connection', (socket) => {
    const userId = socket.handshake.query.userId;
    userId && userSocketMap.set(userId, socket);

    socket.on('disconnect', () => {
      userId && userSocketMap.delete(userId);
    });
  });

  return io;
}

// 获取IO实例
function getIO() {
  if (!io) throw new Error('Socket.IO未初始化');
  return io;
}

// 获取指定用户的socket
function getUserSocket(userId) {
  return userSocketMap.get(userId);
}

module.exports = { initIO, getIO, getUserSocket };

2. 在index.js中初始化该模块：

// index.js
const express = require('express');
const http = require('http');
const { initIO } = require('./socketManager');

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

// 初始化Socket.IO
initIO(server);

3. 控制器直接引入模块使用：

// updateUserBio控制器
const { getIO, getUserSocket } = require('../socketManager');

async function updateUserBio(req, res) {
  try {
    const { userId } = req.params;
    const updatedUser = await User.findByIdAndUpdate(userId, req.body, { new: true });

    const targetSocket = getUserSocket(userId);
    const io = getIO();

    targetSocket?.emit('bioUpdateSuccess', { bio: updatedUser.bio });
    io.broadcast.emit('userBioUpdated', { userId, bio: updatedUser.bio });

    res.status(200).json(updatedUser);
  } catch (error) {
    const targetSocket = getUserSocket(req.params.userId);
    targetSocket?.emit('bioUpdateFailed', { error: error.message });
    res.status(500).json({ error: error.message });
  }
}

方案3：路由层直接传递IO实例 #

如果不想用全局挂载或独立模块，可以在路由定义时把IO传进控制器：

1. index.js中把IO传给路由：

// index.js
const userRoutes = require('./routes/userRoutes');
// 初始化完io后
app.use('/api/users', userRoutes(io));

2. 修改路由文件，接收IO并传递给控制器：

// userRoutes.js
const express = require('express');
const { updateUserBio } = require('../controllers/userController');

module.exports = (io) => {
  const router = express.Router();
  // 把io作为参数传给控制器
  router.put('/:userId/bio', (req, res) => updateUserBio(req, res, io));
  return router;
};

3. 控制器接收IO参数并使用：

// updateUserBio控制器
async function updateUserBio(req, res, io) {
  try {
    const { userId } = req.params;
    const updatedUser = await User.findByIdAndUpdate(userId, req.body, { new: true });

    // 用Socket.IO的房间功能（推荐）：用户连接时加入自己ID的房间
    io.to(userId).emit('bioUpdateSuccess', { bio: updatedUser.bio });
    io.broadcast.emit('userBioUpdated', { userId, bio: updatedUser.bio });

    res.status(200).json(updatedUser);
  } catch (error) {
    io.to(req.params.userId).emit('bioUpdateFailed', { error: error.message });
    res.status(500).json({ error: error.message });
  }
}

小提醒 #

• 要给特定用户发消息，必须维护用户ID与socket的关联，用Socket.IO的房间功能（每个用户加入自己ID的房间）比手动维护映射更省心。
• 如果不需要精准推送，直接用io.emit()就能给所有在线用户发消息。

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