gws: 兼顧效能與使用者友好的go websocket server

lxzan發表於2023-01-13
GoWebServer

個人專案, 花了很多時間肝, 歡迎大家來品鑑
使用std net實現的websocket library, 無縫接入mux, gin, echo等各種路由/框架.

壓測結果鎮樓

  • machine: Ubuntu 20.04LTS VM (4C8T)
  • client: tcpkali
Server Connection Send Speed(msg/s) Payload size Download / Upload Bandwidth(Mbps)
gws 200 20000 2.34KiB 11614.442↓ 11556.101↑
gorilla 200 20000 2.34KiB 4244.398↓ 4188.711↑
gws 2000 500 2.34KiB 7906.156↓ 7914.797↑
gorilla 2000 500 2.34KiB 4263.545↓ 4260.077↑
gws 5000 50 2.34KiB 4941.188↓ 4943.667↑
gorilla 5000 50 2.34KiB -
gws 10000 10 2.34KiB 1980.124↓ 1977.561↑
gorilla 10000 10 2.34KiB 1972.556↓ 1979.981↑
gws 10000 20 2.34KiB 3952.788↓ 3959.341↑
gorilla 10000 20 2.34KiB -

- means exception

亮點

  • 無依賴
  • 不需要額外開啟協程監聽訊息, 處理各種事件
  • 讀寫訊息不返回錯誤, 它們在gws內部被適當的處理了
  • 透過了 autobahn-testsuite 所有的WebSocket Protocol測試用例

安裝

go get -v github.com/lxzan/gws@latest

核心介面

type Event interface {
    OnOpen(socket *Conn)
    OnError(socket *Conn, err error)
    OnClose(socket *Conn, code uint16, reason []byte)
    OnPing(socket *Conn, payload []byte)
    OnPong(socket *Conn, payload []byte)
    OnMessage(socket *Conn, message *Message)
}

快速開始

package main

import (
    "fmt"
    "github.com/lxzan/gws"
    "net/http"
)

func main() {
    var upgrader = gws.NewUpgrader(func(c *gws.Upgrader) {
        c.CompressEnabled = true
        c.CheckTextEncoding = true
        c.MaxContentLength = 32 * 1024 * 1024
        c.EventHandler = new(WebSocket)
    })

    http.HandleFunc("/connect", func(writer http.ResponseWriter, request *http.Request) {
        socket, err := upgrader.Accept(writer, request)
        if err != nil {
            return
        }
        socket.Listen()
    })

    _ = http.ListenAndServe(":3000", nil)
}

type WebSocket struct{}

func (c *WebSocket) OnClose(socket *gws.Conn, code uint16, reason []byte) {
    fmt.Printf("onclose: code=%d, payload=%s\n", code, string(reason))
}

func (c *WebSocket) OnError(socket *gws.Conn, err error) {
    fmt.Printf("onerror: err=%s\n", err.Error())
}

func (c *WebSocket) OnOpen(socket *gws.Conn) {
    println("connected")
}

func (c *WebSocket) OnPing(socket *gws.Conn, payload []byte) {
    fmt.Printf("onping: payload=%s\n", string(payload))
    socket.WritePong(payload)
}

func (c *WebSocket) OnPong(socket *gws.Conn, payload []byte) {}

func (c *WebSocket) OnMessage(socket *gws.Conn, message *gws.Message) {
    socket.WriteMessage(message.Typ(), message.Bytes())
    message.Close()
}

測試

docker run -it --rm \
    -v ${PWD}/config:/config \
    -v ${PWD}/reports:/reports \
    crossbario/autobahn-testsuite \
    wstest -m fuzzingclient -s /config/fuzzingclient.json

image.png

本作品採用《CC 協議》，轉載必須註明作者和本文連結

相關文章