事件发送与监听
🎯 引言
上一篇只有服务器发送欢迎语。现在让客户端直接发送一句“你好”,服务端收到后返回“已收到”。完成这一步,你就能把自己的业务数据从客户端送到后端,再把处理结果传回来。
🧱 事件名和数据怎样对应
发送事件用 emit,接收事件用 on。例如 socket.emit('chat:send', '你好') 中,chat:send 是事件名,你好 是数据。另一端提前注册 socket.on('chat:send', ...),才能在收到这个事件时执行对应函数。
注册监听表示“以后发生这件事就调用这个函数”,调用 on 的当下不会立刻处理一条消息。事件名必须一致,chat:send 和 chat:Send 是两个名字。冒号只是便于命名,可以理解为“聊天业务里的发送动作”。
🛠 发送一句话,收到一次回复
在 server.mjs 原有 connection 回调里,欢迎语下面增加以下代码。
socket.on('chat:send', (text) => {
console.log('收到消息', text);
socket.emit('chat:message', `已收到:${text}`);
});
socket.emit 从服务端发送时,目标就是当前这个 socket 对应的客户端。此时每个人只会收到自己的回复,下一类课程再实现多个用户之间的分发。
将 client.mjs 替换为下面的代码。连接成功后直接发送“你好”。
import { io } from 'socket.io-client';
const socket = io('http://localhost:3000');
socket.on('connect', () => {
console.log('连接成功');
socket.emit('chat:send', '你好');
});
socket.on('chat:message', (text) => {
console.log('收到', text);
});
socket.on('connect_error', (error) => {
console.log('连接失败', error.message);
});
io() 自动发起连接。连接成功后,Socket.IO 触发客户端的 connect,我们在回调里调用 emit 发送消息。服务端收到 chat:send 后回传 chat:message,客户端对应的监听函数打印结果。
先按 Ctrl+C 停止旧服务和旧客户端,再分别执行 node server.mjs、node client.mjs。客户端启动后自动发送,预期输出如下。
服务端终端
服务已启动:http://localhost:3000客户端已连接 <连接ID>收到消息 你好
客户端终端
连接成功收到 已收到:你好
其中 <连接ID> 是运行时生成的编号。修改 emit 的第二个参数为“测试消息”,重新运行客户端,就能看到对应文字发生变化。
🧰 可以发送哪些数据
字符串适合一句文字,如果同时传消息内容和昵称,可以传普通对象。
socket.emit('chat:send', { text: '你好', nickname: '用户A' });
服务端监听函数的第一个参数这时就是对象,用 message.text 读取文字。两端必须一起调整数据约定,下一篇仍沿用字符串,不需要现在修改项目。
Socket.IO 能直接传普通对象、数组及二进制数据,普通对象无须手动 JSON.stringify。函数通常不能作为普通业务数据传输,下一篇会介绍最后一个回调参数的特殊用途。事件发送文档
持续监听、一次监听和取消监听
on 每收到一次同名事件都会执行。如果只想在第一次收到消息时打印提示,可以使用 once,它执行一次后自动移除自己。
socket.once('chat:message', () => {
console.log('第一次消息往返完成');
});
需要停止处理某个事件时,用 off 移除对应的监听函数。
function handleMessage(text) {
console.log(text);
}
socket.on('chat:message', handleMessage);
socket.off('chat:message', handleMessage);
off 接收注册时的同一个函数。这里紧接着取消了监听,所以后续消息不会再交给 handleMessage 处理。连接本身仍然保持。事件监听文档
❓ 知识问答
Q1:为什么一条消息被打印两次?
检查是否为同一个事件重复注册了两个会打印的监听。每次调用 on 都会增加一个函数。本课程把业务监听放在客户端初始化时注册,服务端则为每条新连接注册一次。
Q2:客户端发出了事件,服务端就一定执行成功了吗?
还需要确认事件名匹配、数据能被处理,且业务没有报错。下一篇让服务端明确返回成功或拒绝结果。
🧪 小练习
在客户端增加一次性监听,并在 connect 回调里连续调用三次 emit,分别发送“第一条”“第二条”“第三条”。正常回复应有三条,“第一次消息往返完成”只应出现一次。再临时改错客户端发送的事件名,确认服务端没有打印对应消息,随后恢复名称。
🎉 你现在可以沿着事件名找到消息发送、后端处理和结果接收的位置。
