分离websocket模块

This commit is contained in:
ayflying
2025-05-20 10:43:10 +08:00
parent 82cffdfe29
commit f22c9df605
5 changed files with 11 additions and 4 deletions

5
modules/websocket/go.mod Normal file
View File

@@ -0,0 +1,5 @@
module github.com/ayflying/utility_go/modules/websocket
go 1.24.0
require github.com/ayflying/utility_go v1.2.26

2
modules/websocket/go.sum Normal file
View File

@@ -0,0 +1,2 @@
github.com/ayflying/utility_go v1.2.26/go.mod h1:y6qwRUmYk73cH/dTRSzj2mnaQdtrAfFNH4wRFewxlIc=
github.com/gorilla/websocket v1.5.3/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE=

View File

@@ -0,0 +1,49 @@
package websocket
import "google.golang.org/protobuf/proto"
// 定义一个处理方法的类型
type Handler func(conn *WebsocketData, req any) (err error)
type Handler2 func(conn *WebsocketData)
type HandlerMessage func(conn *WebsocketData, req any)
type PbType func(cmd int32, data []byte, code int32, msg string) proto.Message
type PbType2 func(data []byte) (int, []byte)
// 路由器的处理映射
var (
handlers = make(map[int]Handler)
OnConnectHandlers = make([]Handler2, 0)
OnCloseHandlers = make([]Handler2, 0)
onMessageHandlers = make([]HandlerMessage, 0)
Byte2Pb = make([]PbType, 0)
Pb2Bytes = make([]PbType2, 0)
)
// 注册方法将某个消息路由器ID和对应的处理方法关联起来
func (s *SocketV1) RegisterRouter(cmd int, handler Handler) {
handlers[cmd] = handler
}
//注册方法,讲长连接登陆方法进行注册
func (s *SocketV1) RegisterOnConnect(_func Handler2) {
OnConnectHandlers = append(OnConnectHandlers, _func)
}
func (s *SocketV1) RegisterOnClose(_func Handler2) {
OnCloseHandlers = append(OnCloseHandlers, _func)
}
//注册方法长连接消息体
func (s *SocketV1) RegisterMessage(_func HandlerMessage) {
onMessageHandlers = append(onMessageHandlers, _func)
}
func (s *SocketV1) RegisterByte2Pb(_func PbType) {
Byte2Pb = append(Byte2Pb, _func)
}
func (s *SocketV1) RegisterPb2Byte(_func PbType2) {
Pb2Bytes = append(Pb2Bytes, _func)
}

View File

