👁 Image
SAEA.WebSocket 26.4.23.1

SAEA.Sockets - 高性能 IOCP Socket 通信框架 🔌

👁 NuGet version
👁 License

| 中文版

基于 .NET Standard 2.0 的高性能 Socket 通信框架，采用 Windows IOCP 完成端口技术，支持万级并发连接。

快速导航 🧭

30秒快速开始 ⚡

最快上手方式，只需3步即可运行 TCP 服务器：

Step 1: 安装 NuGet 包

dotnet add package SAEA.Sockets

Step 2: 创建 TCP 服务器（仅需5行代码）

using SAEA.Sockets;
using SAEA.Sockets.Handler;

// 创建服务器配置
var option = SocketOptionBuilder.Instance
 .SetSocket(SAEASocketType.Tcp)
 .UseIocp()
 .SetPort(39654)
 .Build();

var server = SocketFactory.CreateServerSocket(option);
server.OnReceive += (id, data) => server.Send(id, data); // 收到消息立即回复
server.Start();

Step 3: 创建 TCP 客户端连接

var client = SocketFactory.CreateClientSocket(option);
client.OnReceive += (data) => Console.WriteLine(Encoding.UTF8.GetString(data));
client.Connect();
client.SendAsync(Encoding.UTF8.GetBytes("Hello SAEA!"));

就这么简单！ 🎉 你已经实现了一个支持万级并发的高性能 TCP 通信系统。

核心特性 🎯

架构设计 📐

组件架构图

┌─────────────────────────────────────────────────────────────┐
│ SAEA.Sockets 架构 │
├─────────────────────────────────────────────────────────────┤
│ │
│ ┌──────────────┐ ┌──────────────┐ │
│ │ IocpSocket │ │ StreamSocket │ │
│ │ (IOCP模式) │ │ (流模式) │ │
│ └──────────────┘ └──────────────┘ │
│ │ │ │
│ └──────────┬──────────┘ │
│ │ │
│ ┌───────▼───────┐ │
│ │ BaseSocket │ │
│ │ (基类) │ │
│ └───────┬───────┘ │
│ │ │
│ ┌──────────────┼──────────────┐ │
│ │ │ │ │
│ ┌──▼──┐ ┌────▼───┐ ┌───▼────┐ │
│ │Pool│ │ Session│ │ Coder │ │
│ │(池)│ │Manager │ │(编解码)│ │
│ └──┬──┘ └────┬───┘ └───┬────┘ │
│ │ │ │ │
│ BufferPool UserToken ICoder │
│ (内存池) (用户令牌) (协议接口) │
│ │
└─────────────────────────────────────────────────────────────┘

工作流程图

客户端连接流程:

客户端 ──► Connect ──► Server.Accepted
 │
 ▼
 ┌─────────────────┐
 │ UserTokenPool │ 分配用户令牌
 │ 获取 Token │
 └─────────────────┘
 │
 ▼
 ┌─────────────────┐
 │ SessionManager │ 注册会话
 │ 添加 Session │
 └─────────────────┘
 │
 ▼
 OnAccepted 事件触发

数据接收流程:

网络数据 ──► IOCP 完成 ──► BufferManager 接收
 │
 ▼
 ┌─────────────────┐
 │ Coder │ 解码数据
 │ Decode() │
 └─────────────────┘
 │
 ▼
 OnReceive 事件触发
 │
 ▼
 ┌─────────────────┐
 │ Coder │ 编码响应
 │ Encode() │
 └─────────────────┘
 │
 ▼
 SendAsync 发送数据

应用场景 💡

✅ 适合使用 SAEA.Sockets 的场景

❌ 不适合的场景

性能对比 📊

与传统 Socket 方案对比

IOCP vs 其他异步模型

💡 提示: IOCP 是 Windows 平台最高效的异步 IO 模型，专为高并发场景设计。

常见问题 ❓

Q1: IOCP 是什么？为什么选择 IOCP？

A: IOCP (I/O Completion Port) 是 Windows 平台的完成端口技术，是目前 Windows 上最高效的异步 IO 模型。相比传统的 Select/Poll 模型：

• 支持更大并发连接数（万级以上）
• CPU 利用率更高（单个线程处理多个连接）
• 系统资源消耗更低

Q2: 如何实现自定义协议？

A: 实现 ICoder 接口或继承 BaseCoder：

public class MyCoder : BaseCoder
{
 public override List<byte[]> Decode(byte[] data)
 {
 // 自定义解码逻辑，例如：解析消息头、消息体
 return base.Decode(data);
 }

 public override byte[] Encode(byte[] data)
 {
 // 自定义编码逻辑，例如：添加消息头
 return base.Encode(data);
 }
}

// 使用自定义编码器
public class MyContext : BaseContext<MyCoder>
{
 public MyContext(BaseUserToken userToken) : base(userToken) { }
}

Q3: 如何配置 SSL/TLS 加密？

A: 使用 Stream 模式并配置证书：

var option = SocketOptionBuilder.Instance
 .SetSocket(SAEASocketType.Tcp)
 .UseStream() // 使用流模式
 .UseSsl() // 启用 SSL
 .SetSslCertificate("server.pfx", "password")
 .Build();

Q4: 内存池的作用是什么？

