leaf游戏服务器开发系列,Leaf游戏服务器框架简介

Leaf 是一个由 Go 语言(golang)编写的开发效率和执行效率并重的开源游戏服务器框架。Leaf 适用于各类游戏服务器的开发&＃xff0c;包括 H5(HTML5)游戏服务器。

Leaf 的关注点&＃xff1a;

·良好的使用体验。Leaf 总是尽可能的提供简洁和易用的接口&＃xff0c;尽可能的提升开发的效率

·稳定性。Leaf 总是尽可能的恢复运行过程中的错误&＃xff0c;避免崩溃

·多核支持。Leaf 通过模块机制和 leaf/go 尽可能的利用多核资源&＃xff0c;同时又尽量避免各种副作用

·模块机制。

一、Leaf 的模块机制

一个 Leaf 开发的游戏服务器由多个模块组成(例如 LeafServer)&＃xff0c;模块有以下特点&＃xff1a;

·每个模块运行在一个单独的 goroutine 中

·模块间通过一套轻量的 RPC 机制通讯(leaf/chanrpc)

Leaf 不建议在游戏服务器中设计过多的模块。

游戏服务器在启动时进行模块的注册&＃xff0c;例如&＃xff1a;

这里按顺序注册了 game、gate、login 三个模块。每个模块都需要实现接口&＃xff1a;

Leaf 首先会在同一个 goroutine 中按模块注册顺序执行模块的 OnInit 方法&＃xff0c;等到所有模块 OnInit 方法执行完成后则为每一个模块启动一个 goroutine 并执行模块的 Run 方法。最后&＃xff0c;游戏服务器关闭时(Ctrl &＃43; C 关闭游戏服务器)将按模块注册相反顺序在同一个 goroutine 中执行模块的 OnDestroy 方法。

二、Leaf 源码概览

·leaf/chanrpc 提供了一套基于 channel 的 RPC 机制&＃xff0c;用于游戏服务器模块间通讯

·leaf/db 数据库相关&＃xff0c;目前支持 MongoDB

·leaf/gate 网关模块&＃xff0c;负责游戏客户端的接入

·leaf/go 用于创建能够被 Leaf 管理的 goroutine

·leaf/log 日志相关

·leaf/network 网络相关&＃xff0c;使用 TCP 和 WebSocket 协议&＃xff0c;可自定义消息格式&＃xff0c;默认 Leaf 提供了基于 protobuf和 JSON 的消息格式

·leaf/recordfile 用于管理游戏数据

·leaf/timer 定时器相关

·leaf/util 辅助库

三、使用 Leaf 开发游戏服务器

LeafServer 是一个基于 Leaf 开发的游戏服务器&＃xff0c;我们以 LeafServer 作为起点。

获取 LeafServer&＃xff1a;

设置 leafserver 目录到 GOPATH 环境变量后获取 Leaf&＃xff1a;

编译 LeafServer&＃xff1a;

如果一切顺利&＃xff0c;运行 server 你可以获得以下输出&＃xff1a;

敲击 Ctrl &＃43; C 关闭游戏服务器&＃xff0c;服务器正常关闭输出&＃xff1a;

四、Hello Leaf

现在&＃xff0c;在 LeafServer 的基础上&＃xff0c;我们来看看游戏服务器如何接收和处理网络消息。

首先定义一个 JSON 格式的消息(protobuf 类似)。打开 LeafServer msg/msg.go 文件可以看到如下代码&＃xff1a;

Processor 为消息的处理器(可由用户自定义)&＃xff0c;这里我们使用 Leaf 默认提供的 JSON 消息处理器并尝试添加一个名字为 Hello 的消息&＃xff1a;

客户端发送到游戏服务器的消息需要通过 gate 模块路由&＃xff0c;简而言之&＃xff0c;gate 模块决定了某个消息具体交给内部的哪个模块来处理。这里&＃xff0c;我们将 Hello 消息路由到 game 模块中。打开 LeafServer gate/router.go&＃xff0c;敲入如下代码&＃xff1a;

一切就绪&＃xff0c;我们现在可以在 game 模块中处理 Hello 消息了。打开 LeafServer game/internal/handler.go&＃xff0c;敲入如下代码&＃xff1a;

到这里&＃xff0c;一个简单的范例就完成了。为了更加清楚的了解消息的格式&＃xff0c;我们从 0 编写一个最简单的测试客户端。

