AgileEAS.NET SOA 中间件平台.Net Socket通信框架-介绍

一、前言

     AgileEAS.NET SOA 中间件平台是一款基于基于敏捷并行开发思想和Microsoft .Net构件(组件)开发技术而构建的一个快速开发应用平台。用于帮助中小型软件企业建立一条适合市场快速变化的开发团队，以达到节省开发成本、缩短开发时间，快速适应市场变化的目的。

     AgileEAS.NET SOA中间件平台提供了敏捷快速开发软件工程的最佳实践，通过提供大量的基础支撑功能如IOC、ORM、SOA、分布式体系及敏捷并发开发方法所支撑的插件开发体系，以及提供了大量的实体、数据模型设计生成工具、代码生成工具，用于帮助中小软件开发商快速成长。

     AgileEAS.NET平台充分把握目前软件行业快速发展的新趋势，基于敏捷并行开发、快速适应市场这样淳朴的软件工程实践，采用业界广泛使用的Microsoft .Net构件(组件)开发技术实践了这种开发思想，帮助软件企业实现“敏捷变化、快速适合”的目标，从而帮助软件企业在激烈的市场竞争中赢得先机并获得更高的回报。

二、关于Socket/Tcp框架的需求

     在AgileEAS.NET SOA 中间件平台在大量客户的使用过程之中，有的客户提出了一些基于“消息推”、和应用系统事件通知的需求，比如在“医院信息系统”、“电子病历系统‘、”区域公共卫生平台“、等系统之中就提供了这样的需求，比如当大夫为病人开立了医嘱之后、需要在相关护理人员即时提示，之前大家都使用数据库刷新，数据库的压力都比较大，所以迫切的提出了这样的需求。

     另外一个原因是AgileEAS.NET SOA 中间件平台之前一直使用WCF、WS、Romotinig通信做为SOA分布式架构的通信基础，我们在考虑WS、WCF的某些协议并不能提供给我们非常高效的通信，所以我们也需要有一套直接基于Socket/TCP的通信体系用于支撑我们的SOA分布式服务业务体系。

三、AgileEAS.NET SOA 中间件Socket/Tcp框架结构

     AgileEAS.NET SOA中间件需要的Socket/Tcp框架严格意思是需要的基于Socket的通信消息中件间，其所提供的功能本质是对消息的处理，所以其所提供的API有三大类、Socket框架本身、消息框架及消息处理框架，以下是AgileEAS.NET SOA中间件的Socket/Tcp的应用框架结构：

     各上图我们可以看到AgileEAS.NET SOA中间件需要的Socket/Tcp框架实现了这么一件有意思的事，把原生的Socekt基于数据流的流式通信模式转换为基于消息的消息通信模式，让开发人员多复杂的系统Socket通信和数据流处理之中解放出来，转而关心高层通信消息的设计和消息处理的业务设计与实现。

三、AgileEAS.NET SOA 中间件Socket/Tcp框架重要的接口和类

     AgileEAS.NET SOA中间件需要的Socket/Tcp框架严格意思是需要的基于Socket的通信消息中件间，其所提供的功能本质是对消息的处理，所以其所提供的API有三大类、Socket框架本身、消息框架及消息处理框架，以下是AgileEAS.NET SOA中间件的Socket/Tcp的应用框架结构：

     其中ISocketCient接口为客户段功能封装，其定义大体如下：

/// <summary>
/// Tcp客户端接口。
/// </summary>
public interface ISocketClient : ISocketEngine
{
    /// <summary>
    /// 客户端状态。
    /// </summary>
    ClientState ClientState
    {
        get;
    }

    /// <summary>
    /// 连接Tcp服务器。
    /// </summary>
    bool Connect();

    /// <summary>
    /// 关闭与服务器的连接。
    /// </summary>
    void Close();

    /// <summary>
    /// 发送消息。
    /// </summary>
    /// <param name="message">消息。</param>
    void Send(IMessage message);

    /// <summary>
    /// 调用消息，用于服务器/客户端应用中的请示==》响应消息的应用。
    /// </summary>
    /// <param name="request">请示消息。</param>
    /// <returns>服务器返回的响应消息。</returns>
    IMessage Invoke(IMessage request);

    /// <summary>
    /// 异步调用消息，用于服务器/客户端应用中的请示==》响应消息的应用。
    /// </summary>
    /// <param name="request">请示消息。</param>
    /// <returns>包含响应消息的异步任务。</returns>
    NetInvokeTask BeginInvoke(IMessage request);

