https://github.com/fish-tennis/gentity
Data Mapping for database(such as mongodb) and cache(such as redis),with Entity-Component pattern
https://github.com/fish-tennis/gentity
game mongodb protobuf redis server
Last synced: 7 months ago
JSON representation
Data Mapping for database(such as mongodb) and cache(such as redis),with Entity-Component pattern
- Host: GitHub
- URL: https://github.com/fish-tennis/gentity
- Owner: fish-tennis
- License: mit
- Created: 2022-08-23T02:30:48.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-10-14T07:48:47.000Z (over 1 year ago)
- Last Synced: 2025-06-01T15:52:07.451Z (8 months ago)
- Topics: game, mongodb, protobuf, redis, server
- Language: Go
- Homepage:
- Size: 1.63 MB
- Stars: 4
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# gentity
实体对象的数据绑定(类似gorm),数据读写(序列化),缓存等接口,通过配置即可实现对象的数据保存加载,缓存更新,以简化业务编码,并使业务代码和数据库&缓存解耦
基于gentity,游戏服务器框架可以更快的构建
## Entity-Component
Entity-Component模式是类似Unity的GameObject-Component的实体组件模式,便于组件解耦
比如游戏服务器中的玩家对象就属于Entity,玩家的任务模块就是一个Component
- 组件模块注册
- 组件消息回调接口注册
- 组件事件分发
- 组件事件响应接口注册
## 数据库和缓存
实体数据的加载和保存是游戏服务器最基础的功能,gentity利用go的struct tag,大大简化了实体数据加载和保存的接口
gentity抽象出了实体的数据库接口EntityDb和实体的缓存接口KvCache,并且可以自动检查增量更新,只把修改过的数据保存到数据库和缓存
gentity内置了EntityDb的mongodb实现,和KvCache的redis实现
## 数据绑定
类似gorm(go Object Relation Mapping)对SQL进行对象映射,gentity的数据绑定对组件进行数据库和缓存的映射
利用go的struct tag,设置对象组件的字段,框架接口会自动对这些字段进行数据库读取保存和缓存更新,极大的简化了业务代码对数据库和缓存的操作
设置组件保存数据
```go
// entity的一个组件
type Money struct {
DataComponent
// 该字段必须导出(首字母大写)
// 使用struct tag来标记该字段需要存数据库
Data *pb.Money `db:""`
}
```
支持明文方式保存数据
```go
// 玩家基础信息组件
type BaseInfo struct {
DataComponent
// plain表示明文存储,在保存到mongodb时,不会进行proto序列化
Data *pb.BaseInfo `db:"plain"`
}
```
支持多个保存字段
```go
// 任务组件
type Quest struct {
BaseComponent
// 保存数据的子模块:已完成的任务 使用明文保存方式
// wrapper of []int32
Finished *gentity.SliceData[int32] `child:"Finished;plain"`
// 保存数据的子模块:当前任务列表
// wrapper of map[int32]*pb.QuestData
Quests *gentity.MapData[int32, *pb.QuestData] `child:"Quests"`
}
```
## 消息回调
支持自动注册消息回调,事件响应
```go
// 客户端发给服务器的完成任务的消息回调
// 这种格式写的函数可以自动注册客户端消息回调
func (this *Quest) OnFinishQuestReq(reqCmd gnet.PacketCommand, req *pb.FinishQuestReq) {
// logic code ...
}
```
```go
// 这种格式写的函数可以自动注册非客户端的消息回调
func (this *BaseInfo) HandlePlayerEntryGameOk(cmd gnet.PacketCommand, msg *pb.PlayerEntryGameOk) {
// logic code ...
}
```
```go
// 这种格式写的函数可以自动注册事件响应接口
// 当执行player.FireEvent(&EventPlayerEntryGame{})时,该响应接口会被调用
func (this *Quest) TriggerPlayerEntryGame(event *EventPlayerEntryGame) {
// logic code ...
}
```
## 独立协程实体RoutineEntity
每个RoutineEntity分配一个独立的逻辑协程,在自己的独立协程中执行只涉及自身数据的代码,无需加锁
同时,RoutineEntity内置了一个协程安全的计时器
示例:[gserver](https://github.com/fish-tennis/gserver) 里的玩家对象Player
## 分布式实体DistributedEntity
分布式实体DistributedEntity在RoutineEntity的基础上增加了数据库加载接口,分布式锁接口
示例:[gserver](https://github.com/fish-tennis/gserver) 里的公会对象Guild
## 项目演示
分布式游戏服务器框架[gserver](https://github.com/fish-tennis/gserver)
## 讨论
QQ群: 764912827