前端 WebSocket 实时通信实战：连接管理与最佳实践

问题：

• 简单 WebSocket 连接，缺少重连机制
• 缺少心跳机制，连接可能会被断开
• 消息处理混乱，难以维护
• 缺少错误处理，遇到错误时无法恢复
• 没有状态管理，难以追踪连接状态

正确的做法

基本 WebSocket 实现

// 1. 基本 WebSocket 连接
class WebSocketClient {
  constructor(url) {
    this.url = url;
    this.socket = null;
    this.connected = false;
    this.reconnectAttempts = 0;
    this.maxReconnectAttempts = 5;
    this.reconnectDelay = 1000;
    this.messageHandlers = {};
    this.heartbeatInterval = null;
  }

  connect() {
    this.socket = new WebSocket(this.url);
    this.socket.onopen = (event) => {
      console.log('WebSocket connected');
      this.connected = true;
      this.reconnectAttempts = 0;
      this.startHeartbeat();
    };
    this.socket.onmessage = (event) => {
      this.handleMessage(event.data);
    };
    this.socket.onclose = (event) => {
      console.log('WebSocket disconnected');
      this.connected = false;
      this.stopHeartbeat();
      this.reconnect();
    };
    this.socket.onerror = (error) => {
      console.error('WebSocket error:', error);
    };
  }

  reconnect() {
    if (this.reconnectAttempts < this.maxReconnectAttempts) {
      this.reconnectAttempts++;
      console.log(`Attempting to reconnect... (${this.reconnectAttempts}/${this.maxReconnectAttempts})`);
      setTimeout(() => {
        this.connect();
      }, this.reconnectDelay * this.reconnectAttempts);
    } else {
      console.error('Max reconnect attempts reached');
    }
  }

  startHeartbeat() {
    this.heartbeatInterval = setInterval(() => {
      if (this.connected) {
        this.send({ type: 'heartbeat' });
      }
    }, 30000); // 30 秒发送一次心跳
  }

  stopHeartbeat() {
    if (this.heartbeatInterval) {
      clearInterval(this.heartbeatInterval);
      this.heartbeatInterval = null;
    }
  }

  send(data) {
    if (this.connected) {
      this.socket.send(JSON.stringify(data));
    } else {
      console.error('WebSocket not connected');
    }
  }

  on(type, handler) {
    if (!this.messageHandlers[type]) {
      this.messageHandlers[type] = [];
    }
    this.messageHandlers[type].push(handler);
  }

  handleMessage(data) {
    try {
      const message = JSON.parse(data);
      const { type, payload } = message;
      if (this.messageHandlers[type]) {
        this.messageHandlers[type].forEach(handler => {
          handler(payload);
        });
      }
    } catch (error) {
      console.error('Error parsing message:', error);
    }
  }

  disconnect() {
    this.stopHeartbeat();
    if (this.socket) {
      this.socket.close();
    }
  }
}

// 使用
const wsClient = new WebSocketClient('ws://localhost:8080');
wsClient.connect();

// 监听消息
wsClient.on('chat', (payload) => {
  console.log('Chat message:', payload);
});
wsClient.on('notification', (payload) => {
  console.log('Notification:', payload);
});

// 发送消息
wsClient.send({ type: 'chat', payload: { message: 'Hello', user: 'John' } });

React 中使用 WebSocket

import React, { useEffect, useCallback, useRef, useState } from 'react';

function WebSocketComponent() {
  const [messages, setMessages] = useState([]);
  const [input, setInput] = useState('');
  const wsClientRef = useRef(null);

  // 初始化 WebSocket 连接
  useEffect(() => {
    wsClientRef.current = new WebSocketClient('ws://localhost:8080');
    wsClientRef.current.connect();

    // 监听消息
    wsClientRef.current.on('chat', (payload) => {
      setMessages(prev => [...prev, payload]);
    });

    // 清理函数
    return () => {
      if (wsClientRef.current) {
        wsClientRef.current.disconnect();
      }
    };
  }, []);

  // 发送消息
  const handleSend = useCallback(() => {
    if (input.trim() && wsClientRef.current) {
      wsClientRef.current.send({ type: 'chat', payload: { message: input, user: 'Current User' } });
      setInput('');
    }
  }, [input]);

  return (
    <div>
      <div className="messages">
        {messages.map((message, index) => (
          <div key={index} className="message">
            <strong>{message.user}:</strong> {message.message}
          </div>
        ))}
      </div>
      <div className="input-area">
        <input type="text" value={input} onChange={(e) => setInput(e.target.value)} onKeyPress={(e) => e.key === 'Enter' && handleSend()} />
        <button onClick={handleSend}>Send</button>
      </div>
    </div>
  );
}

export default WebSocketComponent;

高级 WebSocket 实现

// 1. 带认证的 WebSocket
class AuthWebSocketClient extends WebSocketClient {
  constructor(url, token) {
    super(url);
    this.token = token;
  }
  connect() {
    this.socket = new WebSocket(`${this.url}?token=${this.token}`);
    // 其他逻辑与 WebSocketClient 相同
  }
}