    /// <summary>
    /// 服务器发生错误时触发。
    /// </summary>
    event ErrorEventHandler Error;

    /// <summary>
    /// 连接服务器后触发。
    /// </summary>
    event EventHandler Connected;

    /// <summary>
    /// 断开服务器连接后触发。
    /// </summary>
    event EventHandler Closed;
}

     其是最重要方法为void Send(IMessage message)方法，即发送一个消息到服务器，这个方法也是对使用者开放的最重要方法，在这里发送的不是字节流，而是一个实现了IMessage接口的消息对象，当服户段接收到IMessage对象之后会调用与其对应的消息处理器(IMessageHandler)对象进行消息处理，反之客户段收到IMessage也会调用与其相关的消息处理器(IMessageHandler)对象进行处理。

     ISocketServer、ISocketServerBase接口：

/// <summary>
/// Socket服务器基类接口。
/// </summary>
public interface ISocketServerBase : ISocketEngine
{
    /// <summary>
    /// 客户端会话集合。
    /// </summary>
    IList<NetSession> Sessions
    {
        get;
    }

    /// <summary>
    /// 注册了一个新会话后发生。
    /// </summary>
    event NetSessionEventHandler SessionStarted;

    /// <summary>
    /// 某一个会话结束后发生。
    /// </summary>
    event NetSessionEventHandler SessionAbandoned;

    /// <summary>
    /// 发送消息。
    /// </summary>
    /// <param name="target">消息接收方ID(会话ID)。</param>
    /// <param name="message">消息。</param>
    void Send(Guid target, IMessage message);

    /// <summary>
    /// 发送网络消息。
    /// </summary>
    /// <param name="target">消息接收方ID(会话ID)。</param>
    /// <param name="netMessage">网络消息。</param>
    void Send(Guid target, NetMessage netMessage);

    /// <summary>
    /// 发送网络报文(仅网关模式有效)。
    /// </summary>
    /// <param name="target">消息接收方ID(会话ID)。</param>
    /// <param name="netPacket">网络报文。</param>
    void Send(Guid target, NetPacket netPacket);

    /// <summary>
    /// 发送网络数据(仅网关模式有效)。
    /// </summary>
    /// <param name="target">消息接收方ID(会话ID)。</param>
    /// <param name="buffer">网络数据。</param>
    void Send(Guid target, byte[] buffer);
}

/// <summary>
/// Socket服务器接口。
/// </summary>
public interface ISocketServer :  ISocketServerBase
{
    /// <summary>
    /// 客户端连接数。
    /// </summary>
    int ClientCount
    {
        get;
    }

    /// <summary>
    /// 服务器状态。
    /// </summary>
    ServerState ServerState
    {
        get;
    }

    /// <summary>
    /// 开始Tcp服务器。
    /// </summary>
    void StartServer();

    /// <summary>
    /// 停止Tcp服务器。
    /// </summary>
    void StopServer();

    /// <summary>
    /// 关闭指定客户的连接。
    /// </summary>
    /// <param name="client">客户Guid。</param>
    void AbandonSession(System.Guid client);

    /// <summary>
    /// 服务器发生错误时触发。
    /// </summary>
    event ServerErrorEventHandler ServerError;

    /// <summary>
    /// 服务器启动后触发。
    /// </summary>
    event System.EventHandler ServerStarted;

    /// <summary>
    /// 服务器停止后触发。
    /// </summary>
    event System.EventHandler ServerStopped;
}

     这两个接口定义了SocketServer的一些行为和属性，其中最重要的方法还是void Send(Guid target, IMessage message)，实现向某个特定客户段连接发送应用消息，别外定义了一个IList<NetSession> Sessions属性，表示目前连接到此SocketServer的所有客户端会话信息。

     NetSession表示服务器的一个客户段连接会话，包括连接上下文信息和连接的Socket通信对象，当某个SocketClient发送给SocketServer的信息都会被与其应对的NetSession进行处理，NetSession定义两个重要的方法public void Reply(uint requestID, IMessage message)和public void Abandon()，其中Reply表示向客户端回复一个消息，Abandon表示服务器强制中止此会话。

     在整个Socket/tcp框架之中进行通信的最基本单元都是IMessage，那么SocketClient、SocketServer接收到IMessage如何处理呢，答案是由与之配对的IMessageHandler进行处理，所以SocketClient、SocketServer都实现了一个基础接口ISocketEngine:

