WebSocket 设计思路

news2025/1/8 18:12:51

WebSocket 设计思路

1. 核心结构体

1.1 Manager (管理器)

// Manager 负责管理所有WebSocket连接
type Manager struct {
    clients   sync.Map    // 存储所有客户端连接
    broadcast chan []byte // 广播消息通道
    messages  chan Message // 消息处理通道
    config    *config.WebSocketConfig // 配置信息
}

// 设计思路：
// 1. 使用 sync.Map 存储客户端，保证并发安全
// 2. 使用 channel 进行消息广播，避免并发问题
// 3. 独立的消息处理通道，方便业务层处理消息
// 4. 配置信息可从外部注入，提高灵活性

1.2 Client (客户端)

// Client 表示一个WebSocket客户端连接
type Client struct {
    conn    *websocket.Conn // WebSocket连接
    manager *Manager        // 所属的管理器
    send    chan []byte     // 发送消息的通道
}

// 设计思路：
// 1. 每个客户端维护自己的WebSocket连接
// 2. 持有manager引用，方便访问全局功能
// 3. 独立的发送通道，实现异步消息发送

1.3 Message (消息)

// Message 定义消息结构
type Message struct {
    Type     string      `json:"type"`    // 消息类型
    Data     interface{} `json:"data"`    // 消息内容
    ClientID string      `json:"-"`       // 发送者ID
}

// 设计思路：
// 1. 类型字段用于区分不同消息
// 2. 数据字段使用interface{}支持任意类型
// 3. ClientID方便追踪消息来源

2. 核心方法

2.1 连接管理

// 创建管理器
func NewManager(config *config.WebSocketConfig) *Manager {
    // 初始化管理器实例
}

// 处理新的WebSocket连接
func (m *Manager) HandleWebSocket() gin.HandlerFunc {
    // 1. 验证连接请求
    // 2. 升级HTTP连接为WebSocket
    // 3. 创建新的客户端
    // 4. 启动读写协程
}

// 设计思路：
// 1. 工厂方法创建管理器
// 2. 使用中间件处理连接
// 3. 自动管理连接生命周期

2.2 消息收发

// 读取消息
func (c *Client) readPump() {
    // 1. 设置读取超时
    // 2. 处理心跳响应
    // 3. 读取消息并处理
    // 4. 错误处理和清理
}

// 发送消息
func (c *Client) writePump() {
    // 1. 处理发送队列
    // 2. 发送心跳
    // 3. 错误处理
}

// 设计思路：
// 1. 独立的读写协程
// 2. 心跳保活机制
// 3. 优雅的错误处理

2.3 消息广播

// 广播消息
func (m *Manager) Broadcast(message []byte) {
    // 向所有客户端发送消息
}

// 发送到指定客户端
func (m *Manager) SendToClient(clientAddr string, message []byte) bool {
    // 发送消息给特定客户端
}

// 设计思路：
// 1. 支持全局广播
// 2. 支持定向发送
// 3. 处理发送失败情况

2.4 消息处理

// 发送结构化消息
func (m *Manager) SendMessage(messageType string, data interface{}) error {
    // 1. 构造消息结构
    // 2. 序列化消息
    // 3. 发送消息
}

// 获取消息通道
func (m *Manager) GetMessages() <-chan Message {
    // 返回只读消息通道
}

// 设计思路：
// 1. 统一的消息格式
// 2. 类型安全的发送方法
// 3. 方便的消息订阅机制