Leaf 中&＃xff0c;当选择使用 TCP 协议时&＃xff0c;在网络中传输的消息都会使用以下格式&＃xff1a;

其中&＃xff1a;

·len 表示了 data 部分的长度(字节数)。len 本身也有长度&＃xff0c;默认为 2 字节(可配置)&＃xff0c;len 本身的长度决定了单个消息的最大大小

·data 部分使用 JSON 或者 protobuf 编码(也可自定义其他编码方式)

测试客户端同样使用 Go 语言编写&＃xff1a;

执行此测试客户端&＃xff0c;游戏服务器输出&＃xff1a;

测试客户端发送完消息以后就退出了&＃xff0c;此时和游戏服务器的连接断开&＃xff0c;相应的&＃xff0c;游戏服务器输出连接断开的提示日志(第二条日志&＃xff0c;日志的具体内容和 Go 语言版本有关)。

除了使用 TCP 协议外&＃xff0c;还可以选择使用 WebSocket 协议(例如开发 H5 游戏)。Leaf 可以单独使用 TCP 协议或WebSocket 协议&＃xff0c;也可以同时使用两者&＃xff0c;换而言之&＃xff0c;服务器可以同时接受 TCP 连接和 WebSocket 连接&＃xff0c;对开发者而言消息来自 TCP 还是 WebSocket 是完全透明的。现在&＃xff0c;我们来编写一个对应上例的使用 WebSocket 协议的客户端&＃xff1a;

保存上述代码到某 HTML 文件中并使用(任意支持 WebSocket 协议的)浏览器打开。在打开此 HTML 文件前&＃xff0c;首先需要配置一下 LeafServer 的 bin/conf/server.json 文件&＃xff0c;增加 WebSocket 监听地址(WSAddr)&＃xff1a;

重启游戏服务器后&＃xff0c;方可接受 WebSocket 消息&＃xff1a;

在 Leaf 中使用 WebSocket 需要注意的一点是&＃xff1a;Leaf 总是发送二进制消息而非文本消息。

五、Leaf 模块详解

LeafServer 中包含了 3 个模块&＃xff0c;它们分别是&＃xff1a;

·gate 模块&＃xff0c;负责游戏客户端的接入

·login 模块&＃xff0c;负责登录流程

·game 模块&＃xff0c;负责游戏主逻辑

一般来说(而非强制规定)&＃xff0c;从代码结构上&＃xff0c;一个 Leaf 模块&＃xff1a;

·放置于一个目录中(例如 game 模块放置于 game 目录中)

·模块的具体实现放置于 internal 包中(例如 game 模块的具体实现放置于 game/internal 包中)

每个模块下一般有一个 external.go 的文件&＃xff0c;顾名思义表示模块对外暴露的接口&＃xff0c;这里以 game 模块的external.go 文件为例&＃xff1a;

首先&＃xff0c;模块会被实例化&＃xff0c;这样才能注册到 Leaf 框架中(详见 LeafServer main.go)&＃xff0c;另外&＃xff0c;模块暴露的

模块中最关键的就是 skeleton(骨架)&＃xff0c;skeleton 实现了 Module 接口的 Run 方法并提供了&＃xff1a;

·ChanRPC

·goroutine

·定时器

六、Leaf ChanRPC

由于 Leaf 中&＃xff0c;每个模块跑在独立的 goroutine 上&＃xff0c;为了模块间方便的相互调用就有了基于 channel 的 RPC 机制。一个 ChanRPC 需要在游戏服务器初始化的时候进行注册(注册过程不是 goroutine 安全的)&＃xff0c;例如 LeafServer中 game 模块注册了 NewAgent 和 CloseAgent 两个 ChanRPC&＃xff1a;

使用 skeleton 来注册 ChanRPC。RegisterChanRPC 的第一个参数是 ChanRPC 的名字&＃xff0c;第二个参数是 ChanRPC 的实现。这里的 NewAgent 和 CloseAgent 会被 LeafServer 的 gate 模块在连接建立和连接中断时调用。ChanRPC 的调用方有 3 种调用模式&＃xff1a;

·同步模式&＃xff0c;调用并等待 ChanRPC 返回

·异步模式&＃xff0c;调用并提供回调函数&＃xff0c;回调函数会在 ChanRPC 返回后被调用

