README.md

    图片名称

    合抱之木,生于毫末;九层之台,起于垒土。

    🎀描述

    以下Nuget包,均已在此仓使用Apache License 2.0开源协议开源。

    名称 地址 描述
    NuGet version (RRQMSocket) Gitee
    Github
    RRQMSocket是一个高性能的、超轻量级的网络通信框架。
    包含了TCP、UDP、Ssl等一系列的通信模块。
    NuGet version (RRQMCore) Gitee
    Github
    RRQMCore是为RRQM系提供基础服务功能的库,其中包含:
    内存池对象池等待逻辑池AppMessenger3DES加密
    Xml快速存储运行时间测量器文件快捷操作
    高性能序列化器规范日志接口等。

    🎫企业版描述

    以下Nuget包,并未开源,其源代码需要付费购买。但是其Nuget包可以免费商用。

    名称 地址 描述
    NuGet version Gitee
    Github
    RRQMSocketFramework是RRQMSocket系列的增强企业版。
    也是合集版本。这意味着您只需要安装RRQMSocketFramework,
    即可使用所有组件功能,但是RRQMSocketFramework中也包含了
    未开源的企业版功能,这需要密钥才能使用,当然也可以试用。
    所以两者在基础功能没有区别,只是在扩展功能上有一定差异性。
    具体差异请看企业版相关

    🖥支持环境

    • .NET Framework4.5及以上。
    • .NET Core3.1及以上。
    • .NET Standard2.0及以上。

    🥪支持框架

    • WPF
    • Winform
    • Blazor
    • Xamarin
    • Mono
    • Unity(在IL2cpp编译时,需要导入源码或添加link.xml,亦或者直接安装RRQMSocketFramework,Mono则直接加载dll即可)
    • 其他(即所有C#系)

    unity内link.xml设置(放置在Assets文件夹内)

    unity官方文档 托管代码剥离

    <linker>
    	<assembly fullname="RRQMCore" />
    	<assembly fullname="RRQMSocket" />
    </linker>

    🌴RRQMSocket特点速览

    传统IOCP和RRQMSocket

    RRQMSocket的IOCP和传统也不一样,就以微软官方示例为例,使用MemoryBuffer开辟一块内存,均分,然后给每个会话分配一个区接收,等收到数据后,再复制源数据,然后把复制的数据进行处理。而RRQMSocket是每次接收之前,从内存池拿一个可用内存块,然后直接用于接收,等收到数据以后,直接就把这个内存块抛出处理,这样就避免了复制操作,虽然只是细小的设计,但是在传输1000w64kb的数据时,性能相差了10倍

    数据处理适配器

    相信大家都使用过其他的Socket产品,那么RRQMSocket在设计时也是借鉴了其他产品的优秀设计理念,数据处理适配器就是其中之一,但和其他产品的设计不同的是,RRQMSocket的适配器功能更加强大,它不仅可以提前解析数据包,还可以解析数据对象。例如:可以使用固定包头对数据进行预处理,从而解决数据分包粘包的问题。也可以直接解析HTTP数据协议、WebSocket数据协议等。

    兼容性与适配

    RRQMSocket提供多种框架模型,能够完全兼容基于TCP、UDP协议的所有协议。例如:TcpService与TcpClient,其基础功能和Socket一模一样,只是增强了框架的坚固性并发性,将连接接收数据通过事件的形式抛出,让使用者能够更加友好的使用。

    🔗联系作者

    🌟说明文档

    简单示例

    以下仅以最简方式创建示例,更多详情请查看说明文档

    【TcpService】

    TcpService service = new TcpService();
    service.Connecting += (client, e) => { };//有客户端正在连接
    service.Connected += (client, e) => { };//有客户端连接
    service.Disconnected += (client, e) => { };//有客户端断开连接
    service.Received += (client, byteBlock, requestInfo) =>
    {
        //从客户端收到信息
        string mes = byteBlock.ToString();
        Console.WriteLine($"已从{client.ID}接收到信息:{mes}");
    
        client.Send(mes);//将收到的信息直接返回给发送方
    
        //client.Send("id",mes);//将收到的信息返回给特定ID的客户端
    
        var clients = service.GetClients();
        foreach (var targetClient in clients)//将收到的信息返回给在线的所有客户端。
        {
            if (targetClient.ID != client.ID)
            {
                targetClient.Send(mes);
            }
        }
    };
    
    service.Setup(new RRQMConfig()//载入配置     
        .SetListenIPHosts(new IPHost[] { new IPHost("127.0.0.1:7789"), new IPHost(7790) })//同时监听两个地址
        .SetMaxCount(10000)
        .SetThreadCount(100))
        .Start();//启动

    【TcpClient】

    TcpClient tcpClient = new TcpClient();
    tcpClient.Connected += (client, e) => { };//成功连接到服务器
    tcpClient.Disconnected += (client, e) => { };//从服务器断开连接,当连接不成功时不会触发。
    tcpClient.Received += (client, byteBlock, requestInfo) =>
    {
        //从服务器收到信息
        string mes = Encoding.UTF8.GetString(byteBlock.Buffer, 0, byteBlock.Len);
        Console.WriteLine($"接收到信息:{mes}");
    };
    
    //声明配置
    RRQMConfig config = new RRQMConfig();
    config.SetRemoteIPHost(new IPHost("127.0.0.1:7789"))
        .UsePlugin()
        .SetBufferLength(1024 * 10);
    
    //载入配置
    tcpClient.Setup(config);
    tcpClient.Connect();
    tcpClient.Send("RRQM");

    【TcpClient 断线重连】

    tcpClient.UseReconnection(tryCount:5,printLog:true);

    【FixedHeaderPackageAdapter包模式】

    该适配器主要解决TCP粘分包问题,数据格式采用简单而高效的“包头+数据体”的模式,其中包头支持:

    • Byte模式(1+n),一次性最大接收255字节的数据。
    • Ushort模式(2+n),一次最大接收65535字节。
    • Int模式(4+n),一次最大接收2G数据。

    以上数据头均采用RRQMBitConverter的默认端模式(小端模式),使用者可以根据需求切换默认端模式。

    RRQMBitConverter.DefaultEndianType = EndianType.Little;

    【CustomFixedHeaderDataHandlingAdapter】

    用户自定义固定包头适配器,主要帮助用户解决具有固定包头的数据帧信息。例如:下列数据格式,仅需要实现几个接口,就能完成解析,详细操作请参照API。

    |1|1|1|**********|

    【CustomUnfixedHeaderDataHandlingAdapter】

    用户自定义不固定包头适配器,主要帮助用户解决具有包头不固定的数据帧信息。例如:最典型的HTTP数据包,其数据头和数据体由“\r\n”隔开,而数据头又因为请求者的请求信息的不同,头部数据也不固定,而数据体的长度,也是由数据头的ContentLength的值显式指定的,所以可以考虑使用CustomUnfixedHeaderDataHandlingAdapter解析,也是仅通过简单的开发,就能实现。

    【Ssl加密】

    RRQMBox中,放置了一个自制Ssl证书,密码为“RRQMSocket”以供测试。使用配置非常方便。

    在服务器中只需设置配置SslOption属性和接收模式。

    服务器配置

    config.SetServerSslOption(new ServiceSslOption() { Certificate = new X509Certificate2("RRQMSocket.pfx", "RRQMSocket"), SslProtocols = SslProtocols.Tls12 });

    客户端配置

    config.SetClientSslOption(new ClientSslOption()
    {
        ClientCertificates = new X509CertificateCollection() { new X509Certificate2("RRQMSocket.pfx", "RRQMSocket") },
        SslProtocols = SslProtocols.Tls12,
        TargetHost = "127.0.0.1",
        CertificateValidationCallback = (sender, certificate, chain, sslPolicyErrors) => { return true; }
    });

    🧲应用场景模拟

    场景入口


    致谢

    谢谢大家对RRQM的支持,如果还有其他问题,请加群QQ:234762506讨论。

    支持作者

    支持入口

    项目简介

    当前项目暂无项目简介

    发行版本

    当前项目没有发行版本

    贡献者 23

    全部贡献者

    开发语言

    • C# 100.0 %
    • PowerShell 0.0 %