Cherry - Golang轻量级Web聊天服务器插件库

Cherry是一个轻量级的Golang Web聊天服务器插件库，它提供了构建实时聊天应用所需的核心功能。下面我将介绍Cherry的基本使用方法和示例代码。

安装Cherry

go get github.com/gorilla/websocket
go get github.com/xuender/kit
go get github.com/xuender/cherry

基本使用示例

1. 创建简单聊天服务器

package main

import (
	"log"
	"net/http"

	"github.com/xuender/cherry"
	"github.com/xuender/kit/base"
)

func main() {
	// 创建Cherry实例
	cher := cherry.NewCherry(base.NewContext())

	// 设置消息处理器
	cher.HandleFunc(func(msg *cherry.Message) {
		log.Printf("收到消息: %s", msg.Data)
		// 广播消息给所有客户端
		cher.Broadcast(msg)
	})

	// 设置HTTP路由
	http.HandleFunc("/ws", cher.ServeHTTP)

	// 启动服务器
	log.Println("服务器启动在 :8080")
	log.Fatal(http.ListenAndServe(":8080", nil))
}

2. 自定义消息处理

package main

import (
	"encoding/json"
	"log"
	"net/http"

	"github.com/xuender/cherry"
	"github.com/xuender/kit/base"
)

type ChatMessage struct {
	Username string `json:"username"`
	Content  string `json:"content"`
}

func main() {
	cher := cherry.NewCherry(base.NewContext())

	cher.HandleFunc(func(msg *cherry.Message) {
		var chatMsg ChatMessage
		if err := json.Unmarshal(msg.Data, &chatMsg); err != nil {
			log.Printf("消息解析错误: %v", err)
			return
		}

		log.Printf("%s 说: %s", chatMsg.Username, chatMsg.Content)
		
		// 广播消息给所有客户端
		cher.Broadcast(msg)
	})

	http.HandleFunc("/ws", cher.ServeHTTP)
	log.Println("服务器启动在 :8080")
	log.Fatal(http.ListenAndServe(":8080", nil))
}

3. 客户端连接管理

package main

import (
	"log"
	"net/http"

	"github.com/xuender/cherry"
	"github.com/xuender/kit/base"
)

func main() {
	cher := cherry.NewCherry(base.NewContext())

	// 连接建立时的回调
	cher.OnConnect(func(client *cherry.Client) {
		log.Printf("新客户端连接: %s", client.ID())
	})

	// 连接关闭时的回调
	cher.OnDisconnect(func(client *cherry.Client) {
		log.Printf("客户端断开: %s", client.ID())
	})

	cher.HandleFunc(func(msg *cherry.Message) {
		log.Printf("收到来自 %s 的消息: %s", msg.Client.ID(), string(msg.Data))
		cher.Broadcast(msg)
	})

	http.HandleFunc("/ws", cher.ServeHTTP)
	log.Println("服务器启动在 :8080")
	log.Fatal(http.ListenAndServe(":8080", nil))
}

高级功能

1. 房间/频道支持

package main

import (
	"log"
	"net/http"

	"github.com/xuender/cherry"
	"github.com/xuender/kit/base"
)

func main() {
	cher := cherry.NewCherry(base.NewContext())

	cher.HandleFunc(func(msg *cherry.Message) {
		// 假设消息格式为 {"room":"room1","message":"hello"}
		var data map[string]string
		if err := json.Unmarshal(msg.Data, &data); err != nil {
			log.Printf("消息解析错误: %v", err)
			return
		}

		room := data["room"]
		message := data["message"]
		
		// 加入房间
		cher.JoinRoom(room, msg.Client)
		
		// 向特定房间广播
		cher.BroadcastToRoom(room, cherry.NewMessage(msg.Client, []byte(message)))
	})

	http.HandleFunc("/ws", cher.ServeHTTP)
	log.Println("服务器启动在 :8080")
	log.Fatal(http.ListenAndServe(":8080", nil))
}

2. 自定义认证

package main

import (
	"log"
	"net/http"

	"github.com/xuender/cherry"
	"github.com/xuender/kit/base"
)

func authMiddleware(next http.HandlerFunc) http.HandlerFunc {
	return func(w http.ResponseWriter, r *http.Request) {
		token := r.URL.Query().Get("token")
		if token != "valid_token" {
			http.Error(w, "Unauthorized", http.StatusUnauthorized)
			return
		}
		next.ServeHTTP(w, r)
	}
}

func main() {
	cher := cherry.NewCherry(base.NewContext())

	cher.HandleFunc(func(msg *cherry.Message) {
		cher.Broadcast(msg)
	})

	http.HandleFunc("/ws", authMiddleware(cher.ServeHTTP))
	log.Println("服务器启动在 :8080")
	log.Fatal(http.ListenAndServe(":8080", nil))
}

客户端示例 (JavaScript)

const socket = new WebSocket("ws://localhost:8080/ws");

socket.onopen = function(e) {
    console.log("连接建立");
    socket.send(JSON.stringify({username: "Alice", content: "大家好！"}));
};

socket.onmessage = function(event) {
    const msg = JSON.parse(event.data);
    console.log(`${msg.username}: ${msg.content}`);
};

socket.onclose = function(event) {
    if (event.wasClean) {
        console.log(`连接关闭，代码=${event.code} 原因=${event.reason}`);
    } else {
        console.log('连接中断');
    }
};

socket.onerror = function(error) {
    console.log(`错误: ${error.message}`);
};

总结

Cherry是一个简单易用的Golang WebSocket聊天库，具有以下特点：

1. 轻量级且易于集成
2. 支持广播和定向消息
3. 提供房间/频道功能
4. 可扩展的客户端管理
5. 支持自定义中间件和认证

通过上述示例，你可以快速搭建一个功能完善的实时聊天服务器。根据实际需求，你可以进一步扩展功能，如添加消息持久化、用户状态管理等。