Socket.IO 简介与环境搭建
🎯 引言
用户A给用户B发了一条聊天消息。用户B一直停留在聊天页面上,服务器怎样把新消息送过去?Socket.IO 可以建立一条持续的通信连接,让客户端发送消息,也让服务端主动通知客户端。本课程从第一次连接开始,逐步完成一个能分房间聊天、校验身份、处理断线的 Node.js 服务。
🧱 为什么需要 Socket.IO
普通 HTTP 请求由客户端发起,服务器处理后返回响应。读取文章、查询订单,都可以采用这种方式。聊天窗口一直开着时,新消息可能随时到来,客户端可以每隔几秒请求一次,但没有新消息时也要查询,刚发出的消息还可能要等到下一次查询。
实时通信让服务器有新数据时就能主动推送。Socket.IO 是帮助应用实现双向实时通信的库。双向表示客户端能发送给服务端,服务端也能主动发送给客户端;实时表示尽量在变化发生后及时传递,实际速度仍受网络和处理时间影响。
Socket.IO 由两部分配合工作。服务端安装 socket.io,等待连接并处理业务;客户端安装 socket.io-client,发起连接并接收结果。客户端可以运行在浏览器,也可以运行在另一个 Node.js 进程。本课程用 Node.js 客户端模拟用户操作,在终端中直接观察服务端的处理效果。
它可以用在哪里
| 业务 | 客户端发送什么 | 服务端推送什么 |
|---|---|---|
| 聊天室 | 消息内容、要进入的房间 | 新消息、成员变化 |
| 订单进度 | 订阅某笔订单 | 已接单、配送中等状态 |
| 协作工具 | 当前修改内容 | 其他成员的修改结果 |
Socket.IO 可以使用 WebSocket 传输数据。WebSocket 是一种双向传输协议,Socket.IO 在其上提供命名事件、广播和重连等功能。两端需要使用兼容的 Socket.IO 实现,浏览器原生 WebSocket 接口不能直接充当 Socket.IO 客户端。Socket.IO 官方简介
🧰 准备运行环境
本课程面向 Socket.IO 零基础读者。代码使用 JavaScript 函数和 Node.js 模块,每次引入 Socket.IO API 都会解释用途。Node.js 用来运行 JavaScript,npm 随 Node.js 安装,用来下载项目依赖。
示例环境为 Node.js 24.19.0、socket.io 4.8.1、socket.io-client 4.8.1。先在终端执行 node -v 和 npm -v 确认环境可用,再逐行运行下面的命令。
mkdir socket-chat
cd socket-chat
npm init -y
npm install --save-exact socket.io@4.8.1 socket.io-client@4.8.1
npm init -y 创建记录项目配置的 package.json,安装命令把依赖和版本写进去。.mjs 文件让 Node.js 使用 import 模块语法,无须额外修改模块配置。
🛠 第一次连接
创建 server.mjs,写入以下代码。
import { createServer } from 'node:http';
import { Server } from 'socket.io';
const httpServer = createServer();
const io = new Server(httpServer);
io.on('connection', (socket) => {
console.log('客户端已连接', socket.id);
socket.emit('welcome', '欢迎进入聊天室');
});
httpServer.listen(3000, () => {
console.log('服务已启动:http://localhost:3000');
});
httpServer 是 Node.js 创建的 HTTP 服务器,new Server(httpServer) 把 Socket.IO 接到它上面。listen(3000) 开始在 3000 端口等待客户端。
io.on('connection', ...) 注册一个连接监听:每当 Socket.IO 接受一个新客户端连接,就自动调用这个函数。connection 是 Socket.IO 内置事件,无须客户端用 emit 发送。参数 socket 代表刚建立的这条连接,socket.id 是它的连接编号。
回调中的 socket.emit('welcome', '欢迎进入聊天室') 则是我们主动发送的业务消息。welcome 是自行约定的事件名,因此需要在代码里明确发送,并在客户端监听。
同一目录创建 client.mjs。
import { io } from 'socket.io-client';
const socket = io('http://localhost:3000');
socket.on('connect', () => {
console.log('连接成功', socket.id);
});
socket.on('welcome', (text) => {
console.log('服务端消息', text);
});
socket.on('connect_error', (error) => {
console.log('连接失败', error.message);
});
执行 io('http://localhost:3000') 时,客户端就会自动向这个地址发起连接。 它创建并返回客户端的 socket 对象,同时开始连接过程。连接需要时间,因此拿到对象时,还不能直接认为连接已经成功。
这段代码运行后的过程是:
- 客户端调用
io(),向服务端发起连接。 - 服务端接受连接,Socket.IO 自动触发服务端的
connection事件,执行我们注册的回调。回调里发送welcome消息。 - 客户端确认连接成功,Socket.IO 自动触发客户端的
connect事件,打印“连接成功”。 - 客户端收到
welcome消息,执行对应的监听函数,打印欢迎文字。
所以服务端监听 connection、客户端监听 connect,分别得知各自这一侧的连接成功。on 负责注册收到通知后要做的事,客户端的 io() 才是这里发起连接的入口。
在第一个终端执行 node server.mjs,保持运行。再打开一个终端,进入同一目录执行 node client.mjs。你应在服务端看到连接编号,在客户端看到“连接成功”和“服务端消息 欢迎进入聊天室”。只启动服务端时不会出现客户端连接日志,服务要等有人连接才执行回调。
❓ 知识问答
Q1:客户端为什么连接失败?
先看服务端终端是否仍在运行,再核对两边是否都使用 3000 端口。若服务启动时报 EADDRINUSE,说明该端口已被其他进程使用,换端口时需同步修改客户端地址。
Q2:可以先创建客户端对象,等需要时再连接吗?
可以。创建时设置 autoConnect: false 会关闭自动连接,再调用 socket.connect() 才开始连接。此时只有创建对象而没有调用 connect(),服务端就不会触发这条客户端连接的 connection 回调。
const socket = io('http://localhost:3000', {
autoConnect: false
});
socket.on('connect', () => {
console.log('连接成功');
});
socket.connect();
🧪 小练习
同时启动两个 client.mjs。服务端应该打印两次连接日志,两端拿到不同的连接 ID,并各收到一条欢迎消息。在任意客户端按 Ctrl+C 结束它,另一个客户端仍保持运行。
🎉 你已经用 Node.js 建立了第一条 Socket.IO 连接。
