ET(四)服务器与网络协议

服务器

1、启动类Server.App项目Program类

这个类主要功能:
1、设置线程同步上下文,用于将异步方法全都能通过Post方法回到主线程调用:SynchronizationContext.SetSynchronizationContext(ThreadSynchronizationContext.Instance);
2、给Event类注册Server.Model工程与Server.Hotfix工程的程序集信息。主要用于将各类特性标签与类型信息注册到Event类中进行管理,同时还包括:注册各个组件的生命周期事件系统(Load,Awake,Update,LateUpdate,Destroy等);各个事件监听的注册等。
3、初始化protobufHelper类:用于序列化Protobuff用,MongoHelper类:用于序列化Mongo用,虽然两个init现在没啥用。
4、解析启动传入的命令行参数,初始化服务器启动参数Option。
5、派发一个服务器启动事件:Game.EventSystem.Publish(new EventType.AppStart());
6、驱动整个游戏循环,包括:Update();LateUpdate();FrameFinish();

2.Server.Hotfix项目AppStart_Init类

这个类继承了AEvent<EventType.AppStart>,并传入了事件类型结构体EventType.AppStart。因此在上一步Event中初始化时,就实例化了AppStart_Init类,且监听了事件EventType.AppStart。因此上面第5步,派发事件EventType.AppStart时,会进入到AppStart_Init类的Run方法中。