// 2. 带重试机制的 WebSocket
class RetryWebSocketClient extends WebSocketClient {
  constructor(url, options = {}) {
    super(url);
    this.maxReconnectAttempts = options.maxReconnectAttempts || 10;
    this.reconnectDelay = options.reconnectDelay || 1000;
    this.exponentialBackoff = options.exponentialBackoff || true;
  }
  reconnect() {
    if (this.reconnectAttempts < this.maxReconnectAttempts) {
      this.reconnectAttempts++;
      const delay = this.exponentialBackoff ? this.reconnectDelay * Math.pow(2, this.reconnectAttempts - 1) : this.reconnectDelay;
      console.log(`Attempting to reconnect... (${this.reconnectAttempts}/${this.maxReconnectAttempts})`);
      setTimeout(() => {
        this.connect();
      }, delay);
    } else {
      console.error('Max reconnect attempts reached');
    }
  }
}

// 3. 消息队列
class QueueWebSocketClient extends WebSocketClient {
  constructor(url) {
    super(url);
    this.messageQueue = [];
  }
  connect() {
    super.connect();
    this.socket.onopen = (event) => {
      console.log('WebSocket connected');
      this.connected = true;
      this.reconnectAttempts = 0;
      this.startHeartbeat();
      // 发送队列中的消息
      this.flushQueue();
    };
  }
  send(data) {
    if (this.connected) {
      this.socket.send(JSON.stringify(data));
    } else {
      // 将消息加入队列
      this.messageQueue.push(data);
      console.log('WebSocket not connected, message queued');
    }
  }
  flushQueue() {
    if (this.connected && this.messageQueue.length > 0) {
      console.log(`Flushing ${this.messageQueue.length} queued messages`);
      this.messageQueue.forEach(message => {
        this.socket.send(JSON.stringify(message));
      });
      this.messageQueue = [];
    }
  }
}

最佳实践

// 1. WebSocket 服务端实现（Node.js）
const WebSocket = require('ws');
const server = new WebSocket.Server({ port: 8080 });
const clients = new Set();

server.on('connection', (socket) => {
  console.log('Client connected');
  clients.add(socket);
  // 发送欢迎消息
  socket.send(JSON.stringify({ type: 'system', payload: 'Welcome to the WebSocket server!' }));
  // 处理消息
  socket.on('message', (message) => {
    try {
      const parsedMessage = JSON.parse(message);
      console.log('Received message:', parsedMessage);
      // 处理心跳
      if (parsedMessage.type === 'heartbeat') {
        socket.send(JSON.stringify({ type: 'heartbeat' }));
        return;
      }
      // 广播消息
      clients.forEach(client => {
        if (client.readyState === WebSocket.OPEN) {
          client.send(JSON.stringify(parsedMessage));
        }
      });
    } catch (error) {
      console.error('Error parsing message:', error);
    }
  });
  // 处理断开连接
  socket.on('close', () => {
    console.log('Client disconnected');
    clients.delete(socket);
  });
  // 处理错误
  socket.on('error', (error) => {
    console.error('Socket error:', error);
  });
});

console.log('WebSocket server running on port 8080');

// 2. 前端 WebSocket 管理
class WebSocketManager {
  static instance = null;
  constructor() {
    this.clients = {};
  }
  static getInstance() {
    if (!WebSocketManager.instance) {
      WebSocketManager.instance = new WebSocketManager();
    }
    return WebSocketManager.instance;
  }
  createClient(name, url, options = {}) {
    const client = new QueueWebSocketClient(url, options);
    this.clients[name] = client;
    client.connect();
    return client;
  }
  getClient(name) {
    return this.clients[name];
  }
  removeClient(name) {
    if (this.clients[name]) {
      this.clients[name].disconnect();
      delete this.clients[name];
    }
  }
  disconnectAll() {
    Object.values(this.clients).forEach(client => {
      client.disconnect();
    });
    this.clients = {};
  }
}

// 使用
const wsManager = WebSocketManager.getInstance();
const chatClient = wsManager.createClient('chat', 'ws://localhost:8080');
const notificationClient = wsManager.createClient('notification', 'ws://localhost:8080');

// 3. 错误处理和监控
class MonitoredWebSocketClient extends WebSocketClient {
  constructor(url) {
    super(url);
    this.errorCount = 0;
    this.maxErrorCount = 10;
  }
  handleError(error) {
    this.errorCount++;
    console.error('WebSocket error:', error);
    if (this.errorCount > this.maxErrorCount) {
      console.error('Max error count reached, disconnecting');
      this.disconnect();
    }
  }
  socket.onerror = (error) => {
    this.handleError(error);
  };
}

总结与建议

WebSocket 确实很重要，但我见过太多开发者滥用这个特性，导致应用变得过于复杂。

想象一下，当你为了实现实时通信，使用了 WebSocket，结果发现服务器负载过高，这真的值得吗？

还有那些过度使用 WebSocket 的开发者，为了实时性而使用 WebSocket，结果发现轮询可能更加适合他们的场景。

所以，在使用 WebSocket 时，一定要根据实际需求来决定。不要为了使用 WebSocket 而使用，要选择最适合的方案。

当然，对于需要实时通信的应用来说，WebSocket 是必要的。但对于不需要实时性的应用，轮询可能更加简单和可靠。

最后，记住一句话：WebSocket 的目的是为了实现实时通信，而不是为了炫技。如果你的 WebSocket 实现导致应用变得更复杂或更不可靠，那你就失败了。