社区leaf学习笔记|01. leaf开源游戏服务器搭建

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

Leaf 的关注点:

  • 良好的使用体验。Leaf 总是尽可能的提供简洁和易用的接口,尽可能的提升开发的效率

  • 稳定性。Leaf 总是尽可能的恢复运行过程中的错误,避免崩溃

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

    Leaf 的模块机制

  • 一个 Leaf 开发的游戏服务器由多个模块组成(例如 LeafServer),模块有以下特点:

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

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

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


  • 游戏服务器在启动时进行模块的注册,例如:

  • leaf.Run(

  •     game.Module,

  •     gate.Module,

  •     login.Module,

  • )


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

  • type Module interface {

  •     OnInit()

  •     OnDestroy()

  •     Run(closeSig chan bool)

  • }

  • Leaf 源码概览使用 Leaf 开发游戏服务器

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

  • leaf/chanrpc 提供了一套基于 channel 的 RPC 机制,用于游戏服务器模块间通讯

  • leaf/db 数据库相关,目前支持 MongoDB

  • leaf/gate 网关模块,负责游戏客户端的接入

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

  • leaf/log 日志相关

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

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

  • leaf/timer 定时器相关

  • leaf/util 辅助库

  • LeafServer 是一个基于 Leaf 开发的游戏服务器,我们以 LeafServer 作为起点。

  • 获取 LeafServer:

  • git clone https://github.com/name5566/leafserver

  • 设置 leafserver 目录到 GOPATH 环境变量后获取 Leaf:

  • go get github.com/name5566/leaf

  • 输出搭建好的编译运行结果:

  • -----》》》》   Leaf 1.1.2 starting up


  • 社区leaf学习笔记|01. leaf开源游戏服务器搭建




上一篇:Leaf——美团点评分布式ID生成系统


下一篇:社区leaf学习笔记|03. 调试Game、Login模块收发消息