|
Leaf 是一个由 Go 语言（golang）编写的开发效率和执行效率并重的开源游戏服务器框架。Leaf 适用于各类游戏服务器的开发，包括 H5（HTML5）游戏服务器。
Leaf 的关注点：
一个 Leaf 开发的游戏服务器由多个模块组成（例如@L_502_1@），模块有以下特点：
Leaf 不建议在游戏服务器中设计过多的模块。
游戏服务器在启动时进行模块的注册，例如：
type Module interface {
复制代码
Leaf 首先会在同一个 goroutine 中按模块注册顺序执行模块的 OnInit 方法，等到所有模块 OnInit 方法执行完成后则为每一个模块启动一个 goroutine 并执行模块的 Run 方法。最后，游戏服务器关闭时（Ctrl + C 关闭游戏服务器）将按模块注册相反顺序在同一个 goroutine 中执行模块的 OnDestroy 方法。
Leaf 源码概览
LeafServer是一个基于 Leaf 开发的游戏服务器，我们以 LeafServer 作为起点。
获取 LeafServer：
git clone https://github.com/name5566/leafserver
复制代码
设置 leafserver 目录到 GOPATH 环境变量后获取 Leaf：
go get github.com/name5566/leaf
复制代码
编译 LeafServer：
go install server
复制代码
如果一切顺利，运行 server 你可以获得以下输出：
2015/08/26 22:11:27 [release] Leaf 1.1.2 starting up
复制代码
敲击 Ctrl + C 关闭游戏服务器，服务器正常关闭输出
2015/08/26 22:12:30 [release] Leaf closing down (signal: interrupt)
复制代码
Hello Leaf
现在，在 LeafServer 的基础上，我们来看看游戏服务器如何接收和处理网络消息。
package msg Processor 为消息的处理器（可由用户自定义），这里我们使用 Leaf 默认提供的 JSON 消息处理器并尝试添加一个名字为 Hello 的消息：
"github.com/name5566/leaf/network/json" 客户端发送到游戏服务器的消息需要通过 gate 模块路由，简而言之，gate 模块决定了某个消息具体交给内部的哪个模块来处理。这里，我们将 Hello 消息路由到 game 模块中。打开 LeafServer gate/router.go，敲入如下代码：
package gate 一切就绪，我们现在可以在 game 模块中处理 Hello 消息了。打开 LeafServer game/internal/handler.go，敲入如下代码：
package internal
到这里，一个简单的范例就完成了。为了更加清楚的了解消息的格式，我们从 0 编写一个最简单的测试客户端。
Leaf 中，当选择使用 TCP 协议时，在网络中传输的消息都会使用以下格式：
--------------
复制代码
其中：
@H_516_404@
测试客户端同样使用 Go 语言编写：
package main 执行此测试客户端，游戏服务器输出：
2015/09/25 07:41:03 [debug] hello leaf
复制代码
除了使用 TCP 协议外，还可以选择使用 WebSocket 协议（例如开发 H5 游戏）。Leaf 可以单独使用 TCP 协议或 WebSocket 协议，也可以同时使用两者，换而言之，服务器可以同时接受 TCP 连接和 WebSocket 连接，对开发者而言消息来自 TCP 还是 WebSocket 是完全透明的。现在，我们来编写一个对应上例的使用 WebSocket 协议的客户端：
<script type="text/javascript">
复制代码
保存上述代码到某 HTML 文件中并使用（任意支持 WebSocket 协议的）浏览器打开。在打开此 HTML 文件前，首先需要配置一下 LeafServer 的 bin/conf/server.json 文件，增加 WebSocket 监听地址（WSAddr）：
{ 重启游戏服务器后，方可接受 WebSocket 消息：
2015/09/25 07:50:03 [debug] hello leaf
复制代码
在 Leaf 中使用 WebSocket 需要注意的一点是：Leaf 总是发送二进制消息而非文本消息。
Leaf 模块详解
LeafServer 中包含了 3 个模块，它们分别是：
一般来说（而非强制规定），从代码结构上，一个 Leaf 模块：
@H_516_404@
package game
首先，模块会被实例化，这样才能注册到 Leaf 框架中（详见 LeafServer main.go），另外，模块暴露的 ChanRPC 被用于模块间通讯。
进入 game 模块的内部（LeafServer game/internal/module.go）：
"github.com/name5566/leaf/module"
模块中最关键的就是 skeleton（骨架），skeleton 实现了 Module 接口的 Run 方法并提供了：
由于 Leaf 中，每个模块跑在独立的 goroutine 上，为了模块间方便的相互调用就有了基于 channel 的 RPC 机制。一个 ChanRPC 需要在游戏服务器初始化的时候进行注册（注册过程不是 goroutine 安全的），例如 LeafServer 中 game 模块注册了 NewAgent 和 CloseAgent 两个 ChanRPC：
skeleton.RegisterChanRPC("NewAgent",rpcNewAgent)
使用 skeleton 来注册 ChanRPC。RegisterChanRPC 的第一个参数是 ChanRPC 的名字，第二个参数是 ChanRPC 的实现。这里的 NewAgent 和 CloseAgent 会被 LeafServer 的 gate 模块在连接建立和连接中断时调用。ChanRPC 的调用方有 3 种调用模式：
@H_516_404@
game.ChanRPC.Go("NewAgent",a)
复制代码
这里调用 NewAgent 并传递参数 a，我们在 rpcNewAgent 的参数 args[0] 中可以取到 a（args[1] 表示第二个参数，以此类推）。
更加详细的用法可以参考leaf/chanrpc。需要注意的是，无论封装多么精巧，跨 goroutine 的调用总不能像直接的函数调用那样简单直接，因此除非必要我们不要构建太多的模块，模块间不要太频繁的交互。模块在 Leaf 中被设计出来最主要是用于划分功能而非利用多核，Leaf 认为在模块内按需使用 goroutine 才是多核利用率问题的解决之道。
Leaf Go
善用 goroutine 能够充分利用多核资源，Leaf 提供的 Go 机制解决了原生 goroutine 存在的一些问题：
我们来看一个例子（可以在 LeafServer 的模块的 OnInit 方法中测试）：
log.Debug("1")
复制代码
上面代码执行结果如下：
2015/08/27 20:37:17 [debug] 1
复制代码
这里的 Go 方法接收 2 个函数作为参数，第一个函数会被放置在一个新创建的 goroutine 中执行，在其执行完成之后，第二个函数会在当前 goroutine 中被执行。由此，我们可以看到变量 res 同一时刻总是只被一个 goroutine 访问，这就避免了同步机制的使用。Go 的设计使得 cpu 得到充分利用，避免操作阻塞当前 goroutine，同时又无需为共享资源同步而忧心。
Leaf timer
Go 语言标准库提供了定时器的支持：
func AfterFunc(d Duration,f func()) *Timer
复制代码
AfterFunc 会等待 d 时长后调用 f 函数，这里的 f 函数将在另外一个 goroutine 中执行。Leaf 提供了一个相同的 AfterFunc 函数，相比之下，f 函数在 AfterFunc 的调用 goroutine 中执行，这样就避免了同步机制的使用：
skeleton.AfterFunc(5 * time.Second,serif;font-size:12px;line-height:1.8em;"> // ...
复制代码
|
