多人简易版球球大作战，游戏服务器框架moon的一个使用示例。 主要演示

• 游戏服管理大量客户端网络连接
• One Player One Service模式,处理玩家非共享状态,提高单服承载能力和更加Clean的内存管理
• 异步Redis连接池服务的使用
• 使用sharetable管理和更新游戏配表
• 客户端消息自动注册和处理
• 服务间消息自动注册和通信
• 游戏逻辑编写规范
• 服务器集群搭建
• 服务器简易管理后台
• 代码热更
• 代码注解
• 使用vscode LuaPanda 插件调试服务器代码
• 使用vscode lua-language-server 插件提供lua代码智能能提示: vscode打开server目录，安装lua-language-server插件，即可获得代码提示能力，如果没有代码提示，在.vscode目录下, 创建或者修改settings.json, 添加

   { "Lua.workspace.library": [ "./moon/lualib/", "./moon/service/" ] }

Hub Server:

1. 提供服务后台管理, 服务器节点配置管理(支持动态开启新服)
2. 提供http server 和 telnet两种协议接口

Game Server开启了7种服务:

• node 处理hub的请求消息，常用于对接SDK和服务器后台管理
• cluster 服务器集群通信节点服务
• gate 负责管理玩家网络连接，并转发玩家网络消息到对应玩家服务
• auth 负责登录，创建、删除、离线加载、玩家服务
• center 负责玩家匹配逻辑，动态创建room服务
• user 玩家服务，一个服务对应一个玩家，处理玩家消息，管理玩家私有状态。 与其它玩家交互的消息转发到room服务。
• room 游戏场景服务，简易球球大作战玩法逻辑

目录结构

. ├── common/ #逻辑公共模块目录 │   ├── CmdCode.lua #自动生成的和客户端通信的协议定义文件 │   ├── Database.lua #数据库操作 │   ├── ErrorCode.lua #逻辑错误码定义 │   ├── GameCfg.lua #游戏配表 │   ├── GameDef.lua #游戏内部相关配置 │   ├── LuaPanda.lua #LuaPanda调试库 │   ├── init.lua #common目录初始化脚本 │   ├── protocol.lua │   ├── protocol_pb.lua #protobuf消息编码和解码逻辑 │   ├── setup.lua #All In One包装: 消息注册，服务内模块注册，配表更新，代码热更 │   ├── vector2.lua │   └── verify_proto.lua #开发环境下，Lua数据结构严格验证库 ├── game │   ├── auth #每个服务对应的逻辑脚本目录 │   ├── center │   ├── gate │   ├── node │   ├── room │   ├── service_auth.lua │   ├── service_center.lua │   ├── service_gate.lua │   ├── service_hub.lua │   ├── service_node.lua │   ├── service_room.lua │   ├── service_user.lua │   └── user ├── log # 运行日志目录 ├── main_game.lua # game 进程启动文件 ├── main_hub.lua # hub 进程启动文件 ├── moon # moon源码 ├── node.json # 节点配置文件，用于集群通信 ├── protocol # protobuf协议定义目录 │   ├── annotations.proto # 只用于生成Lua代码注解 │   ├── center.proto # 定义自动转发到Center服务的消息 │   ├── common.proto # 公共protobuf定义 │   ├── json_verify.json # 用于verify_proto │   ├── proto.pb │   ├── room.proto # 定义自动转发到Room服务的消息 │   └── user.proto # 定义自动转发到User服务的消息 ├── robot │   └── robot.lua # 机器人脚本 ├── serverconf.lua # 数据库相关配置 ├── start_game.sh ├── start_hub.sh ├── start_server.bat ├── static │   ├── table # 游戏配表目录 │   └── www # GM后台目录 └── tools ├── Annotations.lua # 自动生成的代码注解文件 ├── ProtoEnum.lua ├── __pycache__ ├── make_annotations.py ├── moonfly.bat ├── moonfly.py # 代码注解生成脚本 └── protoc3.exe

1. clone

git clone --recursive https://github.com/sniper00/MoonDemo.git 

2. 参考moon编译

• 安装redis采用默认配置即可。如需要修改数据库配置, 可以修改server目录下的serverconf.lua。

• 如果想使用postgresql, 修改server目录下的serverconf.lua中pgsql相关配置，main_game.lua 中取消db_game服务的注释，这样userdata数据会保存到postgresql中

• windows使用 start_server.bat 脚本运行。linux和macos使用start_hub.sh,start_game.sh依次启动。默认会自动运行机器人服务。配表 可以修改机器人数量

• 简易后台管理

  • 方式一 Web http://127.0.0.1:8003/
  • 方式二 telnet 127.0.0.1 8003, 输入 S1 help

• 如需要自己部署，可以修改node.json中的ip地址

• Client请使用unity2022 启动执行第一个场景Prepare。

