Socket.IO开发中io与socket对象的适用场景差异解答

核心概念定义 #

• io：Socket.IO服务端的顶层实例，绑定在启动的HTTP/HTTPS服务上，代表整个Socket.IO服务本身，负责管理所有已连接的客户端、全局命名空间、全局中间件，作用范围覆盖全服务。
• socket：单个客户端与服务端建立连接后生成的独立实例，每一个连入服务的客户端都会对应一个全局唯一的socket对象，代表服务端与这个特定客户端之间的点对点连接通道，作用范围仅覆盖单个客户端连接。

方法使用规则对比 #

事件监听：io.on() vs socket.on() #

• io.on()：仅用于监听服务端全局层级的系统事件，最常用的场景是监听新客户端连接事件，几乎不会用来监听业务自定义事件：

// 标准全局连接监听写法：回调参数为新连入客户端对应的socket实例
io.on('connection', (socket) => {
  // 所有和单个客户端相关的业务逻辑，都需要写在这个回调作用域内
})

• socket.on()：用于监听当前socket对应客户端发来的所有事件，包括客户端触发的自定义业务事件、连接生命周期事件：

io.on('connection', (socket) => {
  // 监听当前客户端发来的聊天消息事件
  socket.on('send_chat_msg', (msgContent) => {
    console.log('收到当前客户端消息：', msgContent)
  })
  // 监听当前客户端断开连接的生命周期事件
  socket.on('disconnect', () => {
    console.log('当前客户端已断开连接')
  })
})

消息发送：io.emit() vs socket.emit() #

• io.emit()：触发全局广播，向当前命名空间下所有已连接的客户端推送事件，无差别覆盖所有在线用户：

// 场景：推送全员系统公告
io.emit('system_notice', { content: '系统将于今晚22点进行版本升级维护' })

补充：如果需要给除了当前触发事件的客户端之外的所有用户推送消息，可以使用socket.broadcast.emit，该方法会自动跳过当前socket对应的客户端。

• socket.emit()：触发点对点定向推送，仅向当前socket对应的单个客户端发送事件，精准触达特定用户：

io.on('connection', (socket) => {
  // 场景：客户端连入成功后，单独给该客户端返回连接成功状态
  socket.emit('connect_success', { code: 0, msg: '服务端连接已建立' })
})

常见使用误区 #

• 不要在io.on('connection', (socket) => {})的回调作用域外调用socket.on或socket.emit，外部作用域无法获取单个客户端对应的socket实例，会直接抛出引用错误。
• 不要用io.on监听自定义业务事件，类似io.on('send_chat_msg', () => {})属于无效写法，所有客户端主动触发的业务事件都需要通过对应连接的socket实例监听。
• 全员推送场景不要误用socket.emit，该方法仅会给当前单个客户端发消息，其余在线用户无法收到消息，全量推送必须使用io.emit。

速记规则：
涉及全服务、所有连接的操作统一用io实例，涉及单个特定客户端连接的操作统一用对应socket实例。

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