Home

Awesome

项目介绍　　

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

项目特点

快速入门

代码导入

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

私有协议栈

包括包头及包体，格式如下
// header(12bytes) | body
// cmd | index| len(body) | body

消息编解码

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

消息路由

遵循“约定大于配置”思想，根据方法（非函数）签名自动扫描，满足一定格式的方法即为消息处理器

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

    }

    // 消息处理器格式2： 方法第一个参数要求是session,第二个参数是一个index; 第个参数要求是已注册的消息
    // 索引用于异步给客户端发送请求(例如另起协程)，如果是同步的话，直接通过格式1即可
    func (rs PlayerService) ReqLogin(s *network.Session, index int, msg *protos.ReqPlayerLogin)  {

    }

玩家数据读写

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

功能模块

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

websocket

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

跨服通信方式一：基于 rpc

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

跨服通信方式二：基于 socket

推荐使用原生的 socket 进行跨进程通信，无论是游戏应用作为客户端，还是跨服节点作为客户端
都使用统一的调用方式，也无须引入 grpc
客户端消息处理支持三种方法：
1，类似服务器消息路由（通过方法签名）
2，客户端同步阻塞(通过方法返回值)


    import "io/github/gforgame/network/client"
    r, err := client.Request(session, &protos.ReqPlayerLogin{Id: "1001"})
	if err != nil {
		fmt.Println(err)
	}
	resPlayerLogin := r.(*protos.ResPlayerLogin)
	fmt.Println("客户端收到消息：(", resPlayerLogin, ")")

3，客户端异步回调(通过注册回调函数，类似 ajax)


    import "io/github/gforgame/network/client"

    // 实现 RequestCallback 接口的匿名对象
    type commonCallback struct{}

    func (rc *commonCallback) OnSuccess(result any) {
        fmt.Println("OnSuccess: ", result)
    }

    func (rc *commonCallback) OnError(err error) {
        fmt.Println("OnError: ", err)
    }

    client.Callback(session, &protos.ReqPlayerLogin{Id: "1001"}, &commonCallback{})

已实现功能

近期功能