房间加入与分组聊天
🎯 引言
公共广播会把消息送给所有在线用户。现在希望用户A和用户B进入同一聊天室时能互相收到消息,进入不同聊天室时互不影响。Socket.IO 的 Room,也就是房间,用来按名称把连接分组,再向指定组发送消息。
🧱 房间由服务端管理
房间是一组连接的集合,用房间名标识。第一个连接加入时,Socket.IO 会创建这个房间,最后一个连接离开后会自动移除空房间,无须单独调用“创建房间”接口。
服务端用 socket.join(name) 加入房间,用 socket.leave(name) 离开房间。客户端通过自定义事件提出请求,再由服务端决定是否执行。连接断开时,Socket.IO 会自动让它退出所有房间。
沿用上一篇的 server.mjs 和已安装的依赖。在现有 connection 回调里、聊天监听之前,加入下面的代码。我们只开放 room1 和 room2,并约定每个客户端当前只在一个房间聊天。Socket.IO 本身允许一个连接同时加入多个房间,这里为了让“发到当前聊天室”的规则明确,采用单房间约定。
socket.on('room:join', async (name, reply) => {
if (typeof reply !== 'function') {
return;
}
if (!['room1', 'room2'].includes(name)) {
reply({ ok: false, error: '该房间未开放' });
return;
}
if (socket.data.room && socket.data.room !== name) {
reply({ ok: false, error: '请先退出当前房间' });
return;
}
await socket.join(name);
socket.data.room = name;
reply({ ok: true, room: name });
});
room:join 是我们定义的事件名,客户端必须用 emit 发起它。处理函数先检查房间名和当前状态,允许后才调用 socket.join(name)。
socket.data 用于保存这条连接的业务数据。这里把当前房间名记到 socket.data.room,供后面的发送和退出操作读取。仅给这个字段赋值不会加入房间,实际成员关系由 join 和 leave 管理。
单独处理退出房间
在同一个 connection 回调里,另加一个 room:leave 监听。
socket.on('room:leave', async (reply) => {
if (typeof reply !== 'function') {
return;
}
if (socket.data.room) {
await socket.leave(socket.data.room);
socket.data.room = null;
}
reply({ ok: true });
});
客户端发出 room:leave 时,服务端退出当前房间并清空记录。因为没有额外业务参数,确认函数就是监听函数的第一个参数。退出房间后连接仍然保持,可以继续请求加入其他房间。
消息发到当前房间
用下面的完整监听替换上一节的 chat:send。新增的是“是否已经加入房间”的检查,以及只向当前房间发送消息。
socket.on('chat:send', (text, reply) => {
if (typeof reply !== 'function') {
return;
}
if (!socket.data.room) {
reply({ ok: false, error: '请先加入房间' });
return;
}
if (typeof text !== 'string' || !text.trim() || text.trim().length > 100) {
reply({ ok: false, error: '请输入 1~100 个字符' });
return;
}
io.to(socket.data.room).emit('chat:message', {
senderId: socket.id,
text: text.trim()
});
reply({ ok: true });
});
上一节的 io.emit 会发送给所有连接,这里用 io.to(房间名).emit 限定接收范围,包含房间内的发送者。只想通知同房间的其他连接时,可以使用 socket.to(房间名).emit。房间文档
🛠 验证同房间接收、不同房间隔离
将 client.mjs 替换为下面的代码。客户端连接成功后先请求加入,收到成功确认后再发消息。
import { io } from 'socket.io-client';
const socket = io('http://localhost:3000');
const room = 'room1';
const text = '用户A的消息';
socket.on('chat:message', (message) => {
console.log('收到消息', message.text);
});
socket.on('connect_error', (error) => {
console.log('连接失败', error.message);
});
socket.on('connect', () => {
socket.emit('room:join', room, (result) => {
console.log('加入结果', result);
if (!result.ok) {
return;
}
socket.emit('chat:send', text, (reply) => {
console.log('发送结果', reply);
});
});
});
重启服务,运行 node client.mjs,保持用户A在线。复制该文件为 client-b.mjs,把 text 改为“用户B的消息”,再按下表修改 room 并运行 node client-b.mjs。每次修改前先结束旧的用户B进程。
| 用户B的 room | 用户A(room1) | 用户B |
|---|---|---|
| room1 | 收到“用户B的消息” | 加入成功,收到自己的消息,发送成功 |
| room2 | 没有新消息 | 加入成功,收到自己的消息,发送成功 |
要测试退出,把用户B加入成功回调中的 chat:send 调用替换为:
socket.emit('room:leave', (result) => {
console.log('退出结果', result);
});
重新运行后应打印 退出结果 { ok: true }。连接仍保持,但不再接收该房间的新消息。
❓ 知识问答
Q1:用户自己知道房间名,就有权加入吗?
还要由服务端检查业务权限。例如私有群聊应先查用户是否属于该群,再执行 join。本例只检查房间是否开放,任何成功连接的客户端都可以选择 room1 或 room2。
Q2:再次加入同一个房间,会重复收到消息吗?
同一连接在一个房间里只会有一份成员记录。重复 join 同一个房间不会让它因成员重复而收到多份广播。消息重复时,应检查是否执行了多次 emit 或注册了多个打印消息的监听。
🧪 小练习
在用户B的加入成功回调中,分别修改后续操作,逐项验证:
- 加入 room1 后直接请求加入 room2,应返回“请先退出当前房间”,仍留在 room1。
- 加入 room1 后先请求退出,等退出成功再请求加入 room2,应返回加入成功。
- 加入后先退出,等退出成功再发一条聊天消息,应返回“请先加入房间”。
每次修改后重新运行用户B客户端,以新的连接开始实验。
🎉 现在不同聊天室可以共用一个服务,并各自接收消息。
