Node.js WebSocket 的完整指南：从入门到精通

WebSocket 是建立在 TCP 之上的、浏览器或其他客户端与服务器之间进行全双工、双向通信的持久连接。它允许客户端实时收发消息，而无需不断轮询服务器。Node.js 应用程序中广泛使用 WebSocket。

安装和设置

在 Node.js 项目中使用 WebSocket，需要安装 ws 模块：

npm install ws

接下来，创建一个简单的 WebSocket 服务器：

const WebSocket = require("ws");

const wss = new WebSocket.Server({ port: 8080 });

wss.on("connection", (ws) => {
  console.log("Client connected");

  ws.on("message", (message) => {
    console.log("Received message: ", message);
    ws.send("Echo: " + message);
  });

  ws.on("close", () => {
    console.log("Client disconnected");
  });
});

客户端开发

在客户端，可以使用 WebSocket 库建立连接并发送和接收消息。例如，用于浏览器的 socket.io 库：

const socket = io("ws://localhost:8080");

socket.on("connect", () => {
  console.log("Connected to server");
});

socket.on("message", (message) => {
  console.log("Received message: ", message);
});

socket.on("disconnect", () => {
  console.log("Disconnected from server");
});

socket.send("Hello from client");

路由和授权

为了管理多个 WebSocket 连接，可以设置路由和授权机制。例如，使用 Express.js 中间件：

const express = require("express");
const WebSocket = require("ws");

const app = express();
app.use(express.json());

const wss = new WebSocket.Server({ server: app.listen(8080) });
wss.on("connection", (ws) => { authenticate(ws); });

function authenticate(ws) {
  const token = ws.upgradeReq.headers["authorization"];
  if (validateToken(token)) {
    ws.authorized = true;
  } else {
    ws.close();
  }
}

广播和订阅

WebSocket 允许广播消息给所有连接的客户端。以下代码演示了使用订阅和发布模式：

wss.on("connection", (ws) => {
  ws.on("message", (message) => {
    wss.clients.forEach((client) => {
      if (client.authorized && client !== ws) {
        client.send(message);
      }
    });
  });
});

错误处理

WebSocket 连接可能由于各种原因断开。为了处理错误，监听 error 事件并采取适当的措施：

ws.on("error", (error) => {
  console.error("WebSocket error: ", error);
  ws.close();
});

最佳实践

• 保持连接简洁，避免发送不必要的数据。
• 采用心跳机制来检测断开连接的客户端。
• 使用安全措施，例如 TLS，以加密通信。
• 考虑使用 WebSocket 库来简化开发。
• 对消息进行验证，以确保客户端发送有效的数据。