Node.js使用Socket.IO向房间emit事件时客户端无响应问题求助

问题背景 #

我正在使用Node.js结合Socket.IO开发一款游戏，通过双向事件emit实现客户端与服务端之间的数据传输。前期学习和开发都比较顺利，但当前遇到了一个完全无法解决的问题。我的游戏采用房间机制，玩家输入房间码加入对应房间后，我会向指定房间emit游戏专属数据。

正常运行的代码示例 #

/**
 *  The amount of time to answer the questions is over
 *  @param data - room number
 */
socket.on('timesUp', function (data) {
    console.log("Times UP!");
    console.log(data.roomNum);
    socket.emit('startVoting');
})

异常运行的代码 #

socket.on('playersVote', function (data) {
    console.log("playersVote data: " + data.playerOneResponse);
    console.log(data.roomNum);
    socket.to(data.roomNum).emit('playerStartVoting', {pOne: data.playerOneResponse, pTwo: data.playerTwoResponse} );
    console.log("after io emission");
})

服务端日志确认事件已到达，所有日志输出正常：

playersVote data: [object Object]
{
  question: null,
  response: 'c',
  name: 'w',
  id: 'TW_92Ojct1EyhhE5AAAL',
  roomNum: '845'
}
845
after io emission

客户端监听代码 #

客户端事件监听逻辑：

IO.socket.on('playerStartVoting', IO.onPlayerStartVoting);

回调方法实现：

onPlayerStartVoting: function (data) {
    console.log("voting started");
    if (data.pOne.id === App.mySocketID || data.pTwo.id === App.mySocketID) {
        App.Player.displayBlank();
    }
    else {
        App.Player.vote(data);
    }
},

客户端始终没有打印"voting started"日志，事件没有触发客户端回调。

解决方案 #

核心问题原因 #

Socket.IO中socket.to(roomId).emit()的默认逻辑是向目标房间内除了当前触发事件的socket之外的所有客户端推送事件，如果你测试时只有触发playersVote的这一个客户端在房间里，或者你想让触发事件的客户端也收到推送，自然收不到事件。

修复方案 #

如果需要给房间内所有客户端（包括当前触发事件的socket）推送事件，把socket.to(data.roomNum).emit()替换为全局IO实例的to方法调用：

// 先确保你已经在服务端初始化了io实例，比如const io = require('socket.io')(server)
io.to(data.roomNum).emit('playerStartVoting', {pOne: data.playerOneResponse, pTwo: data.playerTwoResponse} );

其他排查点 #

如果修改后仍有问题，可以按以下顺序排查：

• 确认客户端加入房间的逻辑没有错误，服务端可以打印io.sockets.adapter.rooms.get(data.roomNum)查看当前房间内的socketid列表，确认目标客户端确实在房间内
• 确认服务端和客户端的Socket.IO大版本一致，v2和v3/v4的房间API存在不兼容问题
• 检查事件名拼写，确认服务端emit的playerStartVoting和客户端监听的事件名完全一致，大小写没有错误

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