SAEA.MessageSocket 26.4.23.1

SAEA.MessageSocket - 高性能消息服务器 💬

English Version | 中文版

基于 SAEA.Sockets 的高性能消息服务器，支持私信、频道、群组三种消息模式，采用 Protobuf 序列化传输。

快速导航 🧭

30秒快速开始 ⚡

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

Step 1: 安装 NuGet 包

dotnet add package SAEA.MessageSocket

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

using SAEA.MessageSocket;

var server = new MessageServer(port: 39654);
server.OnDisconnected += (id) => Console.WriteLine($"用户断开: {id}");
server.Start();

Step 3: 创建消息客户端连接

var client = new MessageClient("127.0.0.1", 39654);
client.OnPrivateMessage += (msg) => Console.WriteLine($"私信: {msg.Content}");
client.OnChannelMessage += (msg) => Console.WriteLine($"频道: {msg.Content}");
client.OnGroupMessage += (msg) => Console.WriteLine($"群组: {msg.Content}");
client.Connect();
client.SendPrivateMsg("user_002", "Hello!");

就这么简单！ 🎉 你已经实现了一个支持三种消息模式的高性能消息系统。

核心特性 🎯

架构设计 📐

消息模式架构图

┌─────────────────────────────────────────────────────────────┐
│                  SAEA.MessageSocket 架构                      │
├─────────────────────────────────────────────────────────────┤
│                                                             │
│    ┌─────────────────────────────────────────────────┐      │
│    │                 MessageServer                    │      │
│    │                 (消息服务器)                      │      │
│    └─────────────────────┬───────────────────────────┘      │
│                            │                                 │
│            ┌───────────────┼───────────────┐                 │
│            │               │               │                 │
│     ┌──────▼──────┐ ┌─────▼──────┐ ┌──────▼──────┐         │
│     │ PrivateMsg  │ │ ChannelMsg │ │  GroupMsg   │         │
│     │   (私信)    │ │  (频道)    │ │   (群组)    │         │
│     └──────┬──────┘ └─────┬──────┘ └──────┬──────┘         │
│            │               │               │                 │
│     ┌──────▼──────┐ ┌─────▼──────┐ ┌──────▼──────┐         │
│     │  点对点     │ │  发布订阅  │ │  群组管理   │         │
│     │  一对一     │ │  一对多    │ │   多对多    │         │
│     └─────────────┘ └────────────┘ └─────────────┘         │
│                                                             │
│    ┌─────────────────────────────────────────────────┐      │
│    │              Protobuf 序列化层                   │      │
│    │         ChatMessage / ChatMessageType           │      │
│    └─────────────────────────────────────────────────┘      │
│                            │                                 │
│    ┌───────────────────────▼───────────────────────┐        │
│    │              SAEA.Sockets (IOCP)               │        │
│    │              TCP 底层通信层                     │        │
│    └───────────────────────────────────────────────┘        │
│                                                             │
└─────────────────────────────────────────────────────────────┘

三种消息模式流程图

私信模式 (PrivateMessage):

  客户端A ──► SendPrivateMsg(userB, content) ──► 服务器路由
                                                        │
                                                        ▼
                                              查找 userB 连接
                                                        │
                                                        ▼
  客户端B ◄── OnPrivateMessage 事件 ◄─────────── 发送给 userB


频道模式 (ChannelMessage):

  发布者 ──► SendChannelMsg(channel, content) ──► 服务器
                                                       │
                                                       ▼
                                             查找频道订阅列表
                                                       │
                                           ┌───────────┼───────────┐
                                           ▼           ▼           ▼
                                       订阅者1     订阅者2     订阅者N
                                           │           │           │
                                           ▼           ▼           ▼
                                     OnChannel  OnChannel  OnChannel


群组模式 (GroupMessage):

  创建者 ──► SendCreateGroup(name) ──► 群组创建
      │                                       │
      │                                       ▼
      └──► SendAddMember(name) ──► 成员加入群组
                                              │
  成员 ──► SendGroupMessage(name, msg) ──► 群组广播
                                              │
                                  ┌───────────┼───────────┐
                                  ▼           ▼           ▼
                              成员1       成员2       成员N
                                  │           │           │
                                  ▼           ▼           ▼
                            OnGroup     OnGroup     OnGroup

应用场景 💡

✅ 适合使用 SAEA.MessageSocket 的场景

消息模式选择指南

❌ 不适合的场景

性能对比 📊

与传统消息方案对比

消息模式性能对比

Protobuf vs JSON 序列化

💡 提示: Protobuf 在消息传输中比 JSON 体积小 3-10 倍，序列化速度快 5-20 倍。

常见问题 ❓

Q1: 三种消息模式有什么区别？

A:

Q2: 如何实现用户登录认证？

A: 在客户端连接后发送登录消息：

var client = new MessageClient("127.0.0.1", 39654);
client.Connect();

// 连接后发送登录认证
client.SendLogin("user_id", "token");

// 服务端可在 OnReceive 中处理登录逻辑

Q3: 频道和群组如何选择？

A:

• 频道: 适用于单向推送场景（新闻、公告），订阅者只接收消息，无需管理成员
• 群组: 适用于双向互动场景（讨论组、团队协作），支持成员管理、创建者权限控制

Q4: 如何处理离线消息？

A: SAEA.MessageSocket 专注于实时通信，离线消息需要配合存储方案：