1、初始化第一个服务器Scene,Game.Scene,然后给这个Scene添加各种组件:
TimerComponent:定时器
OpcodeTypeComponent:协议管理
MessageDispatcherComponent:普通消息派发处理
CoroutineLockComponent:协程锁
ActorMessageSenderComponent:普通Actor消息发送
ActorLocationSenderComponent:带定位的Location Actor消息发送
LocationProxyComponent:定位服处理
ActorMessageDispatcherComponent:Actor消息派发处理
NumericWatcherComponent:数值变化订阅处理
NetThreadComponent:网络服务管理(注意不是处理只是管理)
2、根据服务类型,创建不同服务,暂且不管监听服务,只管游戏服务。增加内网组件,用于处理来自服务器各个服务之间的通信(包括不同进程之间的)`Game.Scene.AddComponent<NetInnerComponent, IPEndPoint>(processConfig.InnerIPPort);
3、在游戏服类型下,按照配置的StartScene配置,创建对应属于这个服进程号的子Scene。

3.Server.Hotfix项目SceneFactory类

用于创建各个Scene实体类,核心代码如下:

public static async ETTask<Scene> Create(Entity parent, long id, long instanceId, int zone, string name, SceneType sceneType, StartSceneConfig startSceneConfig = null)
        {
            await ETTask.CompletedTask;
            Scene scene = EntitySceneFactory.CreateScene(id, instanceId, zone, sceneType, name, parent);

            scene.AddComponent<MailBoxComponent, MailboxType>(MailboxType.UnOrderMessageDispatcher);

            switch (scene.SceneType)
            {
                case SceneType.Realm:
                    scene.AddComponent<NetKcpComponent, IPEndPoint>(startSceneConfig.OuterIPPort);
                    break;
                case SceneType.Gate:
                    scene.AddComponent<NetKcpComponent, IPEndPoint>(startSceneConfig.OuterIPPort);
                    scene.AddComponent<PlayerComponent>();
                    scene.AddComponent<GateSessionKeyComponent>();
                    break;
                case SceneType.Map:
                    scene.AddComponent<UnitComponent>();
                    scene.AddComponent<RecastPathComponent>();
                    break;
                case SceneType.Location:
                    scene.AddComponent<LocationComponent>();
                    break;
            }

            return scene;
        }

1、根据传入的服务类型,startScene配置ID,InstanceId(这个很重要,它是由生成对应StartSceneConfig单条配置时,由进程号与配置ID组合成的实体ID,通过这个实体ID可以找到对应的进程IP与端口用于通信),服务区号,服务器类型等信息,创建一个服务Scene。
2、对Scene挂载MailBoxComponent组件,用于处理Actor请求,并且区分是否需要按顺序处理收到的请求。(备注:挂在了MailBoxComponent的Entity类就可以处理Actor消息,且可以有顺序处理的功能,Scene也是Entity的一种)
3、针对服务器类型,给上面生成的服务Scene挂载各类功能组件:
NetKcpComponent:网外通信组件,用于监听来自客户端的通信处理
PlayerComponent:用于管理生成的Player实体
GateSessionKeyComponent:用于管理玩家认证的凭据(主要用于Gate认证玩家连接是否被允许)
UnitComponent:用于管理Map中的Unit实体
RecastPathComponent:寻路组件
LocationComponent:用于管理实体对象ID与InstanceID之间的关系,提供了通过ID查询InstanceID的功能。

4、服务器处理协议

查看服务器端的C2R_LoginHandler类,这个类就是收到客户端发来的普通处理协议。

[MessageHandler]
    public class C2R_LoginHandler : AMRpcHandler<C2R_Login, R2C_Login>
    {
        protected override async ETTask Run(Session session, C2R_Login request, R2C_Login response, Action reply)
        {
            // 随机分配一个Gate
            StartSceneConfig config = RealmGateAddressHelper.GetGate(session.DomainZone());
            Log.Debug($"gate address: {MongoHelper.ToJson(config)}");
            
            // 向gate请求一个key,客户端可以拿着这个key连接gate
            G2R_GetLoginKey g2RGetLoginKey = (G2R_GetLoginKey) await ActorMessageSenderComponent.Instance.Call(
                config.InstanceId, new R2G_GetLoginKey() {Account = request.Account});

            response.Address = config.OuterIPPort.ToString();
            response.Key = g2RGetLoginKey.Key;
            response.GateId = g2RGetLoginKey.GateId;
            reply();
        }
    }

注意点:

1、[MessageHandler]特性标记,标记为这个的方法,会由MessageDispatcherComponent分发处理,即由当前进程服务器的消息派发器直接处理(也表示这个处理的协议为普通的协议)

2、派生于AMRpcHandler<C2R_Login, R2C_Login>,表示接受一个C2R_Login类型协议,返回一个R2C_Login协议,AMRpcHandler类封装了回复消息的统一处理,即传入的Action reply。

3、具体的服务器C2R_Login处理为:获取一个随机的Gate的相关配置,Realm向Gate服务发送一条Actor请求,拿到一个客户端登录Gate用的认证Key。Actor请求,这里先不关注,等下一篇进行详细说明,这里姑且当直接拿到一个认证key,并且填到回复类实例中,调用reply将回复协议发送回给客户端。

网络协议

1、协议配置

客户端与服务器通讯,使用的序列化方式为protobuf,使用的库为protobuf-net。
要使用protobuf,需要先定义协议通信数据的结构条目。对应的路径:

image.png

因为登录协议是客户端与服务器通信的,不属于服务器内部协议,所以打开OuterMessage.proto,里面存放的都是客户端与服务器通信定义的协议数据。
比如定义如下,登录协议:
image.png

注意点:
1.因为登录是请求-响应类型协议(即发送一条数据,并期望返回一条数据),所以注意对应C2R_Login协议带有“//ResponseType R2C_Login”标志,在生成协议时,用于标记这个C2R_Login请求对应的响应类型为R2C_Login
2.因为请求是直接发送给realm服的,所以是普通的IRequest类型协议,标记为IRequest
3.R2C_Login回复类消息结构,因为是Realm服发送给客户端的,因此是一个普通IResponse
4.注意两个协议类里面都有RpcId,主要用于发送请求-响应类消息时,发送将自己的RpcID发送出去,返回时带回这个值,用于发送方接受到返回协议时,可以找到对应的是哪一个请求协议返回来的。

2、协议数据生成

命令行进入 Bin 目录 执行
dotnet Tools.dll --AppType=Proto2CS


image.png

可以看到会生成如下协议数据类(为了能看全,把代码折叠了,服务器与客户端生成的是一样的)


image.png
3、发送协议

找到客户端的LoginHelper类,这是写好的发送登录DEMO示例。如下:

 public static async ETTask Login(Scene zoneScene, string address, string account, string password)
        {
            try
            {
                // 创建一个ETModel层的Session
                R2C_Login r2CLogin;
                Session session = null;
                try
                {
                    session = zoneScene.GetComponent<NetKcpComponent>().Create(NetworkHelper.ToIPEndPoint(address));
                    {
                        r2CLogin = (R2C_Login) await session.Call(new C2R_Login() { Account = account, Password = password });
                    }
                }
                finally
                {
                    session?.Dispose();
                }

                // 创建一个gate Session,并且保存到SessionComponent中
                Session gateSession = zoneScene.GetComponent<NetKcpComponent>().Create(NetworkHelper.ToIPEndPoint(r2CLogin.Address));
                gateSession.AddComponent<PingComponent>();
                zoneScene.AddComponent<SessionComponent>().Session = gateSession;
                
                G2C_LoginGate g2CLoginGate = (G2C_LoginGate)await gateSession.Call(
                    new C2G_LoginGate() { Key = r2CLogin.Key, GateId = r2CLogin.GateId});

                Log.Debug("登陆gate成功!");

                Game.EventSystem.Publish(new EventType.LoginFinish() {ZoneScene = zoneScene});
            }
            catch (Exception e)
            {
                Log.Error(e);
            }
        } 

其中核心代码:

// 创建一个ETModel层的Session
                R2C_Login r2CLogin;
                Session session = null;
                try
                {
                    session = zoneScene.GetComponent<NetKcpComponent>().Create(NetworkHelper.ToIPEndPoint(address));
                    {
                        r2CLogin = (R2C_Login) await session.Call(new C2R_Login() { Account = account, Password = password });
                    }
                }
                finally
                {
                    session?.Dispose();
                }

1、首先从当前场景Scene的外网组件NetKcpComponent创建或获取已存在的一个对应IP地址与端口的连接。
2、使用await方法,等待返回协议数据。调用session.call,返回的是带期望结果的ETTask<IResponse>。
3、创建一个新的C2R_Login结构体,填充对应的数据,直接发送。

4、接受返回协议

客户端的LoginHelper类,在服务器接收到C2R_Login类协议,返回R2C_Login后,客户端收到消息,经过一系列处理,r2CLogin = (R2C_Login) await session.Call(new C2R_Login() { Account = account, Password = password });回到这行代码继续执行。因为使用了await 与ETTask异步处理,接收到协议时会回到await之后的代码,即直接获取到了R2C_Login类实例。

这种直接走请求-响应的协议,只需要客户端进行await session.call,然后服务器处理并填充好数据后返回数据,整个流程就已经跑通了。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,271评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,275评论 2 380
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,151评论 0 336
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,550评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,553评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,559评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,924评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,580评论 0 257
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,826评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,578评论 2 320
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,661评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,363评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,940评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,926评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,156评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,872评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,391评论 2 342

推荐阅读更多精彩内容