Melody - Golang轻量级WebSocket会话处理与广播库

Melody是一个轻量级的Go语言WebSocket库，它建立在gorilla/websocket之上，提供了简洁的API来处理WebSocket会话、广播消息等常见功能。

基本特性

• 轻量级且易于使用
• 支持消息广播（全部或部分客户端）
• 内置会话管理
• 支持消息过滤
• 支持自定义消息处理器

安装

go get github.com/olahol/melody

基础用法

1. 创建Melody实例

package main

import (
	"github.com/olahol/melody"
	"net/http"
)

func main() {
	m := melody.New()
	
	http.HandleFunc("/ws", func(w http.ResponseWriter, r *http.Request) {
		m.HandleRequest(w, r)
	})
	
	http.ListenAndServe(":5000", nil)
}

2. 处理连接事件

m.HandleConnect(func(s *melody.Session) {
    fmt.Println("客户端连接:", s.Request.RemoteAddr)
})

m.HandleDisconnect(func(s *melody.Session) {
    fmt.Println("客户端断开:", s.Request.RemoteAddr)
})

m.HandleMessage(func(s *melody.Session, msg []byte) {
    fmt.Printf("收到来自 %s 的消息: %s\n", s.Request.RemoteAddr, string(msg))
})

3. 广播消息

// 广播给所有连接的客户端
m.Broadcast([]byte("大家好！"))

// 广播给部分客户端（使用过滤器）
m.BroadcastFilter([]byte("新消息"), func(s *melody.Session) bool {
    return s.Request.URL.Query().Get("name") == "admin"
})

进阶用法

1. 会话管理

m.HandleConnect(func(s *melody.Session) {
    // 设置会话值
    s.Set("name", s.Request.URL.Query().Get("name"))
    s.Set("joined", time.Now())
})

m.HandleMessage(func(s *melody.Session, msg []byte) {
    // 获取会话值
    name, _ := s.Get("name")
    joined, _ := s.Get("joined")
    
    fmt.Printf("%s (加入时间: %v) 说: %s\n", name, joined, string(msg))
})

2. 自定义消息处理

type Message struct {
    Type    string `json:"type"`
    Content string `json:"content"`
}

m.HandleMessage(func(s *melody.Session, msg []byte) {
    var message Message
    if err := json.Unmarshal(msg, &message); err != nil {
        s.Write([]byte(`{"error": "invalid message format"}`))
        return
    }
    
    switch message.Type {
    case "chat":
        m.Broadcast(msg)
    case "private":
        // 处理私信逻辑
    default:
        s.Write([]byte(`{"error": "unknown message type"}`))
    }
})

3. 错误处理

m.HandleError(func(s *melody.Session, err error) {
    fmt.Println("发生错误:", err)
    if err := s.Close(); err != nil {
        fmt.Println("关闭会话时出错:", err)
    }
})

完整示例

package main

import (
	"encoding/json"
	"fmt"
	"github.com/olahol/melody"
	"net/http"
	"time"
)

type Message struct {
	Event   string `json:"event"`
	Name    string `json:"name"`
	Content string `json:"content"`
}

func main() {
	m := melody.New()

	http.HandleFunc("/ws", func(w http.ResponseWriter, r *http.Request) {
		m.HandleRequest(w, r)
	})

	http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
		http.ServeFile(w, r, "index.html")
	})

	// 连接事件
	m.HandleConnect(func(s *melody.Session) {
		name := r.URL.Query().Get("name")
		if name == "" {
			name = "匿名用户"
		}

		s.Set("name", name)
		s.Set("joined", time.Now())

		// 通知所有人有新用户加入
		msg, _ := json.Marshal(Message{
			Event: "join",
			Name:  name,
		})
		m.Broadcast(msg)
	})

	// 断开事件
	m.HandleDisconnect(func(s *melody.Session) {
		name, _ := s.Get("name")
		msg, _ := json.Marshal(Message{
			Event: "leave",
			Name:  name.(string),
		})
		m.Broadcast(msg)
	})

	// 消息处理
	m.HandleMessage(func(s *melody.Session, msg []byte) {
		name, _ := s.Get("name")

		var message Message
		if err := json.Unmarshal(msg, &message); err != nil {
			s.Write([]byte(`{"error": "invalid message"}`))
			return
		}

		message.Name = name.(string)
		message.Event = "message"

		msgBytes, _ := json.Marshal(message)
		m.Broadcast(msgBytes)
	})

	fmt.Println("服务器启动在 :5000")
	http.ListenAndServe(":5000", nil)
}

性能优化建议

1. 对于高并发场景，考虑使用连接池
2. 避免在消息处理器中进行耗时操作
3. 对于大量广播，考虑使用异步方式
4. 合理设置WebSocket缓冲区大小

Melody是一个简单但功能完善的WebSocket库，适合大多数需要实时通信的Web应用场景。它的轻量级特性使得它特别适合微服务和嵌入式应用。