// 服务端示例：存储离线消息
server.OnDisconnected += (id) => 
{
    // 用户离线，标记最后在线时间
    // 配合数据库存储离线消息
};

// 用户上线后拉取离线消息

Q5: 支持消息回调确认吗？

A: 支持，每种消息类型都有对应的 Answer 响应：

// 发送消息后会收到对应 Answer
// 如：PrivateMessage -> PrivateMessageAnswer
// 可通过消息 ID 关联请求和响应

Q6: 如何扩展自定义消息类型？

A: 在 ChatMessageType 枚举基础上扩展，或使用消息内容携带类型信息：

// 利用 Protobuf 的灵活性
// 在消息内容中嵌入自定义类型标识
client.SendPrivateMsg(userId, JsonSerializer.Serialize(new 
{ 
    type = "custom_type", 
    data = yourData 
}));

Q7: 单服务器能支持多少并发？

A: 默认配置支持 1000 个连接，可通过构造函数调整：

// bufferSize: 缓冲区大小
// count: 最大连接数
// timeOut: 超时时间(毫秒)
var server = new MessageSocket(1024, 10000, 30 * 60 * 1000);

实际性能取决于服务器硬件配置，IOCP 模式下万级并发轻松支持。

核心类 🔧

使用示例 📝

基础服务器配置

using SAEA.MessageSocket;

// 创建消息服务器
// bufferSize: 1024, count: 1000000, timeOut: 30分钟
var server = new MessageServer(1024, 1000 * 1000, 30 * 60 * 1000);

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

server.Start();
Console.WriteLine("消息服务器已启动，端口: 39654");

完整客户端示例

using SAEA.MessageSocket;

var client = new MessageClient("127.0.0.1", 39654);

// 私信事件
client.OnPrivateMessage += (msg) => 
    Console.WriteLine($"[私信] 来自 {msg.Sender}: {msg.Content}");

// 频道消息事件
client.OnChannelMessage += (msg) => 
    Console.WriteLine($"[频道:{msg.Name}] {msg.Content}");

// 群组消息事件
client.OnGroupMessage += (msg) => 
    Console.WriteLine($"[群组:{msg.Name}] {msg.Content}");

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

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

私信消息

// 发送私信给指定用户
client.SendPrivateMsg("user_002", "你好，这是一条私信！");

// OnPrivateMessage 事件会收到对方回复

频道消息（发布/订阅）

// 订阅频道
client.Subscribe("news_channel");
client.Subscribe("sports_channel");

// 发送频道消息（所有订阅该频道的用户都会收到）
client.SendChannelMsg("news_channel", "今日新闻头条...");

// 取消订阅
client.Unsubscribe("news_channel");

// 查看当前订阅的频道
var channels = client.GetSubscribedChannels();

群组消息

// 创建群组（创建者拥有管理权限）
client.SendCreateGroup("project_team");

// 其他用户加入群组
client.SendAddMember("project_team");

// 发送群组消息
client.SendGroupMessage("project_team", "项目进度更新...");

// 离开群组
client.SendRemoveMember("project_team");

// 删除群组（仅创建者可操作）
client.SendRemoveGroup("project_team");

完整示例：多人聊天室

using SAEA.MessageSocket;

// 服务器端
var server = new MessageServer(1024, 1000 * 1000, 30 * 60 * 1000);
server.Start();

// 客户端1 - 创建群组
var client1 = new MessageClient("127.0.0.1", 39654);
client1.OnGroupMessage += (msg) => Console.WriteLine($"Client1: {msg.Content}");
client1.Connect();
client1.SendCreateGroup("chat_room");

// 客户端2 - 加入群组
var client2 = new MessageClient("127.0.0.1", 39654);
client2.OnGroupMessage += (msg) => Console.WriteLine($"Client2: {msg.Content}");
client2.Connect();
client2.SendAddMember("chat_room");

// 客户端3 - 加入群组
var client3 = new MessageClient("127.0.0.1", 39654);
client3.OnGroupMessage += (msg) => Console.WriteLine($"Client3: {msg.Content}");
client3.Connect();
client3.SendAddMember("chat_room");

// 发送群组消息（所有成员都会收到）
client1.SendGroupMessage("chat_room", "大家好！");
client2.SendGroupMessage("chat_room", "你好 client1！");

消息类型

public enum ChatMessageType
{
    Login = 1,                // 登录
    LoginAnswer = 2,          // 登录响应
    Subscribe = 3,            // 订阅频道
    SubscribeAnswer = 4,      // 订阅响应
    UnSubscribe = 5,          // 取消订阅
    UnSubscribeAnswer = 6,    // 取消订阅响应
    ChannelMessage = 7,       // 频道消息
    PrivateMessage = 8,       // 私信消息
    PrivateMessageAnswer = 9, // 私信响应
    CreateGroup = 10,         // 创建群组
    CreateGroupAnswer = 11,   // 创建群组响应
    AddMember = 12,           // 添加成员
    AddMemberAnswer = 13,     // 添加成员响应
    RemoveMember = 14,        // 移除成员
    RemoveMemberAnswer = 15,  // 移除成员响应
    RemoveGroup = 16,         // 删除群组
    RemoveGroupAnswer = 17,   // 删除群组响应
    GroupMessage = 18,        // 群组消息
    GroupMessageAnswer = 19   // 群组消息响应
}

消息模式对比

依赖项

更多资源

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

许可证

Apache License 2.0