·Go 模式&＃xff0c;调用并立即返回&＃xff0c;忽略任何返回值和错误

gate 模块这样调用 game 模块的 NewAgent ChanRPC(这仅仅是一个示例&＃xff0c;实际的代码细节复杂的多)&＃xff1a;

这里调用 NewAgent 并传递参数 a&＃xff0c;我们在 rpcNewAgent 的参数 args[0] 中可以取到 a(args[1] 表示第二个参数&＃xff0c;以此类推)。

更加详细的用法可以参考 leaf/chanrpc。需要注意的是&＃xff0c;无论封装多么精巧&＃xff0c;跨 goroutine 的调用总不能像直接的函数调用那样简单直接&＃xff0c;因此除非必要我们不要构建太多的模块&＃xff0c;模块间不要太频繁的交互。模块在 Leaf 中被设计出来最主要是用于划分功能而非利用多核&＃xff0c;Leaf 认为在模块内按需使用 goroutine 才是多核利用率问题的解决之道。

七、Leaf Go

善用 goroutine 能够充分利用多核资源&＃xff0c;Leaf 提供的 Go 机制解决了原生 goroutine 存在的一些问题&＃xff1a;

·能够恢复 goroutine 运行过程中的错误

·游戏服务器会等待所有 goroutine 执行结束后才关闭

·非常方便的获取 goroutine 执行的结果数据

·在一些特殊场合保证 goroutine 按创建顺序执行

我们来看一个例子(可以在 LeafServer 的模块的 OnInit 方法中测试)&＃xff1a;

上面代码执行结果如下&＃xff1a;

这里的 Go 方法接收 2 个函数作为参数&＃xff0c;第一个函数会被放置在一个新创建的 goroutine 中执行&＃xff0c;在其执行完成之后&＃xff0c;第二个函数会在当前 goroutine 中被执行。由此&＃xff0c;我们可以看到变量 res 同一时刻总是只被一个 goroutine访问&＃xff0c;这就避免了同步机制的使用。Go 的设计使得 CPU 得到充分利用&＃xff0c;避免操作阻塞当前 goroutine&＃xff0c;同时又无需为共享资源同步而忧心。

更加详细的用法可以参考 leaf/go。

八、Leaf timer

Go 语言标准库提供了定时器的支持&＃xff1a;

AfterFunc 会等待 d 时长后调用 f 函数&＃xff0c;这里的 f 函数将在另外一个 goroutine 中执行。Leaf 提供了一个相同的 AfterFunc 函数&＃xff0c;相比之下&＃xff0c;f 函数在 AfterFunc 的调用 goroutine 中执行&＃xff0c;这样就避免了同步机制的使用&＃xff1a;

另外&＃xff0c;Leaf timer 还支持 cron 表达式&＃xff0c;用于实现诸如“每天 9 点执行”、“每周末 6 点执行”的逻辑。

更加详细的用法可以参考 leaf/timer。

九、Leaf log

Leaf 的 log 系统支持多种日志级别&＃xff1a;

·Debug 日志&＃xff0c;非关键日志

·Release 日志&＃xff0c;关键日志

·Error 日志&＃xff0c;错误日志

·Fatal 日志&＃xff0c;致命错误日志

·Debug

在 LeafServer 中&＃xff0c;bin/conf/server.json 可以配置日志级别&＃xff0c;低于配置的日志级别的日志将不会输出。Fatal日志比较特殊&＃xff0c;每次输出 Fatal 日志之后游戏服务器进程就会结束&＃xff0c;通常来说&＃xff0c;只在游戏服务器初始化失败时使用Fatal 日志。

更加详细的用法可以参考 leaf/log。

十、Leaf recordfile

Leaf 的 recordfile 是基于 CSV 格式(范例见这里)。recordfile 用于管理游戏配置数据。在 LeafServer 中使用 recordfile 非常简单&＃xff1a;

·将 CSV 文件放置于 bin/gamedata 目录中

·在 gamedata 模块中调用函数 readRf 读取 CSV 文件

范例&＃xff1a;

更加详细的用法可以参考 leaf/recordfile。

十一、写在最后的话

本文虽然未能全面描述 Leaf 服务器框架的方方面面&＃xff0c;但整体轮廓已经显现。Leaf 尚小&＃xff0c;但已经足够构建一个完整游戏服务器。在对开发效率的执着追求上&＃xff0c;Leaf 还有很长的路需要走。