/gforgame

gforgame是jforgame的go语言实现,是一个轻量级高性能手游服务端框架。项目提供各种支持快速二次开发的组件,以及常用业务功能作为演示。

Primary LanguageGo

项目介绍

gforgame,jforgame 的 go 语言实现。是一个轻量级高性能手游服务端框架。项目提供各种支持快速二次开发的组件,以及常用业务功能作为演示。 需要说明的是,语言只是工具,重要的是**。 当然,由于程序语言本身语法差异,也会影响思考方式和编码方式。

项目特点

  • 搭配框架博客栏目教程,快速理解项目模块原理和 Go 语言特性。
  • 最适合 java 转 go 的开发人员,在这里,你可以找到熟悉的感觉。
  • 融合 Java 游戏服务器**,借鉴 Java 游戏服务器的设计理念,结合 Go 语言的特性进行优化和创新,充分发挥两者的优势。
  • 灵活接入,兼容 Socket 和 WebSocket 接入,通过配置参数轻松切换,无需修改业务代码,完美适配手游、页游、H5 和小游戏的服务端架构。
  • 提供 protobuf 和 JSON 两种通信协议,满足不同客户端的需求,灵活选择最适合的协议进行通信。
  • 提供独立的 HTTP 管理后台网站,支持游戏运维和运营的各类管理需求,提升运维效率和运营支持能力。 --> 后台管理系统

快速入门

代码导入

下载代码到本地,导入项目到 vscode 或者 goland 开发工具
项目自带多个模块案例代码,如 player_service,chat_service
服务器入口: main.go
客户端入口: client.go

私有协议栈

包括包头及包体,格式如下
// header(8bytes) | body
// cmd | len(body) | body

消息编解码

在 message.go 统一管理所有协议的 id
如果采用 json 的话,可直接在 message.go 定义协议结构
如果采用 protobuf 的话,则通过 message.proto 进行注册,再通过 gen_proto.bat 脚本生成 message.pb.go 文件
(使用 protobuf,需要下载 protobuf 编译工具,以及 go 插件,并将两者添加到系统环境变量)

消息路由

遵循“约定大于配置”**,根据方法签名自动扫描,满足一定格式的方法即为消息处理器

    // 消息处理器格式: 第一个参数要求是session,第二个参数要求是已注册的消息; 若方法有返回值且不为空,则自动将返回值下发给客户端
    func (rs PlayerService) ReqLogin(s *network.Session, msg *protos.ReqPlayerLogin) interface{} {

    }

玩家数据读写

数据库使用 mysql, orm 使用 gorm
当有数据发生变化时,定时全量更新,结合 cache 机制,提高读写性能

功能模块

每个功能以模块的形式组织业务,例如背包,任务,技能等等
模块需继承 Module,并在 Init()方法注册该模块的所有通信协议
新模块要通过 network.RegisterModule(player.NewPlayerService())进行注册(扫描消息路由)

websocket

node.Startup()方法参数增加 network.WithWebsocket()代表选择 websocket
example/h5/welcome.html 为 ws 的客户端测试页面

跨服通信

使用 grpc 进行跨进程通信,需要先安装 protobuf 和 protoc-gen-go-grpc 编译插件
根据不同的跨服类型,自行定义业务逻辑,参考 examples/cross 相关代码(流程待完善)

已实现功能

  • tcp 网关,消息路由,消息分发链
  • 日志模块
  • 多环境配置
  • 事件驱动
  • 玩家数据读写
  • 通信协议支持 json+protobuf
  • websocket 接入
  • 使用原生 map 实现一套高效 cache 工具,直接存储原生对象引用而非 byte[],避免频繁序列化与反序列化
  • 数据异步持久化,玩家数据实时更新缓存,定时持久化到数据库
  • http 管理后台
  • grpc 跨服通信接入

近期功能

  • csv 配置文件读取, jforgame-data 实现
  • 代码热更新机制