/// <summary>
/// Socket引擎，Socket网络通信基础类。
/// </summary>
public interface ISocketEngine : IDisposable
{
    /// <summary>
    /// 通信引擎的全局唯一标识符号。
    /// </summary>
    System.Guid Guid
    {
        get;
    }

    /// <summary>
    /// IP地址和端口号。
    /// </summary>
    IPEndPoint IPEndPoint
    {
        get;
        set;
    }

    /// <summary>
    /// IP地址。
    /// </summary>
    string IPAddress
    {
        get;
        set;
    }

    /// <summary>
    /// 端口号。
    /// </summary>
    int Port
    {
        get;
        set;
    }

    /// <summary>
    /// 报文最大长度。
    /// </summary>
    int MessageMaxSize
    {
        get;
    }

    /// <summary>
    /// 注册消息处理器。
    /// </summary>
    /// <typeparam name="T">消息类型。</typeparam>
    /// <param name="hander">消息处理器。</param>
    void AddHander<T>(IMessageHandler<T> hander) where T : IMessage;

    /// <summary>
    /// 通过Socket发送数据之后触发。
    /// </summary>
    event SocketDataHandler SocketDataSend;

    /// <summary>
    ///  通过Socket接收数据之后触发。
    /// </summary>
    event SocketDataHandler SocketDataReceived;

    /// <summary>
    /// 发送报文完成之后触发。
    /// </summary>
    event PacketHandler PacketSend;

    /// <summary>
    /// 报文接收完成之后触发。
    /// </summary>
    event PacketHandler PacketReceived;

    /// <summary>
    /// 载送完一个NetMessage之后触发。
    /// </summary>
    event NetMessageHandler NetMessageSend;

    /// <summary>
    /// 接收完一个NetMessage之后触发。
    /// </summary>
    event NetMessageHandler NetMessageReceived;

    /// <summary>
    /// 消息发送完成之后触发。
    /// </summary>
    event MessageHandler MessageSend;

    /// <summary>
    /// 接收消息完成之后触发。
    /// </summary>
    event MessageHandler MessageReceived;
}

     其中方法void AddHander<T>(IMessageHandler<T> hander) where T : IMessage实现对消息处理器的注册，以便收到IMessage之后选择合适的处理器进行处理。

四、消息和消息处理器

     从以上的介绍我们可以明确的知道AgileEAS.NET SOA中间件Socket/Tcp框架是的一个基于消息对象的消息通信框架，那么其最核心的业务就是定义消息及消息的处理思路，我们称之为消息及消息处理器结构：

     其中IMessage接口为Socket/Tcp框架中最重要的接口，所有高层的应用消息都需要实现本接口：

/// <summary>
/// 消息接口定义。
/// </summary>
/// <remarks>
/// 这里所说的消息是指业务处理的最小单元，而不是传输于网络之间的网络消息。
/// </remarks>
public interface IMessage
{
    /// <summary>
    /// 从指定的 MessageReader加载消息对象。
    /// </summary>
    /// <param name="reader">消息读取器。</param>
    void Load(BufferReader reader);

    /// <summary>
    /// 将消息对象保存到指定的MessageWriter。
    /// </summary>
    /// <param name="writer">消息编写器。</param>
    void WriteTo(BufferWriter writer);
}

     其中Load和WriteTo实现IMessage消息对象实例与字节流之间进行相互转换，Load消息用于从字节流之中读取并实例化消息、WriteTo把消息转换为流写入消息流之中，在应用开发过程之中必须实现这两个方法并且在消息类上打上MessageAttribute标记：

/// <summary>
/// 消息ID属性。
/// </summary>
/// <remarks>
/// 标记网络消息，确定其唯一的ID。
/// </remarks>
[AttributeUsage(AttributeTargets.Class)]
public class MessageAttribute : Attribute
{
    /// <summary>
    /// 初始化MessageAttribute对象实例。
    /// </summary>
    /// <param name="messageID">消息ID。</param>
    public MessageAttribute(string messageID)
        :this(messageID,string.Empty)
    {

    }

    /// <summary>
    /// 初始化MessageAttribute对象实例。
    /// </summary>
    /// <param name="messageID">消息ID。</param>
    /// <param name="description">消息说明。</param>
    public MessageAttribute(string messageID, string description)
    {
        this.MessageID = new Guid(messageID);
        this.Description = description;
    }

    /// <summary>
    /// 消息ID。
    /// </summary>
    public Guid MessageID
    {
        get;
        set;
    }

