# RRQMSocket
**Repository Path**: MuNet/RRQMSocket
## Basic Information
- **Project Name**: RRQMSocket
- **Description**: RRQMSocket是一个整合性网络通信框架，特点是支持高并发、事件驱动、易用性强、二次开发难度低等。其中主要内容包括:TCP服务通信框架、文件传输、RPC等内容
- **Primary Language**: C#
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: https://gitee.com/RRQM_Home
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 816
- **Created**: 2021-05-18
- **Last Updated**: 2021-05-18
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
[](https://www.nuget.org/packages/RRQMSocket/)
[](https://www.apache.org/licenses/LICENSE-2.0.html)
[](https://www.nuget.org/packages/RRQMSocket/)
[](https://gitee.com/dotnetchina/RRQMSocket/stargazers)
[](https://gitee.com/dotnetchina/RRQMSocket/members)
合抱之木，生于毫末；九层之台，起于垒土。
**简体中文 | [English](./README.md)**
## 💿描述
|名称|版本（Nuget Version）|下载（Nuget Download）|描述|
|:---:|---|---|---|
|RRQMSocket| [](https://www.nuget.org/packages/RRQMSocket/) | [](https://www.nuget.org/packages/RRQMSocket/) | **RRQMSocket**是一个整合性的、超轻量级的网络通信服务框架。它具有 **高并发连接** 、 **高并发处理** 、 **事件订阅** 、 **插件式扩展** 、 **多线程处理** 、 **内存池** 、 **对象池** 等特点，让使用者能够更加简单的、快速的搭建网络框架。|
| RRQMSocket.FileTransfer | [](https://www.nuget.org/packages/RRQMSocket.FileTransfer/) | [](https://www.nuget.org/packages/RRQMSocket.FileTransfer/) | RRQMSocket.FileTransfer是一个高性能的文件传输框架，您可以用它传输**任意大小**的文件，它可以完美支持**上传下载混合式队列传输**、**断点续传**、 **快速上传** 、**传输限速**、**获取文件信息**、**删除文件**等。在实时测试中，它的传输速率可达500Mb/s。 |
|RRQMSocket.RPC | [](https://www.nuget.org/packages/RRQMSocket.RPC/) | [](https://www.nuget.org/packages/RRQMSocket.RPC/) | RRQMSocket.RPC是一个超轻量、高性能、可扩展的微服务框架，目前已完成开发RRQMRPC部分，该部分使用RRQM专属协议，支持客户端异步调用，服务端异步触发、以及out和ref关键字，函数回调等。在调用效率上也是非常强悍，在调用空载函数，且返回状态时，10w次调用仅用时3.8秒，不返回状态用时0.9s。其他扩展调用扩展协议目前已开发WebApi，后续还会支持JsonRPC，XmlRPC等。|
|RRQMSocket.RPC.WebApi | [](https://www.nuget.org/packages/RRQMSocket.RPC.WebApi/)| [](https://www.nuget.org/packages/RRQMSocket.RPC.WebApi/) | RRQMSocket.RPC.WebApi是一个扩展于RRQMSocket.RPC的WebApi组件，可以通过该组件创建WebApi服务解析器，让桌面端、Web端、移动端可以跨语言调用RPC函数。功能支持路由、Get传参、Post传参等。|
|RRQMSocket.RPC.XmlRpc | [](https://www.nuget.org/packages/RRQMSocket.RPC.XmlRpc/)| [](https://www.nuget.org/packages/RRQMSocket.RPC.XmlRpc/) | RRQMSocket.RPC.XmlRpc是一个扩展于RRQMSocket.RPC的XmlRpc组件，可以通过该组件创建XmlRpc服务解析器，完美支持XmlRpc数据类型，类型嵌套，Array等，也能与CookComputing.XmlRpcV2完美对接。不限Web，Android等平台。|
| RRQMSocket.Http | [](https://www.nuget.org/packages/RRQMSocket.Http/) | [](https://www.nuget.org/packages/RRQMSocket.Http/) | RRQMSocket.Http是一个能够简单解析Http的服务组件，能够快速响应Http服务请求。|
## 🖥支持环境
- .NET Framework4.5及以上。
- .NET Core3.1及以上。
- .NET Standard2.0及以上。
## 🥪支持框架
- WPF
- Winform
- Blazor
- Xamarin
- Mono
- Unity
- 其他（即所有C#系）
## 🌴RRQMSocket特点速览
#### 1.对象池
对象池在RRQMSocket有很多应用，最主要的两个就是**连接对象池**和**处理对象池**。连接对象池就是当客户端成功连接时，首先会去连接对象池中找TcpSocketClient，然后没有的话，才会创建。如果哪个客户端掉线了，它的TcpSocketClient就会被回收。这也就是**ID重用**的原因。
然后就是处理对象池，在RRQMSocket中，接收数据的线程和IOCP内核线程是分开的，也就是比如说客户端给服务器发送了1w条数据，但是服务器收到后处理起来很慢，那传统的iocp肯定会放慢接收速率，然后通知客户端的tcp窗口，发生拥塞，然后让客户端暂缓发送。但是在RRQMSocket中会把收到的数据通过队列全都存起来，首先不影响iocp的接收，同时再分配线程去处理收到的报文信息，这样就相当于一个“泄洪湖泊”，能很大程度的提高处理数据的能力。
#### 2.多线程
由于有**处理对象池**的存在，使多线程处理变得简单。在客户端连接完成时，会自动分配该客户端辅助类（TcpSocketClient）的消息处理逻辑线程，假如服务器线程数量为10，则第一个连接的客户端会被分配到0号线程中，第二个连接将被分配到1号线程中，以此类推，循环分配。当某个客户端收到数据时，会将数据排入当前线程所独自拥有的队列当中，并唤醒线程执行。
#### 3.传统IOCP和RRQMSocket
RRQMSocket的IOCP和传统也不一样的，就以微软官方为例，它是开辟了一块内存，然后均分，然后给每个会话分配一个区去接收，等收到数据以后，再复制一份，然后把数据抛出去，让外界处理。而RRQMSocket是每次接收之前，从内存池拿一个可用内存块，然后直接用于接收，等收到数据以后，直接就把这个内存块抛出去了，这样就避免了复制操作。所以，文件传输时效率才会高。当然这个操作在小数据时是没什么优势的。
#### 4.数据处理适配器
相信大家都使用过其他的Socket产品，例如HPSocket，SuperSocket等，那么RRQMSocket在设计时也是借鉴了其他产品的优秀设计理念，数据处理适配器就是其中之一，但和其他产品的设计不同的是，RRQMSocket的适配器功能更加强大，它可以无视真实的数据，而模拟出想要的数据，例如：可以对数据进行预处理，从而解决数据分包。粘包的问题，也可以直接解析HTTP协议，经过适配器处理后传回一个HttpRequest对象等。
#### 5.粘包、分包解决
在RRQMSocket中处理TCP粘包、分包问题是非常简单的。只需要更改不同的**数据处理适配器**即可。例如：使用**固定包头**，只需要给TcpSocketClient和TcpClient赋值**FixedHeaderDataHandlingAdapter**的实例即可。同样对应的处理器也有**固定长度** 、 **终止字符分割** 等。
## 🔗联系作者
- [CSDN博客主页](https://blog.csdn.net/qq_40374647)
- [哔哩哔哩视频](https://space.bilibili.com/94253567)
- [源代码仓库主页](https://gitee.com/RRQM_Home)
- 交流QQ群：234762506
## ✨API文档
[RRQMSocket API文档](https://gitee.com/RRQM_OS/RRQM/wikis/pages)
## 📦 安装
- [Nuget RRQMSocket](https://www.nuget.org/packages/RRQMSocket/)
- [微软Nuget安装教程](https://docs.microsoft.com/zh-cn/nuget/quickstart/install-and-use-a-package-in-visual-studio)
## 🍻RRQM系产品
| 名称| 版本（Nuget Version）|下载（Nuget Download）| 描述 |
|------|----------|-------------|-------|
| [RRQMCore](https://gitee.com/RRQM_OS/RRQMCore) | [](https://www.nuget.org/packages/RRQMCore/) | [](https://www.nuget.org/packages/RRQMCore/) | RRQMCore是为RRQM系提供基础服务功能的库，其中包含：**内存池**、**对象池**、**等待逻辑池**、**AppMessenger**、**3DES加密**、**Xml快速存储**、**运行时间测量器**、**文件快捷操作**、**高性能序列化器**、**规范日志接口**等。 |
| [RRQMMVVM](https://gitee.com/RRQM_OS/RRQMMVVM) | [](https://www.nuget.org/packages/RRQMMVVM/) | [](https://www.nuget.org/packages/RRQMMVVM/) | RRQMMVVM是超轻简的MVVM框架，但是麻雀虽小，五脏俱全。|
| [RRQMSkin](https://gitee.com/RRQM_OS/RRQMSkin) | [](https://www.nuget.org/packages/RRQMSkin/) | [](https://www.nuget.org/packages/RRQMSkin/) | RRQMSkin是WPF的控件样式库，其中包含： **无边框窗体** 、 **圆角窗体** 、 **水波纹按钮** 、 **输入提示筛选框** 、 **控件拖动效果** 、**圆角图片框**、 **弧形文字** 、 **扇形元素** 、 **指针元素** 、 **饼图** 、 **时钟** 、 **速度表盘** 等。|
## 💐快速入门
## 一、TCP框架
### 1.1 创建服务器
**创建原生TcpService**
使用原生TcpService的话，必须创建并指定辅助类，示例中创建MyTcpSocketClient辅助类，继承于TcpSocketClient即可。TcpService自由度更大，可在辅助类中直接处理数据，每个辅助类实例一一对应远程客户端，开发层次比较清晰。
```CSharp
TcpService service = new TcpService();
//订阅事件
//service.ClientConnected += Service_ClientConnected;//订阅连接事件
//service.ClientDisconnected += Service_ClientDisconnected;//订阅断开连接事件
//service.CreatSocketCliect += Service_CreatSocketCliect;//订阅创建辅助类事件，可直接设置其他属性。
//属性设置
service.IsCheckClientAlive = true;//使用空包检验活性，不会对数据有任何影响。
service.BufferLength = 1024;//设置缓存池大小，该数值在框架中经常用于申请ByteBlock，所以该值会影响内存池效率。
service.IDFormat = "TcpSocketClient_{0}";//设置分配ID的格式， 格式必须符合字符串格式，至少包含一个补位， 初始值为“{0}-TCP”
service.Logger = new Log();//设置内部日志记录器，默认日志是控制台输出。
service.MaxCount = 1000;//设置最大连接数，可动态设置，当已连接数超过设置数值时，将主动断开客户端。
//属性读取
string ipAndPort = service.Name;//获取Ip及端口号
string ip = service.IP;//获取IP
int port = service.Port;//获取端口号
MyTcpSocketClient socketClient = service.SocketClients["TcpSocketClient_1"];//通过ID获取辅助类，查找未知会抛出异常
service.SocketClients.TryGetSocketClient("TcpSocketClient_1",out socketClient);//通过ID获取辅助类
//方法
service.Bind(7789, 2);//绑定监听，可绑定Ipv6，可监听所有地址。
bool isExist = service.SocketClientExist("TcpSocketClient_1");//使用该方法判断ID对应的TcpSocketClient是否在线。
Console.WriteLine("TcpService绑定成功");
```
```CSharp
public class MyTcpSocketClient : TcpSocketClient
{
///
/// 初次创建对象，效应相当于构造函数，但是调用时机在构造函数之后，可覆盖父类方法
///
public override void Create()
{
this.DataHandlingAdapter = new NormalDataHandlingAdapter();//普通TCP报文处理器
//this.DataHandlingAdapter = new FixedHeaderDataHandlingAdapter();//固定包头TCP报文处理器
//this.DataHandlingAdapter = new FixedSizeDataHandlingAdapter(1024);//固定长度TCP报文处理器
//this.DataHandlingAdapter = new TerminatorDataHandlingAdapter(1024, "\r\n");//终止字符TCP报文处理器
//this.DataHandlingAdapter = new MyTestDataHandingAdopter();//自定义处理器
}
private int count;
protected override void HandleReceivedData(ByteBlock byteBlock, object obj)
{
count++;
if (count % 1 == 0)
{
string mes = Encoding.UTF8.GetString(byteBlock.Buffer, 0, (int)byteBlock.Length);
Console.WriteLine($"已接收到信息：{mes},第{count}条");
}
if (this.Online)
{
this.Send(byteBlock);//回传消息
}
}
}
```
**创建RRQMTcpService**
RRQMTcpService是对TcpService的简单封装，指定辅助类为RRQMSocketClient，在辅助类中不做任何数据处理，仅将数据在RRQMTcpService中抛出。
```CSharp
RRQMTcpService service = new RRQMTcpService();
//service.CreatSocketCliect += Service_CreatSocketCliect1;//在初创辅助类时，可指定数据处理适配器。
//service.OnReceived += Service_OnReceived;//可直接订阅收到数据事件。
//方法
service.Bind(7789, 2);//绑定监听，可绑定Ipv6，可监听所有地址。
Console.WriteLine("RRQMTcpService绑定成功");
```
**创建TokenTcpService**
TokenTcpService是继承于TcpService的功能扩展服务器，该服务器的主要功能是通过验证“口令”对连接的客户端进行筛选，及时的将**不允许连接**、**恶意连接**、**不安全连接**的客户端拒之门外，也可以实现**租户模式**。
```CSharp
TokenTcpService service = new TokenTcpService();
service.VerifyToken = "ABC";
//方法
service.Bind(7789, 2);//绑定监听，可绑定Ipv6，可监听所有地址。
Console.WriteLine("TokenTcpService绑定成功");
```
**注意：** 使用该服务器必须遵循连接协议，或使用专属客户端（TokenTcpClient）连接。
### 1.2 创建客户端
**创建TcpClient**
TcpClient可与任意服务器进行连接、收发，处理数据，也可以更加方便的处理粘包和分包，亦或者解析数据结构。
```CSharp
TcpClient client = new TcpClient();
//属性
client.BufferLength = 1024;//设置缓存池大小，该数值在框架中经常用于申请ByteBlock，所以该值会影响内存池效率。
client.Logger = new Log();//设置内部日志记录器，默认日志是控制台输出。
client.DataHandlingAdapter = new NormalDataHandlingAdapter();//数据处理适配器，可用于处理粘包、解析对象。
//事件
//client.ConnectedService += Client_ConnectedService;
//client.DisconnectedService += Client_DisconnectedService;
//client.OnReceived += Client_OnReceived;
//方法
client.Connect(new IPHost("127.0.0.1:7789"));//连接
Console.WriteLine("连接成功");
client.Send(Encoding.UTF8.GetBytes("若汝棋茗"));//发送数据
Console.WriteLine("发送成功");
```
**创建TokenTcpClient**
```CSharp
TokenTcpClient client = new TokenTcpClient();
//属性
client.VerifyToken="ABC";//设置链接口令。
client.BufferLength = 1024;//设置缓存池大小，该数值在框架中经常用于申请ByteBlock，所以该值会影响内存池效率。
client.Logger = new Log();//设置内部日志记录器，默认日志是控制台输出。
client.DataHandlingAdapter = new NormalDataHandlingAdapter();//数据处理适配器，可用于处理粘包、解析对象。
//事件
//client.ConnectedService += Client_ConnectedService;
//client.DisconnectedService += Client_DisconnectedService;
//client.OnReceived += Client_OnReceived;
//方法
client.Connect(new IPHost("127.0.0.1:7789"));//连接
Console.WriteLine("连接成功");
client.Send(Encoding.UTF8.GetBytes("若汝棋茗"));//发送数据
Console.WriteLine("发送成功");
```
### 1.3 数据处理适配器
数据处理适配器的主要作用就是对发送、接收的数据进行封装和解析。在RRQMSocket中，可以利用数据处理适配器解决**粘包**、**分包**问题，也能**解析Http**数据报文。
**类型**
- **NormalDataHandlingAdapter**普通TCP报文处理器
- **FixedSizeDataHandlingAdapter**固定长度TCP报文处理器
- **TerminatorDataHandlingAdapter**终止字符TCP报文处理器
- **FixedHeaderDataHandlingAdapter**固定包头TCP报文处理器
- **HttpDataHandlingAdapter**解析Http处理器（需安装RRQMSocket.Http）
**客户端使用**
客户端比较简单，直接对其赋值即可。
```CSharp
client.DataHandlingAdapter = new NormalDataHandlingAdapter();//数据处理适配器，可用于处理粘包、解析对象。
```
**服务器使用**
在服务器使用适配器时，必须保证每个**TcpSocketClient**都拥有一个**单独实例**的适配器，所以可以订阅**CreatSocketCliect**事件，然后又因为RRQMSocket中有连接对象池，所以最好进行**新创建判断**，然后再创建实例化，避免多次实例化赋值带来的性能问题。
```CSharp
private static void Service_CreatSocketCliect(RRQMSocketClient arg1, CreatOption arg2)
{
if (arg2.NewCreate)
{
arg1.DataHandlingAdapter = new NormalDataHandlingAdapter();
}
}
```
如果是**自定义继承**的TcpSocketClient，可以重写**Create**方法。
**注意：在构造函数内赋值适配器无效，会被Create方法覆盖**
```CSharp
public class MyTcpSocketClient : TcpSocketClient
{
///
/// 初次创建对象，效应相当于构造函数，但是调用时机在构造函数之后，可覆盖父类方法
///
public override void Create()
{
this.DataHandlingAdapter = new NormalDataHandlingAdapter();//普通TCP报文处理器
//this.DataHandlingAdapter = new FixedHeaderDataHandlingAdapter();//固定包头TCP报文处理器
//this.DataHandlingAdapter = new FixedSizeDataHandlingAdapter(1024);//固定长度TCP报文处理器
//this.DataHandlingAdapter = new TerminatorDataHandlingAdapter(1024, "\r\n");//终止字符TCP报文处理器
}
}
```
#### 1.4 Demo
[RRQMBox](https://gitee.com/RRQM_OS/RRQMBox)
## 二、文件传输框架
### 2.1 创建文件服务器
以下进行简单示例，详细使用见[文件传输入门](https://gitee.com/dotnetchina/RRQMSocket/wikis/5.1%20%E6%A6%82%E8%BF%B0?sort_id=3897485)
```Csharp
FileService fileService = new FileService();
fileService.VerifyToken ="123ABC";
fileService.BreakpointResume = true;//支持断点续传
try
{
fileService.Bind(7789,2);//直接监听7789端口号。多线程，默认为1，此处设置线程数量为2
/* 订阅相关事件
fileService.ClientConnected += FileService_ClientConnected;
fileService.ClientDisconnected += FileService_ClientDisconnected;
fileService.BeforeTransfer += FileService_BeforeTransfer ;
fileService.FinishedTransfer += FileService_FinishedTransfer ;
fileService.ReceiveSystemMes += FileService_ReceiveSystemMes;
*/
}
catch (Exception ex)
{
MessageBox.Show(ex.Message);
}
```
### 2.2 传输文件
先初始化客户端。
```Csharp
FileClient fileClient = new FileClient();
//订阅事件
//fileClient.TransferFileError += FileClient_TransferFileError;
//fileClient.BeforeFileTransfer += this.FileClient_BeforeFileTransfer; ;
//fileClient.FinishedFileTransfer += this.FileClient_FinishedFileTransfer; ;
//fileClient.DisconnectedService += FileClient_DisConnectedService;
//fileClient.ReceiveSystemMes += this.FileClient_ReceiveSystemMes;
//fileClient.ConnectedService += this.FileClient_ConnectedService;
//fileClient.FileTransferCollectionChanged += this.FileClient_FileTransferCollectionChanged;
fileClient.Connect(new IPHost("127.0.0.1:7789"));//连接服务器。
```
然后调用**RequestTransfer**进行传输文件。此方法即可上传，也可下载。请求成功后会将传输排入队列，然后依次传输。
```Csharp
fileClient.RequestTransfer();
```
#### 2.3 特点
- 简单易用。
- 多线程处理。
- 高性能，传输速度可达500Mb/s。
- 超简单的传输限速设置，1k-10Gb 无级调节。
- 超简单的传输速度、传输进度获取。
- 随心所欲的暂停、继续、停止传输。
- 系统化的权限管理，让敏感文件只允许私有化下载。
- 随时发送消息，让客户端和服务器交流不延迟。
- 基于事件驱动，让每一步操作尽在掌握。
- 可视化的文件块流，可以实现像迅雷一样的填充式进度条。
- 超简单的断点续传设置，为大文件传输保驾护航。
- 无状态上传断点续传设置，让同一个文件，在不同客户端之间接力上传。
- 已经上传的文件，再次上传时，可实现快速上传。
- 极少的GC释放。
#### 2.4 Demo示例
**Demo位置：** [RRQMBox](https://gitee.com/RRQM_OS/RRQMBox)
**说明：** 可以看到，图一正在上传一个Window的系统镜像文件，大约4.2Gb，传输速度已达到346Mb/s，这是因为服务器和客户端在同一电脑上，磁盘性能限制导致的。其次，GC基本上没有释放，性能非常强悍，图二是下载文件，性能依旧非常强悍。
## 三、RPC框架
#### 4.1 创建RPC服务
新建类文件，继承于ServerProvider，并将其中公共方法标识为RRQMRPCMethod即可。
```
public class Server: ServerProvider
{
[RRQMRPCMethod]
public string TestOne(string str)
{
return "若汝棋茗";
}
}
```
#### 4.2 启动RPC服务
[启动RPC服务说明](https://gitee.com/RRQM_OS/RRQM/wikis/6.3%20%E5%88%9B%E5%BB%BA%E3%80%81%E5%90%AF%E5%8A%A8RPC%E6%9C%8D%E5%8A%A1%E5%99%A8?sort_id=3984501)
#### 4.3 特点
- 简单易用。
- 多线程处理。
- 高性能，在保证送达但不返回的情况下，10w次调用用时0.8s，在返回的情况下，用时3.9s。
- 支持TCP、UDP等不同的协议调用相同服务。
- 支持指定服务异步执行。
- 支持权限管理，让非法调用死在萌芽时期。
- 全自动 **代码生成** ，可使用系统编译成dll调用，也可以使用插件生成代理调用。
- 代理方法会生成异步方法，支持客户端异步调用。
- **支持out、ref** ，参数设定默认值等。
- 随心所欲的序列化方式，除了自带的[超轻量级二进制序列化](https://blog.csdn.net/qq_40374647/article/details/114178244?spm=1001.2014.3001.5501)、xml序列化外，用户可以自己随意使用其他序列化。
- 支持编译式调用，也支持方法名+参数式调用。
- **全异常反馈** ，服务里发生的异常，会一字不差的反馈到客户端。
- 超简单、自由的**回调方式** 。
#### 4.3 Demo示例
**Demo位置：** [RRQMSocket.RPC.Demo](https://gitee.com/RRQM_Home/RRQMSocket.RPC.Demo)
**说明：**
图一、图二、图三分别为`UDP无反馈调用`、`TCP有反馈调用`、`TCP连接池有反馈调用`。调用次数均为10w次，调用性能非常nice。在无反馈中，吞吐量达14.28w，在有反馈中达2.72w，简直秒杀WCF（WCF使用http协议，在本机测试吞吐量为310）
## 致谢
谢谢大家对我的支持，如果还有其他问题，请加群QQ：234762506讨论。
## 💕 支持本项目
您的支持就是我不懈努力的动力。打赏时请一定留下您的称呼。
**赞助总金额:366.6￥**
**赞助名单：**
（以下排名只按照打赏时间顺序）
> 1.Bobo Joker
> 2.UnitySir
> 3.Coffee