A: BufferManager 和 UserTokenPool 通过预分配和复用内存：

• 减少 GC（垃圾回收）压力
• 避免频繁的内存分配/释放
• 提升整体性能和稳定性

Q5: TCP 和 UDP 如何选择？

A:

• TCP: 可靠传输、有序到达、适用游戏、聊天、RPC
• UDP: 高速传输、无连接、适用视频流、实时广播

SAEA.Sockets 同时支持两种模式，可根据场景灵活选择。

Q6: 支持的最大连接数是多少？

A: 默认配置支持 1000 个连接，可通过 SetCount() 调整：

var option = SocketOptionBuilder.Instance
 .SetCount(10000) // 设置最大连接数
 .Build();

实际性能取决于服务器硬件配置。

核心类 🔧

使用示例 📝

TCP 服务器（IOCP 模式）

using SAEA.Sockets;
using SAEA.Sockets.Handler;

// 使用 Builder 链式配置服务器
var option = SocketOptionBuilder.Instance
 .SetSocket(SAEASocketType.Tcp) // 设置 Socket 类型为 TCP
 .UseIocp() // 使用 IOCP 异步模型
 .SetIP("127.0.0.1") // 监听 IP
 .SetPort(39654) // 监听端口
 .SetBufferSize(1024 * 64) // 缓冲区大小 64KB
 .SetCount(1000) // 最大连接数
 .Build(); // 构建配置

var server = SocketFactory.CreateServerSocket(option);

// 注册事件处理
server.OnAccepted += (id) => 
 Console.WriteLine($"客户端连接: {id}");

server.OnReceive += (id, data) => 
{
 var message = Encoding.UTF8.GetString(data);
 Console.WriteLine($"收到数据: {message}");
 server.Send(id, data); // 回复客户端
};

server.OnDisconnected += (id) => 
 Console.WriteLine($"客户端断开: {id}");

server.Start();
Console.WriteLine("服务器已启动!");

TCP 客户端（IOCP 模式）

using SAEA.Sockets;

var option = SocketOptionBuilder.Instance
 .SetSocket(SAEASocketType.Tcp)
 .UseIocp()
 .SetIP("127.0.0.1")
 .SetPort(39654)
 .Build();

var client = SocketFactory.CreateClientSocket(option);

// 注册事件处理
client.OnReceive += (data) => 
 Console.WriteLine($"收到: {Encoding.UTF8.GetString(data)}");

client.OnDisconnected += () => 
 Console.WriteLine("连接断开");

// 连接服务器
client.Connect();

// 发送数据
client.SendAsync(Encoding.UTF8.GetBytes("Hello SAEA!"));

UDP 服务器

using SAEA.Sockets;

var option = SocketOptionBuilder.Instance
 .SetSocket(SAEASocketType.Udp) // UDP 模式
 .SetIP("127.0.0.1")
 .SetPort(39655)
 .Build();

var server = SocketFactory.CreateServerSocket(option);

server.OnReceive += (id, data) => 
{
 Console.WriteLine($"收到 UDP 数据");
 server.Send(id, data); // 回发数据
};

server.Start();

SSL/TLS 安全连接

using SAEA.Sockets;

var option = SocketOptionBuilder.Instance
 .SetSocket(SAEASocketType.Tcp)
 .UseStream() // 使用流模式（支持 SSL）
 .SetIP("127.0.0.1")
 .SetPort(443)
 .UseSsl() // 启用 SSL/TLS
 .SetSslCertificate("server.pfx", "password") // 配置证书
 .Build();

var server = SocketFactory.CreateServerSocket(option);
server.Start();

快捷封装类

using SAEA.Sockets.Shortcut;

// TCP 服务器快捷封装
var tcpServer = new TCPServer(39654);
tcpServer.OnReceive += (id, data) => tcpServer.Send(id, data);
tcpServer.Start();

// TCP 客户端快捷封装
var tcpClient = new TCPClient("127.0.0.1", 39654);
tcpClient.OnReceive += (data) => Console.WriteLine(Encoding.UTF8.GetString(data));
tcpClient.Connect();
tcpClient.Send("Hello!");

// UDP 快捷封装
var udpServer = new UDPServer(39655);
var udpClient = new UDPClient("127.0.0.1", 39655);

自定义协议编码器

using SAEA.Sockets.Base;
using SAEA.Sockets.Interface;

// 实现自定义编码器
public class MyCoder : BaseCoder
{
 public override List<byte[]> Decode(byte[] data)
 {
 // 自定义解码逻辑
 // 例如：解析自定义消息头、消息体
 return base.Decode(data);
 }

 public override byte[] Encode(byte[] data)
 {
 // 自定义编码逻辑
 // 例如：添加自定义消息头
 return base.Encode(data);
 }
}

// 使用自定义编码器
public class MyContext : BaseContext<MyCoder>
{
 public MyContext(BaseUserToken userToken) : base(userToken) { }
}

默认协议格式

BaseCoder 实现的默认消息协议：

| 8字节长度 | 1字节类型 | N字节内容 |

• 长度: 数据总长度（用于消息边界识别）
• 类型: 消息类型标识（可扩展）
• 内容: 实际消息数据

依赖项

更多资源

• GitHub 仓库
• NuGet 包
• 作者博客

许可证

Apache License 2.0