@@ -0,0 +1,361 @@
package websocket
import (
"context"
"fmt"
"github.com/ayflying/utility_go/pkg/aycache"
"github.com/ayflying/utility_go/tools"
"github.com/gogf/gf/v2/container/gmap"
"github.com/gogf/gf/v2/encoding/gjson"
"github.com/gogf/gf/v2/frame/g"
"github.com/gogf/gf/v2/net/ghttp"
"github.com/gogf/gf/v2/os/gctx"
"github.com/gogf/gf/v2/os/glog"
"github.com/gogf/gf/v2/util/guid"
"github.com/gorilla/websocket"
"google.golang.org/protobuf/proto"
"net/http"
"sync"
"time"
)
type SocketV1 struct {
Type int `json:"type"`
}
var (
//ctx = gctx.New()
//Conn map[uuid.UUID]*WebsocketData
lock sync.Mutex
cache = aycache.New("redis")
m = gmap.NewHashMap(true)
)
type WebsocketData struct {
Ws *websocket.Conn `json:"ws" dc:"websocket连接池"`
Uuid string `json:"uuid" dc:"用户唯一标识"`
Uid int64 `json:"uid" dc:"用户编号"`
Guid string `json:"guid" dc:"用户凭证"`
Groups []string `json:"groups" dc:"群组"`
Ctx context.Context `json:"ctx" dc:""`
RoomId string `json:"roomId" dc:"房间编号"`
}
func NewV1() *SocketV1 {
return &SocketV1{
Type: 2,
}
}
type SocketInterface interface {
Load(serv *ghttp.Server, prefix string)
OnConnect(ctx context.Context, conn *websocket.Conn)
OnMessage(conn *WebsocketData, req []byte, msgType int)
Send(cmd int32, uid int64, req proto.Message)
SendAll(cmd int32, req proto.Message)
OnClose(conn *WebsocketData)
}
func (s *SocketV1) Load(serv *ghttp.Server, prefix string) {
//websocket服务启动
serv.Group(prefix, func(group *ghttp.RouterGroup) {
var websocketCfg = websocket.Upgrader{
ReadBufferSize: 1024,
WriteBufferSize: 1024,
CheckOrigin: func(r *http.Request) bool {
// In production, you should implement proper origin checking
return true
},
Error: func(w http.ResponseWriter, r *http.Request, status int, reason error) {
g.Log().Errorf(r.Context(), "WebSocket error: %v", reason)
},
}
group.Bind(
func(r *ghttp.Request) {
ctx := r.Context()
ws, err := websocketCfg.Upgrade(r.Response.Writer, r.Request, nil)
if err != nil {
glog.Error(ctx, err)
r.Exit()
}
//ws联机触发器
NewV1().OnConnect(ctx, ws)
},
)
})
}
// OnConnect
//
// @Description:
// @receiver s
// @param conn
func (s *SocketV1) OnConnect(ctx context.Context, ws *websocket.Conn) {
id := guid.S()
ip := ws.RemoteAddr().String()
conn := &WebsocketData{
Uuid: id,
Ws: ws,
Ctx: ctx,
Groups: make([]string, 0),
RoomId: "",
}
m.Set(id, conn)
//defer delete(Conn, id)
to := fmt.Sprintf("创建连接:%v,ip=%v", id, ip)
g.Log().Debugf(ctx, to)
//s.Send(id, []byte(to))
//用户登录钩子执行
for _, connect := range OnConnectHandlers {
connect(conn)
}
for {
//进入当前连接线程拥堵
msgType, msg, err := ws.ReadMessage()
s.Type = msgType
if err != nil {
//客户端断开返回错误,断开当前连接
//g.Log().Error(ctx, err)
break
}
s.OnMessage(conn, msg, msgType)
}
//关闭连接触发
s.OnClose(conn)
g.Log().Debugf(ctx, "断开连接:uuid=%v,ip=%v", id, ip)
}
// OnMessage
//
// @Description:
// @receiver s
// @param msg
// @param msgType
func (s *SocketV1) OnMessage(conn *WebsocketData, req []byte, msgType int) {
s.Type = 2
var cmd int
var msg []byte
//uid := conn.Uid
for _, v := range Pb2Bytes {
cmd, msg = v(req)
}
g.Log("cmd").Debugf(gctx.New(), fmt.Sprintf("from|%d|%d|%v", cmd, conn.Uid, gjson.MustEncodeString(req)))
//msgStr := string(req)
//cmd = gconv.Int(msgStr[:8])
//msg = []byte(msgStr[8:])
handler, exist := handlers[cmd]
if exist {
//匹配上路由器
err := handler(conn, msg)
if err != nil {
g.Log().Error(conn.Ctx, err)
}
} else {
//fmt.Println("未注册的路由器ID:", cmd)
//s.Send(20000000, conn.Uid, []byte("未注册的协议号:"+strconv.Itoa(cmd)))
s.OnClose(conn)
return
}
}
//绑定用户编号
func (s *SocketV1) BindUid(conn *WebsocketData, uid int64, guid string) {
lock.Lock()
defer lock.Unlock()
cacheKey := fmt.Sprintf("socket:uid:%d", uid)
g.Redis().Set(nil, cacheKey, conn.Uuid)
if conn.Uid == 0 {
conn.Uid = uid
}
conn.Guid = guid
}
//解绑用户
func (s *SocketV1) UnBindUid(uid int64) {
lock.Lock()
defer lock.Unlock()
cacheKey := fmt.Sprintf("socket:uid:%d", uid)
g.Redis().Del(nil, cacheKey)
}
// Uid2Uuid 用户编号转uuid唯一标识
func (s *SocketV1) Uid2Uuid(uid int64) (uuid string) {
cacheKey := fmt.Sprintf("socket:uid:%d", uid)
get, _ := g.Redis().Get(nil, cacheKey)
if get.IsNil() {
return
}
uuid = get.String()
//如果不在线了
if !m.Contains(uuid) {
// 解绑用户编号
s.UnBindUid(uid)
return
}
return
}
// SendUuid
//
// @Description:
// @receiver s
// @param uid
// @param data
func (s *SocketV1) SendUuid(cmd int32, uuidStr string, req proto.Message) {
if !m.Contains(uuidStr) {
return
}
//格式化数据
var data, err = proto.Marshal(req)
if err != nil {
g.Log().Error(gctx.New(), err)
return
}
conn := m.Get(uuidStr).(*WebsocketData)
//前置方法
for _, v := range Byte2Pb {
temp := v(cmd, data, 0, "")
data, _ = proto.Marshal(temp)
}
conn.Ws.WriteMessage(s.Type, data)
return
}
// Send
//
// @Description:
// @receiver s
// @param uid
// @param data
func (s *SocketV1) Send(cmd int32, uid int64, req proto.Message) {
g.Log("cmd").Debugf(gctx.New(), fmt.Sprintf("to|%d|%d|%v", cmd, uid, gjson.MustEncodeString(req)))
uuid := s.Uid2Uuid(uid)
if uuid == "" {
return
}
s.SendUuid(cmd, uuid, req)
return
}
// 批量发送
func (s *SocketV1) SendAll(cmd int32, req proto.Message) {
g.Log("cmd").Debugf(gctx.New(), fmt.Sprintf("all:%d|-1|%v", cmd, gjson.MustEncodeString(req)))
//格式化数据
var data, err = proto.Marshal(req)
if err != nil {
g.Log().Error(gctx.New(), err)
return
}
for _, v := range Byte2Pb {
temp := v(cmd, data, 0, "")
data, _ = proto.Marshal(temp)
}
m.Iterator(func(k interface{}, v interface{}) bool {
conn := v.(*WebsocketData)
conn.Ws.WriteMessage(s.Type, data)
return true
})
}
//加入群组
func (s *SocketV1) JoinGroup(conn *WebsocketData, group string) {
conn.Groups = append(conn.Groups, group)
cacheKey := "websocket:group:" + group
get, _ := aycache.New("redis").Get(conn.Ctx, cacheKey)
var list = make(map[int64]string)
if !get.IsNil() {
get.Scan(&list)
}
list[conn.Uid] = conn.Uuid
cache.Set(conn.Ctx, cacheKey, list, time.Hour*24*7)
}
// 退出群组
func (s *SocketV1) LeaveGroup(conn *WebsocketData, group string) {
conn.Groups = tools.RemoveSlice[string](conn.Groups, group)
cacheKey := "websocket:group:" + group
get, _ := cache.Get(conn.Ctx, cacheKey)
var list = make(map[int64]string)
if !get.IsNil() {
get.Scan(&list)
}
delete(list, conn.Uid)
cache.Set(conn.Ctx, cacheKey, list, time.Hour*24*7)
}
//群组广播
func (s *SocketV1) SendGroup(cmd int32, roomId string, req proto.Message) {
cacheKey := "websocket:group:" + roomId
get, _ := cache.Get(gctx.New(), cacheKey)
var list = make(map[int64]string)
if !get.IsNil() {
get.Scan(&list)
}
for uid, v := range list {
if m.Contains(v) {
s.Send(cmd, uid, req)
}
}
}
// OnClose
//
// @Description:
// @receiver s
// @param conn
func (s *SocketV1) OnClose(conn *WebsocketData) {
// 在此处编写断开连接后的处理逻辑
//g.Log().Debugf(gctx.New(), "WebSocket connection from %s has been closed.", conn.RemoteAddr())
//用户登录钩子执行
for _, connect := range OnCloseHandlers {
connect(conn)
}
uid := conn.Uid
if uid > 0 {
s.UnBindUid(uid)
for _, v := range conn.Groups {
s.LeaveGroup(conn, v)
}
}
// 可能的后续操作:
// 1. 更新连接状态或从连接池移除
// 2. 发送通知或清理关联资源
// 3. 执行特定于业务的断开处理
conn.Ws.Close()
m.Remove(conn.Uuid)
}
// 是否在线
func (s *SocketV1) IsOnline(uid int64) bool {
uuid := s.Uid2Uuid(uid)
if m.Contains(uuid) {
return true
}
return false
}