• 安装vscode
• 安装LuaPanda 插件
• 在需要调试的服务第一行添加代码(作为示例，room服务第一行添加了这行代码)

require("common.LuaPanda").start("127.0.0.1", 8818)

• 配置调试器

• F5启动vscode-LuaPanda调试器
• 使用vscode,在该服务的逻辑代码出下断点
• 运行服务器，触发断点处的逻辑

客户端主要用来演示怎样使用 asyn/await 来处理网络消息，等异步操作。

var v = await Network.Call<S2CLogin>(UserData.GameSeverID, new C2SLogin { openid = userName.text }); if (v.ok) { UserData.time = v.time; UserData.username = userName.text; await Network.Call<S2CMatch>(UserData.GameSeverID, new C2SMatch {}); SceneManager.LoadScene("MatchWait"); } else { MessageBox.Show("auth failed"); } //获取请求结果或者逻辑ErrorCode var callResult = await Network.Call<NetMessage.S2CWorld, NetMessage.S2CErrorCode>(UserData.GameSeverID, new NetMessage.C2SHello { Hello = "world" }); if (!callResult.IsFirstResponse) { Debug.Log("error:" + callResult.Response2.Code); }

//注册回调方式的网络消息 Network.Register<NetMessage.S2CMatchSuccess>((res) => { MessageBox.SetVisible(false); SceneManager.LoadScene("Game"); });

需要安装python3

修改server的protocol目录下的proto文件，协议命名规则

• C2Sxxxx表示客户端发送给服务器的消息；
• S2Cxxxxx,SBCxxxxx 表示服务器发送给客户端的消息，其中SBC表示广播消息，只是为了便于区分。

user.proto center.proto room.proto common.proto annotations.proto 只生成lua注解时使用 

编写完成协议后，运行tools目录下的moonfly.bat,其它平台运行python3 moonfly.py

protocol目录的文件都会生成lua注解，建议逻辑中多定义proto结构，提高开发速度，特别是复杂的对象，能达到 typescript 80% 的代码提示能力。对于关键数据可以用使用 verify_proto 进行验证，如需要存数据库的数据。

如果是小游戏之类的客户端，不想采用protobuf作为通信协议，可以通过修改这里, 采用json作为通信协议。注意Demo自带的Unity客户端暂时不支持切换Json协议。

在 protocol/user.proto 中添加, 然后运行tools/moonfly.bat

//客户端发送 message C2SHello { string hello = 1; } //服务器返回 message S2CWorld { string world = 1; }

在game/user/目录下新建文件 "Hello.lua"

1. Lua逻辑脚本标准定义

local common = require "common" local GameCfg = common.GameCfg --游戏配置 local ErrorCode = common.ErrorCode --逻辑错误码 local CmdCode = common.CmdCode --客户端通信消息码 ---@type user_context local context = ... local scripts = context.scripts ---方便访问同服务的其它lua模块 local Hello = {} ---这里初始化本模块相关的数据 function Hello.Init() -- local DB = scripts.UserModel.Get() -- if not DB.hello then -- DB.hello = { -- a = 1, -- b = 2 -- } -- end end ---这里可以访问其它模块,做更多初始化工作 function Hello.Start() --scripts.Item.AddItem(1,1,1) end return Hello

2. 编写逻辑(完整代码)

local moon = require("moon") local common = require "common" local GameCfg = common.GameCfg --游戏配置 local ErrorCode = common.ErrorCode --逻辑错误码 local CmdCode = common.CmdCode --客户端通信消息码 ---@type user_context local context = ... local scripts = context.scripts ---方便访问同服务的其它lua模块 ---@class Hello ---代码提示 local Hello = {} ---这里初始化本模块相关的数据 function Hello.Init() -- local DB = scripts.UserModel.Get() -- if not DB.hello then -- DB.hello = { -- a = 1, -- b = 2 -- } -- end end ---这里可以访问其它模块,做更多初始化工作 function Hello.Start() scripts.Item.AddItem(1,1,1) end ---注册服务间通信的消息处理函数 ---其它服务可以访问`context.send_user(uid, "Hello.DoSometing1", 1)` function Hello.DoSometing1(params) ---访问内存中的数据库对象: MutGet会触发存库操作 local data = scripts.UserModel.MutGet().hello data.a = 100 end ---注册服务间通信的消息处理函数 ---其它服务可以访问`local res = context.call_user(uid, "Hello.DoSometing1", 1)` function Hello.DoSometing2() ---访问内存中的数据库对象: Get用于只读，不会触发存库 local data = scripts.UserModel.Get().hello return data.a end ---注册客户端消息处理函数 ---@param req C2SHello function Hello.C2SHello(req) local cfg = GameCfg.item[1] if not cfg then return ErrorCode.ItemNotExist ---直接返回错误码, 会给玩家发送 S2CErrorCode 消息 end context.S2C(CmdCode.S2CWorld, {world=req.hello}) ---给客户端发送消息 end return Hello