如何使用自定义消息?--ESFramework 4.0 快速上手(04)

ESFramework 4.0 快速上手一文中,我们讲述了如何使用Rapid引擎可以快速地上手ESFramework开发,文中介绍了使用ESPlus.Application.CustomizeInfo命名空间下的类可以发送和处理自定义消息,本文我们就通过一个简单的例子来深入讲解如何使用自定义消息。

  例子的场景很简单:假设客户端登陆到服务器之后,要求请求加入某个组,服务端收到该请求后,处理该请求,并给客户端相应的回复 -- 是否加入成功,客户端收到回复后,即可作出相应的处理。

一.定义消息类型和消息协议Contract

  这个场景涉及到两种类型的消息:请求加入组(客户端发给服务器),加入组的结果(服务器回复给客户端)。于是,我们可以定义这两个消息类型:

public static class InformationTypes
        {
            /// <summary>
            /// 请求加入组 Client =》 Server 。对应的消息体为 JoinGroupContract

/// </summary>
            public const int JoinGroup = 1;

/// <summary>
            /// 加入组的结果 Server =》 Client 。对应的消息体为 JoinGroupResultContract
            /// </summary>
            public const int JoinGroupResult = 2;
        }

  另外,我们可以客户端发给服务器的请求以及服务器给客户端的回复分别用协议类JoinGroupContract和JoinGroupResultContract封装起来:

[Serializable]
        public class JoinGroupContract
        {
            public JoinGroupContract() { }
            public JoinGroupContract(string _groupID, string _groupPwd)
            {
                this.groupID = _groupID;
                this.groupPwd = _groupPwd;
            }

#region GroupID
            private string groupID = "";
            /// <summary>
            /// 请求加入组的ID
            /// </summary>
            public string GroupID
            {
                get { return groupID; }
                set { groupID = value; }
            }
            #endregion

#region GroupPwd
            private string groupPwd = "";
            /// <summary>
            /// 请求加入组的密码
            /// </summary>
            public string GroupPwd
            {
                get { return groupPwd; }
                set { groupPwd = value; }
            } 
            #endregion
        }

[Serializable]
        public class JoinGroupResultContract
        {
            public JoinGroupResultContract(){}
            public JoinGroupResultContract(bool _succeed)
            {
                this.succeed = _succeed;
            }

#region Succeed
            private bool succeed = true;
            /// <summary>
            /// 加入组是否成功
            /// </summary>
            public bool Succeed
            {
                get { return succeed; }
                set { succeed = value; }
            } 
            #endregion
        }

  当然,这里的协议类非常简单,而对于我们实际的应用,协议类中封装很多的信息都是可以的。

二.客户端向服务器发送请求

  好了,客户端在引擎初始化成功之后,就可以向服务器发送加入组G001的请求了:

//向服务器请求 加入G100组
   JoinGroupContract JoinGroupContract = new JoinGroupContract("G100", "123456");
   rapidPassiveEngine.CustomizeInfoOutter.Send(InformationTypes.JoinGroup, ESBasic.Helpers.SerializeHelper.SerializeObject(JoinGroupContract));

三.服务器处理请求,并发送回复给客户端

  服务端通过实现ESPlus.Application.CustomizeInfo.Server.ICustomizeInfoBusinessHandler接口的HandleInformation方法来处理该请求:

private ICustomizeInfoController customizeInfoController = ......;

//服务端处理消息
        public void HandleInformation(string sourceUserID, int informationType, byte[] info)
        {
            if(informationType == InformationTypes.JoinGroup)
            {
                JoinGroupContract joinGroupContract = (JoinGroupContract)ESBasic.Helpers.SerializeHelper.DeserializeBytes(info, 0, info.Length);
                string groupID = joinGroupContract.GroupID;  
              
                // ........ (逻辑处理)

JoinGroupResultContract resContract = new JoinGroupResultContract(true) ;//同意加入
                //向用户发送回复消息
                this.customizeInfoController.Send(sourceUserID, InformationTypes.JoinGroupResult, SerializeHelper.SerializeObject(resContract));
                return;
            }
        }

  

四.客户端处理服务器的回复

  接下来,客户端也可以通过实现ESPlus.Application.CustomizeInfo.Passive.ICustomizeInfoBusinessHandler接口的HandleInformationFromServer方法来处理服务器的回复:

//客户端处理消息
        public void HandleInformationFromServer(int informationType, byte[] info)
        {
            if (informationType == InformationTypes.JoinGroupResult)
            {
                JoinGroupResultContract resContract = (JoinGroupResultContract)SerializeHelper.DeserializeBytes(info, 0, info.Length);
                if (resContract.Succeed)
                {
                    //...... 加入成功了,呵呵
                }
                return;
            }
        }

  这个demo简单地演示了消息类型的定义、协议类的定义、以及客户端向服务器发送请求、服务器处理请求并回复客户端的一个完整的处理流程。通过自定义消息,我们可以在服务端与客户端之间实现非常复杂的协作。所以,哪怕是使用ESFramework的快速引擎,我们也可以做很多很复杂的事情了。

有一点要特别注意,那就是尽可能使消息的尺寸小,在相同的频率下,消息越小,通信的效率越高。在本文的demo中,我们采用的是.NET自带的二进制序列化器将协议对象转化为byte[],而使用这个序列化器,所得到的byte[]通常都非常大,而消息越大,将使得服务端与客户端通信的负担增大。所以,如果有自己更好更简洁的序列化方式,建议不要采用.NET自带的二进制序列化器。

