golang Leaf 游戏服务器框架简介
|
Leaf 是一个由 Go 语言（golang）编写的开发效率和执行效率并重的开源游戏服务器框架。Leaf 适用于各类游戏服务器的开发，包括 H5（HTML5）游戏服务器。 Leaf 的关注点：
Leaf 的模块机制一个 Leaf 开发的游戏服务器由多个模块组成（例如LeafServer），模块有以下特点： Leaf 不建议在游戏服务器中设计过多的模块。 游戏服务器在启动时进行模块的注册，例如： leaf.Run(
game.Module,gate.Module,login.Module,)
这里按顺序注册了 game、gate、login 三个模块。每个模块都需要实现接口： type Module interface {
OnInit()
OnDestroy()
Run(closeSig chan bool)
}
Leaf 首先会在同一个 goroutine 中按模块注册顺序执行模块的 OnInit 方法，等到所有模块 OnInit 方法执行完成后则为每一个模块启动一个 goroutine 并执行模块的 Run 方法。最后，游戏服务器关闭时（Ctrl + C 关闭游戏服务器）将按模块注册相反顺序在同一个 goroutine 中执行模块的 OnDestroy 方法。 Leaf 源码概览使用 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 的基础上，我们来看看游戏服务器如何接收和处理网络消息。 首先定义一个 JSON 格式的消息（protobuf 类似）。打开 LeafServer msg/msg.go 文件可以看到如下代码： package msg
import (
"github.com/name5566/leaf/network"
)
var Processor network.Processor
func init() {
}
Processor 为消息的处理器（可由用户自定义），这里我们使用 Leaf 默认提供的 JSON 消息处理器并尝试添加一个名字为 Hello 的消息： "github.com/name5566/leaf/network/json"
)
// 使用默认的 JSON 消息处理器（默认还提供了 protobuf 消息处理器）
var Processor = json.NewProcessor()
init() {
// 这里我们注册了一个 JSON 消息 Hello
Processor.Register(&Hello{})
}
// 一个结构体定义了一个 JSON 消息的格式
// 消息名为 Hello
Hello struct {
Name string
}
客户端发送到游戏服务器的消息需要通过 gate 模块路由，简而言之，gate 模块决定了某个消息具体交给内部的哪个模块来处理。这里，我们将 Hello 消息路由到 game 模块中。打开 LeafServer gate/router.go，敲入如下代码： package gate
"server/game"
"server/msg"
)
// 这里指定消息 Hello 路由到 game 模块
// 模块间使用 ChanRPC 通讯，消息路由也不例外
msg.Processor.SetRouter(&msg.Hello{},game.ChanRPC)
}
一切就绪，我们现在可以在 game 模块中处理 Hello 消息了。打开 LeafServer game/internal/handler.go，敲入如下代码： package internal
"github.com/name5566/leaf/log"
"github.com/name5566/leaf/gate"
"reflect"
// 向当前模块（game 模块）注册 Hello 消息的消息处理函数 handleHello
handler(&msg.Hello{},handleHello)
}
handler(m interface{},h interface{}) {
skeleton.RegisterChanRPC(reflect.TypeOf(m),h)
}
handleHello(args []interface{}) {
// 收到的 Hello 消息
m := args[0].(*msg.Hello)
// 消息的发送者
a 1].(gate.Agent)
// 输出收到的消息的内容
log.Debug("hello %v",m.Name)
// 给发送者回应一个 Hello 消息
a.WriteMsg(&msg.Hello{
Name: "client",})
}
到这里，一个简单的范例就完成了。为了更加清楚的了解消息的格式，我们从 0 编写一个最简单的测试客户端。 Leaf 中，当选择使用 TCP 协议时，在网络中传输的消息都会使用以下格式： -------------- | len | data | -------------- 其中：
测试客户端同样使用 Go 语言编写： package main
"encoding/binary"
"net"
)
main() {
conn,err := net.Dial("tcp","127.0.0.1:3563")
if err != nil {
panic(err)
}
// Hello 消息（JSON 格式）
// 对应游戏服务器 Hello 消息结构体
data := []byte(`{
"Hello": {
"Name": "leaf"
}
}`)
// len + data
m := make([]byte,2+len(data))
// 默认使用大端序
binary.BigEndian.PutUint16(m,197);">uint16(len(data)))
copy(m[2:],data)
// 发送消息
conn.Write(m)
}
执行此测试客户端，游戏服务器输出： 2015/09/25 07:41:03 [debug ] hello leaf 2015/09/25 07:41:03 [debug ] read message: read tcp 127.0.0.1:3563->127.0.0.1:54599: wsarecv: An existing connection was forcibly closed by the remote host. 测试客户端发送完消息以后就退出了，此时和游戏服务器的连接断开，相应的，游戏服务器输出连接断开的提示日志（第二条日志，日志的具体内容和 Go 语言版本有关）。 除了使用 TCP 协议外，还可以选择使用 WebSocket 协议（例如开发 H5 游戏）。Leaf 可以单独使用 TCP 协议或 WebSocket 协议，也可以同时使用两者，换而言之，服务器可以同时接受 TCP 连接和 WebSocket 连接，对开发者而言消息来自 TCP 还是 WebSocket 是完全透明的。现在，我们来编写一个对应上例的使用 WebSocket 协议的客户端： <script type="text/javascript">
var ws = new WebSocket('ws://127.0.0.1:3653')
ws.onopen function() {
// 发送 Hello 消息
ws.send(JSON.stringify({Hello: {
Name: 'leaf'
}}))
}
</script>
保存上述代码到某 HTML 文件中并使用（任意支持 WebSocket 协议的）浏览器打开。在打开此 HTML 文件前，首先需要配置一下 LeafServer 的 bin/conf/server.json 文件，增加 WebSocket 监听地址（WSAddr）： {
"LogLevel": "debug",98);">"LogPath": "",98);">"TCPAddr": "127.0.0.1:3563",98);">"WSAddr": "127.0.0.1:3653",98);">"MaxConnNum": 20000
}
重启游戏服务器后，方可接受 WebSocket 消息： 2015/09/25 07:50:03 [debug ] hello leaf 在 Leaf 中使用 WebSocket 需要注意的一点是：Leaf 总是发送二进制消息而非文本消息。 Leaf 模块详解LeafServer 中包含了 3 个模块，它们分别是：
一般来说（而非强制规定），从代码结构上，一个 Leaf 模块：
每个模块下一般有一个 external.go 的文件，顾名思义表示模块对外暴露的接口，这里以 game 模块的 external.go 文件为例： package game
"server/game/internal"
)
var (
// 实例化 game 模块
Module = new(internal.Module)
// 暴露 ChanRPC
ChanRPC = internal.ChanRPC
)
首先，模块会被实例化，这样才能注册到 Leaf 框架中（详见 LeafServer main.go），另外，模块暴露的 ChanRPC 被用于模块间通讯。 进入 game 模块的内部（LeafServer game/internal/module.go）： "github.com/name5566/leaf/module"
"server/base"
)
var (
skeleton = base.NewSkeleton()
ChanRPC = skeleton.ChanRPCServer
)
struct {
*module.Skeleton
}
(m *Module) OnInit() {
m.Skeleton = skeleton
}
Module) OnDestroy() {
}
模块中最关键的就是 skeleton（骨架），skeleton 实现了 Module 接口的 Run 方法并提供了：
Leaf ChanRPC由于 Leaf 中，每个模块跑在独立的 goroutine 上，为了模块间方便的相互调用就有了基于 channel 的 RPC 机制。一个 ChanRPC 需要在游戏服务器初始化的时候进行注册（注册过程不是 goroutine 安全的），例如 LeafServer 中 game 模块注册了 NewAgent 和 CloseAgent 两个 ChanRPC： "github.com/name5566/leaf/gate"
)
init() {
skeleton.RegisterChanRPC("NewAgent",rpcNewAgent)
skeleton."CloseAgent",rpcCloseAgent)
}
rpcNewAgent(interface{}) {
}
rpcCloseAgent(interface{}) {
}
使用 skeleton 来注册 ChanRPC。RegisterChanRPC 的第一个参数是 ChanRPC 的名字，第二个参数是 ChanRPC 的实现。这里的 NewAgent 和 CloseAgent 会被 LeafServer 的 gate 模块在连接建立和连接中断时调用。ChanRPC 的调用方有 3 种调用模式： gate 模块这样调用 game 模块的 NewAgent ChanRPC（这仅仅是一个示例，实际的代码细节复杂的多）： game.ChanRPC.Go(这里调用 NewAgent 并传递参数 a，我们在 rpcNewAgent 的参数 args[0] 中可以取到 a（args[1] 表示第二个参数，以此类推）。
|