websocket

tao-websocket

Tao Universe WebSocket 组件，基于 gorilla/websocket 封装，提供 WebSocket 连接升级能力，支持多实例配置。

安装

go get github.com/taouniverse/tao-websocket

使用

导入

import _ "github.com/taouniverse/tao-websocket"

快速开始

import (
    "net/http"
    websocket "github.com/taouniverse/tao-websocket"
)

func wsHandler(w http.ResponseWriter, r *http.Request) {
    // 创建 WebSocket 连接（使用默认配置）
    conn, err := websocket.New(w, r, websocket.Standard())
    if err != nil {
        http.Error(w, err.Error(), http.StatusBadRequest)
        return
    }
    defer conn.Close()

    // 读取消息
    data, err := conn.Read()
    if err != nil {
        return
    }

    // 发送消息
    err = conn.Write([]byte("Hello!"))
}

使用指定实例

// 使用名为 "admin" 的 Upgrader 实例创建连接
conn, err := websocket.NewWith(w, r, "admin", websocket.Standard())

配置

单实例配置

websocket:
  check_origin: true
  read_buffer_size: 1024
  write_buffer_size: 1024

多实例配置

websocket:
  default_instance: "public"  # 指定默认实例
  public:                     # 公开接口实例
    check_origin: true        # 允许跨域
    read_buffer_size: 1024
    write_buffer_size: 1024
  admin:                      # 管理接口实例
    check_origin: false       # 不允许跨域
    read_buffer_size: 4096
    write_buffer_size: 4096
    subprotocols: ["admin-v1"]

配置项说明

API 参考

工厂方法

连接创建

连接选项

连接方法

单元测试

运行单元测试

# 全部测试
go test -v ./...

# 仅运行配置测试
go test -v -run TestConfig ./...

# 仅运行连接测试
go test -v -run TestNew ./...

依赖

• gorilla/websocket - WebSocket 实现
• taouniverse/tao - Tao 框架核心