首先完成“了解 WebSocket 协议及 HTTP 差异”即可解锁本课程。转到上一课

简介

WebSocket 是一种协议,能够在单一 TCP 套接字上实现客户端与服务器之间的全双工、持久连接。与需要客户端请求、服务器回应的普通 HTTP 不同,WebSocket 连接保持打开,双方随时都可以发送消息。这使得它非常适合聊天应用、实时仪表盘、多人在线游戏,以及任何需要实时更新的功能。

本课你将构建尽可能最小的 WebSocket 设置:在 Node.js 中使用流行的 `ws` 库搭建一个服务器,以及一个浏览器客户端连接到它并交换几条消息。没有框架、没有数据库——只有原始协议,让你理解底层在发生什么。

项目设置

为项目创建一个新文件夹并初始化它。你需要安装 Node.js(版本 18 或更高版本都可以)。

bash
mkdir ws-demo
cd ws-demo
npm init -y
npm install ws

`ws` 包是 Node.js 中快速、广泛使用的 WebSocket 实现。在执行 `npm install` 之后,你将看到一个 `node_modules` 文件夹和一个列出 `ws` 作为依赖的 `package.json`。

编写服务器

创建一个名为 `server.js` 的文件。服务器需要完成三件事:导入库、创建一个绑定到端口的 WebSocket 服务器,以及定义在建立连接和接收消息时的行为。

javascript
const WebSocket = require('ws');
const wss = new WebSocket.Server({ port: 8080 });
wss.on('connection', (ws) => {
console.log('A client connected');
ws.on('message', (data) => {
const text = data.toString();
console.log('Received:', text);
ws.send(`Server echo: ${text}`);
});
ws.send('Welcome to the WebSocket server!');
});
console.log('WebSocket server is listening on ws://localhost:8080');

`connection` 事件在每个连接的客户端上只触发一次。回调函数接收一个表示该客户端套接字的 `ws` 对象。在回调中你会挂载一个 `message` 监听器。当消息到达时,`data` 默认是一个 Buffer,因此 `toString()` 把它转换为普通文本。服务器随后将消息原样回显,前缀为 `Server echo:`。

用 `node server.js` 运行服务器。你应该会看到 "listening" 日志行,其余在没有客户端连接之前保持为空。

连接流程图 — client 发送 CONNECT,server 接受,双方在同一个 socket 上来回发送 MESSAGE

编写浏览器端客户端

创建一个名为 `index.html` 的文件。浏览器可以使用内置的 `WebSocket` 全局对象建立 WebSocket 连接——客户端不需要任何库。

markup
<!DOCTYPE html>
<html>
<head><title>WebSocket Demo</title></head>
<body>
<h1>WebSocket Demo</h1>
<input id="msg" placeholder="Type a message" />
<button id="send">Send</button>
<ul id="log"></ul>
<script>
const log = document.getElementById('log');
const ws = new WebSocket('ws://localhost:8080');
ws.addEventListener('open', () => {
log.innerHTML += '<li>Connected to server</li>';
});
ws.addEventListener('message', (event) => {
log.innerHTML += '<li>From server: ' + event.data + '</li>';
});
document.getElementById('send').addEventListener('click', () => {
const input = document.getElementById('msg');
ws.send(input.value);
input.value = '';
});
</script>
</body>
</html>

`open` 事件在握手完成后触发。之后,`ws.send('text')` 将字符串消息发送给服务器。服务器回显的回复作为 `message` 事件到达,其 `event.data` 即服务器发送的字符串。

端到端测试

启动服务器:`node server.js`。然后在浏览器中打开 `index.html`(可以直接双击,或使用如 `npx serve` 之类的工具)。在终端你应该在页面加载时看到 "A client connected"。在输入框中输入内容并点击发送。浏览器日志会显示以 `Server echo:` 为前缀的消息,服务器将接收到的每条消息记录在终端。

常见错误

在服务器端忘记使用 `data.toString()` 会得到原始的 Buffer 对象,而不是客户端发送的可读字符串。浏览器 URL 缺少 `ws://` 协议前缀会导致语法错误,因为 `WebSocket` 构造函数需要包含方案的完整 URL。如果服务器未运行,浏览器的 `open` 事件将永远不会触发,你将看不到任何日志——遇到无响应时请先检查终端。

概览

现在你有一个可用的 WebSocket 回声服务器和一个浏览器客户端。服务器使用 `ws` 在 8080 端口监听、接受连接,并回显它收到的任意消息。客户端通过 `new WebSocket('ws://localhost:8080')` 打开连接,并使用 `send` 和 `message` 事件进行通信。这种模式——一个服务器、许多已连接客户端、双向消息传递——是构建每个实时功能的基础。

课后练习

课程检查点

巩固所学知识,获取作业反馈。

0/1
已回答 · 0/1