时间: 2024-11-10 12:52:36

如何使用自定义消息?--ESFramework 4.0 快速上手(04)的相关文章

ESFramework 4.0 快速上手(06) -- Rapid引擎(续)

<ESFramework 4.0 快速上手>系列介绍的都是如何使用Rapid引擎(快速引擎) -- RapidServerEngine 和 RapidPassiveEngine.其实,大家可以将这两个引擎看作是两个壳,内部包装的才是真正的ESFramework的网络引擎, ESFramework支持很多种网络引擎(客户端/服务端.二进制协议/文本协议.TCP/UDP),而RapidServerEngine和RapidPassiveEngine采用的是基于TCP和二进制协议的服务端引擎和客户端引

离线消息如何实现?-- ESFramework 4.0 快速上手(02)

在ESFramework 4.0 快速上手一文中,主要介绍了如何使用ESPlus.Rapid命名空间中的引擎来快速地构建基于TCP的网络通信系统,即使是使用ESPlus.Rapid来进行ESFramework快速开发,也还有很多可以介绍的内容,于是,我想再多写几篇文章来说明现实通信系统中的一些常见需求如何使用ESFramework快速实现.本文是为第一篇,介绍离线消息的原理和实现. 一.如何截获离线消息 阅读了ESFramework 4.0 快速上手朋友都知道,一个在线用户给另一个用户发送文本信

ESFramework 4.0 快速上手(01) -- Rapid引擎

(在阅读该文之前,请先阅读 ESFramework 4.0 概述 ,会对本文的理解更有帮助.) ESFramework/ESPlatform 4.0 的终极目标是为百万级的用户同时在线提供支持,因为强大,所以使用也较为复杂,配置也较多.但是如果我们的应用只是一个中小型的通信应用(同时在线5000人以下),直接使用ESPlatform就有点显得杀鸡用牛刀了.ESPlus.Rapid提供了一种快速的方式,来解决类似中小型的通信应用,以最简洁的方式来使用ESFramework. 使用ESPlus.Ra

重登陆模式 --ESFramework 4.0 快速上手(07)

在ESFramework框架中基于TCP的服务端引擎(当然也包括Rapid引擎)都采用了这样一条规则:默认情况下,客户端与服务器成功建立TCP连接以后,服务端会从客户端发过来的第一条消息中取出消息头的UserID属性的值,并将其与对应的TCP连接绑定起来.这样,服务端就知道每一个TCP连接所对应的用户UserID,而当我们要求服务端向某个客户端发送消息时,服务端就知道通过哪个TCP连接进行发送了.TCP连接与UserID是一一对应的,一个TCP连接只能对应一个UserID,同样的,一个UserI

判定生死的心跳机制 --ESFramework 4.0 快速上手(07)

在Internet上采用TCP进行通信的系统,都会遇到一个令人头疼的问题,就是"掉线".而"TCP掉线"这个问题远比我们通常所能想象的要复杂的多 -- 网络拓扑纷繁复杂.而从始节点A到终节点B之间可能要经过N多的交换机.路由器.防火墙等等硬件设备,每个硬件设备的相关设定也不统一,再加上网络中可能出现的拥塞.延迟等,使得我们在编程时,处理掉线也非常棘手. 一.从程序的角度看待TCP掉线 TCP掉线的原因可能多种多样.不一而足,比如,客人的电脑突然断电.OS崩溃.路由器

AutoMapper 9.0快速上手,从老版本迁移到9.0+AutoMapper9.0和Autofac的完美结合

.NET模型映射器AutoMapper 9.0发布了,官方宣称不再支持静态方法调用了,老版本的部分API将在升级到9.0后,直接升级包到9.0会编译报错,所以写篇文章记录下AutoMapper新版本的学习过程吧,如果还不知道AutoMapper是什么的,建议先看这篇文章:https://masuit.com/156,或者参考官方文档:https://automapper.readthedocs.io/en/latest/Getting-started.html AutoMapper9.0快速上手

核心梳理——消息处理的骨架流程——ESFramework 4.0 进阶(02)

在ESFramework 4.0 概述一文中,我们提到ESFramework.dll作为通信框架的核心,定义了消息处理的骨架流程,本文我们来详细剖析这个流程以及该骨架中所涉及的各个组件.ESFramework的骨架流程如下图所示: 一.所有的网络引擎都使用同一消息处理骨架流程 ESFramework支持TCP/UDP.二进制协议/文本协议.服务端/客户端组合而成的2x2x2=8种引擎,无论是哪一种引擎,都实现了INetEngine接口,也都使用上图所示的消息处理骨架流程来处理所接收到的所有消息.

EntityFramework 5.0 CodeFirst 教程01-搭建环境和快速上手

----------------------------目录------------------------------ EntityFramework 5.0 CodeFirst 教程01-搭建环境和快速上手 ----------------------------目录------------------------------ 网上关于EntityFramework 5.0的教程很多,但是大多数都是代码整理不清晰,有些甚至是拷贝,代码丢失等问题,本人最近也有一个项目是用到EntityFram

《Python编程快速上手 让繁琐工作自动化》pdf

<div id="article_content" class="article_content tracking-ad" data-mod="popu_307" data-dsm="post"> <p><br></p><p>下载地址:<a target="_blank" href="https://page74.ctfile.co