    /// <summary>
    /// 消息说明。
    /// </summary>
    public string Description
    {
        get;
        set;
    }
}

     MessageAttribute标记用于向已实现IMessage接口的具体消息的消息ID与消息说明，即向Socket通信框架声音本消息的唯一性之用，其中MessageID为一个GUID对象，GUID对象理论上是唯一的，我们可以表示消息的唯一性，以下是一个具体的消息例子:

/// <summary>
/// 用户登录消息。
/// </summary>
[Message("F42433DF-2D4D-4514-9523-2FE911E63CAA", "登录消息")]
[Serializable]
public class LoginMessage : IMessage
{
    /// <summary>
    /// 用户名。
    /// </summary>
    public string LoginID
    {
        get;
        set;
    }

    /// <summary>
    /// 密码。
    /// </summary>
    public string PassWord
    {
        get;
        set;
    }

    #region IMessage 成员

    /// <summary>
    ///
    /// </summary>
    /// <param name="reader"></param>
    public void Load(EAS.IO.BufferReader reader)
    {
        LoginID = reader.ReadString();
        PassWord = reader.ReadString();
    }

    /// <summary>
    ///
    /// </summary>
    /// <param name="writer"></param>
    public void WriteTo(EAS.IO.BufferWriter writer)
    {
        writer.Write(LoginID);
        writer.Write(PassWord);
    }

    #endregion
}

     以上是一个具体消息的例子，其表明消息ID为“F42433DF-2D4D-4514-9523-2FE911E63CAA”，其作用是登录消息，用于实现类似登录业务。

五、可靠的消息中间件

     AgileEAS.NET SOA中间件Socket/Tcp框架是一个可靠的消息中间件，在设计过程之初就选择了完成端口模型进行开发，以保证服务的高并发和吞吐量，在底层消息通信上，我们选择了不超过8K的可变大小通信报文，比如当一个高层的IMeesage只有512字节内容的时候，会取转成一个一个远小于8K的报文进行发送，如果一个高层IMeesage为66K时，会被分解成为9条消息报文进行通信，前8条消息报文长度为8K，最后一条不满足8K，接收文收到这9条报文后组合并转换为IMeesage对象之后交由消息处理器IMeeesgaHandler进行处理。

     在进行消息报文收发过程之中，经过长期测试、验证、设计和选择了高性能的防粘包设计，避免应用开发者头疼的消息粘包问题。

六、AgileEAS.NET SOA中间件需要的Socket/Tcp框架下载

     AgileEAS.NET SOA中间件Socket/Tcp框架包含在AgileEAS.NET SOA中间件平台之中，具体定义在EAS.MicroKernel.dll程序集之中，要使用AgileEAS.NET SOA中间件Socket/Tcp框架进行基于Socket的通信开发，请通过AgilleEAS.NET SOA 中站件平台官方网站的最新下载页面下载。

七、联系我们

     为了完善、改进和推广AgileEAS.NET而成立了敏捷软件工程实验室，是一家研究、推广和发展新技术，并致力于提供具有自主知识产权的业务基础平台软件，以及基于业务基础平台了开发的管理软件的专业软件提供商。主要业务是为客户提供软件企业研发管理解决方案、企业管理软件开发，以及相关的技术支持，管理及技术咨询与培训业务。

     AgileEAS.NET平台自2004年秋呱呱落地一来，我就一直在逐步完善和改进，也被应用于保险、医疗、电子商务、房地产、铁路、教育等多个应用，但一直都是以我个人在推广，2010年因为我辞职休息，我就想到把AgileEAS.NET推向市场，让更多的人使用。

     我的技术团队成员都是合作多年的老朋友，因为这个平台是免费的，所以也没有什么收入，都是由程序员的那种理想与信念坚持，在此我感谢一起奋斗的朋友。

团队网站：http://www.agilelab.cn

AgileEAS.NET网站：http://www.agileeas.net

官方博客:http://eastjade.cnblogs.com

github:https://github.com/agilelab/eas

QQ:47920381

AgileEAS.NET QQ群：

113723486（AgileEAS SOA 平台）/上限1000人

199463175（AgileEAS SOA 交流）/上限1000人

120661978（AgileEAS.NET 平台交流）/上限1000人

212867943（AgileEAS.NET研究）/上限500人

147168308（AgileEAS.NET应用）/上限500人

172060626（深度AgileEAS.NET平台）/上限500人

116773358（AgileEAS.NET 平台）/上限500人

125643764（AgileEAS.NET探讨）/上限500人

193486983（AgileEAS.NET 平台）/上限500人

邮件:james@agilelab.cn,mail.james@qq.com,

电话：18629261335。