欢迎使用cherry!
- 这是一款分布式的golang游戏服务器框架
- 基于golang + actor model技术构建
- 它具备高性能、可伸缩、分布式、协程分组管理等特点。并且上手简单、易学
- 让开发者更多的关注游戏业务，高效完成功能实现
- 文档陆续补充中，欢迎加入一起建设项目
新接触cherry的朋友，建议从 示例 开始。
重要更新
- 新增Actor model实现
- 新增simple网络数据包结构(id(4bytes) + dataLen(4bytes) + data(n bytes))
examples示例已从cherry库迁出，新仓库地址: https://github.com/cherry-game/examples- 文档地址: https://cherry-game.github.io/
讨论与交流
示例
单节点精简版聊天室(❤推荐)
本示例适合刚接触cherry的朋友，用于熟悉项目
具备如下特性：
- 实现网页客户端，构建http server
- 选择websocket作为连接器
- 选择json做为通信格式
- 实现创建房间
- 实现发送消息
- 实现广播消息
请参考环境安装与配置 进行准备工作 源码位于examples/demo_chat仓库
多节点分布式游戏示例(❤强烈推荐)
本示例集群适合作为大部分游戏服务端的基础框架，开发者们可在此示例基础上构建出自己的游戏服务端方案。
特性如下：
- 选择 H5 搭建一个客户端
- 搭建 Web 服节点
- 搭建网关服节点
- 搭建中心服节点
- 搭建游戏服节点
- 选择 master 作为发现服务节点
- 实现部份基础功能(区服列表、多 SDK 帐号体系、帐号注册、帐号登录、创建角色、角色登录)
请参考环境安装与配置 进行准备工作 源码位于examples/demo_cluster仓库
核心功能
组件管理
- 基于组件的方式组合功能，方便统一管理生命周期
- 可根据需求自定义组件，并注册到框架，灵活扩展
- 可配置
cluster mode和standalone mode
环境配置
- 可配置多个环境的参数，方便切换
- 所有系统参数、组件参数都基于profile文件配置，方便扩展
- 可根据业务需求自由的拆分或组装多个profile子文件，精简配置,拒绝冗余
Actor 模型
- 每个Actor独立运行在一个goroutine中，所有的逻辑都是串行处理
- Actor接收三种消息：本地消息(Local)、远程消息(Remote)、事件消息(Event)
- 三种消息都有自己的队列(Queue)，每个队列依据FIFO原则进行消费
- 本地消息(Local)，用于接收游戏客户端发送过来的本地消息
- 远程消息(Remote)，用于Actor之间调用的远程消息
- 事件消息(Event)，通过订阅/发布进行的事件消息
- Actor可以创建多个子Actor(ChildActor)，子Actor的消息由父Actor进行路由转发
- 通过cluster集群组件、discovery发现服务组件，进行跨节点的actor通信
集群&注册发现
- 三种发现服务实现方式:
- 开发用，直接读取本地的节点配置文件
- 小规模用，基于nats.io创建一个master节点，实现单节点的发现服务
- 线上用，基于etcd封装，实现集群方式的发现服务
- 基于nats.io实现的RPC调用，默认提供同步/异步的调用方式
连接器
- tcp
- websocket
- http server
- http client
- kcp(未实现，以后作为组件集成)
消息&路由
- 实现pomelo网络数据包结构 & simple网络数据包结构
- 包解码&编码
- 消息路由
- 消息序列化(自带json/protobuf)
- 事件
日志
- 基于
uber zap封装，性能良好 - 可配置多文件进行日志输出
- 基于
rotatelogs处理切割日志
扩展组件
data-config组件
- 策划配表读取管理组件
- 可基于本地配置文件的方式加载
- 可基于redis数据的方式加载
- 可基于接口抽像自定义数据源加载
- 支持自定义文件格式读取，目前已实现
JSON格式读取 - 支持缓存热更新
- 可自定义类型检测
- 可根据
go-linq进行数据集合的条件查询
etcd组件
- 基于
etcd组件进行封装，节点集群和注册发现
gin组件
- 集成
gin组件，实现http server功能 - 自定义
controller，增加PreInit()、Init()、Stop()初始周期的管理 - 增加几个常用的
middleware组件- gin zap
- recover with zap
- cors跨域
- max connect限流
- 封装了GET/POST方式获取各种数据类型的函数
gorm组件
- 集成
gorm组件，实现mysql的数据库访问 - 支持多个mysql数据库配置和管理
mongo组件
- 集成
mongo-driver驱动 - 支持多个mongodb数据库配置和管理
cron组件
- 基于
github.com/robfig/cron/v3进行封装成组件 - 性能良好
待开放组件
- db队列
- gopher-lua脚本
- 限流组件
游戏客户端SDK
-
通信协议格式
-
unity3d
-
cocos2dx
-
Javascript
-
C
-
iOS
-
Android & Java
-
微信