Minotaur 是一个基于Golang 1.20 编写的服务端开发支持库,其中采用了大量泛型设计,用于游戏服务器开发。
mindmap
root((Minotaur))
/configuration 配置管理功能
/game 游戏通用功能
/builtin 游戏通用功能内置实现
/notify 通知功能接口定义
/planner 策划相关工具目录
/pce 配置导表功能实现
/server 网络服务器支持
/cross 内置跨服功能实现
/router 内置路由器功能实现
/utils 工具结构函数目录
/examples 示例代码目录
注意:依赖于 Go 1.20 +
运行以下 Go 命令来安装软件包:minotaur
$ go get -u github.com/kercylan98/minotaur
- 在
Minotaur
中大量使用了 泛型 、 观察者(事件) 和 选项模式,在使用前建议先进行相应了解; - 项目文档可访问 pkg.go.dev 进行查阅;
可使用 godoc
搭建本地文档服务器
git clone golang.org/x/tools
cd tools/cmd
go install ...
godoc -http=:9998 -play
.\local-doc.bat
chmod 777 ./local-doc.sh
./local-doc.sh
- https://localhost:9998/pkg/github.com/kercylan98/minotaur/
- https://pkg.go.dev/github.com/kercylan98/minotaur
创建一个基于Websocket
创建的单线程回响服务器。
package main
import (
"github.com/kercylan98/minotaur/server"
)
func main() {
srv := server.New(server.NetworkWebsocket)
srv.RegConnectionReceivePacketEvent(func(srv *server.Server, conn *server.Conn, packet server.Packet) {
conn.Write(packet)
})
if err := srv.Run(":9999"); err != nil {
panic(err)
}
}
访问 WebSocket 在线测试 进行验证。
Websocket地址: ws:https://127.0.0.1:9999
分流服务器可以将客户端分流到不同的分组上,每个分组中为串行处理,不同分组之间并行处理。
package main
import "github.com/kercylan98/minotaur/server"
func main() {
srv := server.New(server.NetworkWebsocket,
server.WithShunt(func(guid int64) chan *server.Message {
return make(chan *server.Message, 1024*100)
}, func(conn *server.Conn) (guid int64, allowToCreate bool) {
guid, allowToCreate = conn.GetData("roomId").(int64)
return
}),
)
srv.RegConnectionReceivePacketEvent(func(srv *server.Server, conn *server.Conn, packet []byte) {
conn.Write(packet)
})
if err := srv.Run(":9999"); err != nil {
panic(err)
}
}
该示例中假设各房间互不干涉,故通过
server.WithShunt
将连接通过roomId
进行分组,提高并发处理能力。
Minotaur
内置了服务器消息死锁检测功能,可通过server.WithDeadlockDetect
进行开启。
package main
import (
"github.com/kercylan98/minotaur/server"
"time"
)
func main() {
srv := server.New(server.NetworkWebsocket,
server.WithDeadlockDetect(time.Second*5),
)
srv.RegConnectionReceivePacketEvent(func(srv *server.Server, conn *server.Conn, packet []byte) {
time.Sleep(10 * time.Second)
conn.Write(packet)
})
if err := srv.Run(":9999"); err != nil {
panic(err)
}
}
在开启死锁检测的时候需要设置一个合理的死锁怀疑时间,该时间内消息没有处理完毕则会触发死锁检测,并打印
WARN
级别的日志输出。
在默认的server.Server
不会包含计时器功能,可通过server.WithTicker
进行开启,例如:
package main
import "github.com/kercylan98/minotaur/server"
func main() {
srv := server.New(server.NetworkWebsocket, server.WithTicker(50, false))
if err := srv.Run(":9999"); err != nil {
panic(err)
}
}
也可以通过timer.GetTicker
获取计时器进行使用,例如:
package main
import (
"fmt"
"github.com/kercylan98/minotaur/utils/timer"
"github.com/kercylan98/minotaur/utils/times"
"sync"
)
func main() {
var ticker = timer.GetTicker(10)
var wait sync.WaitGroup
wait.Add(3)
ticker.Loop("LOOP", timer.Instantly, times.Second, timer.Forever, func() {
fmt.Println("LOOP")
wait.Done()
})
wait.Wait()
}
请参考 CONTRIBUTING.md 贡献指南。
Minotaur
had been being developed with GoLand
IDE under the free JetBrains Open Source license(s) granted by JetBrains s.r.o., hence I would like to express my thanks here.