tsai
/
abp-next-admin2
mirror of https://github.com/colinin/abp-next-admin.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
这是基于vue-vben-admin 模板适用于abp vNext的前端管理项目
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
2888 Commits
72 Branches
54 Tags
77 MiB
 
 
 
 
 
 
Tree: ac7a940a9e
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'ac7a940a9e'
${ noResults }
abp-next-admin2/docs/wiki/数据库设计/数据模型/实时消息数据模型/实时消息数据模型.md

20 KiB
Raw Blame History

基于我对代码库的深入分析，我现在可以创建关于实时消息模块数据模型的详细文档。

# 实时消息数据模型 **本文档中引用的文件** - [Message.cs](file://aspnet-core/modules/realtime-message/LINGYUN.Abp.MessageService.Domain/LINGYUN/Abp/MessageService/Chat/Message.cs) - [UserMessage.cs](file://aspnet-core/modules/realtime-message/LINGYUN.Abp.MessageService.Domain/LINGYUN/Abp/MessageService/Chat/UserMessage.cs) - [GroupMessage.cs](file://aspnet-core/modules/realtime-message/LINGYUN.Abp.MessageService.Domain/LINGYUN/Abp/MessageService/Groups/GroupMessage.cs) - [MessageState.cs](file://aspnet-core/modules/realtime-message/LINGYUN.Abp.IM/LINGYUN/Abp/IM/Messages/MessageState.cs) - [MessageType.cs](file://aspnet-core/modules/realtime-message/LINGYUN.Abp.IM/LINGYUN/Abp/IM/Messages/MessageType.cs) - [MessageSourceType.cs](file://aspnet-core/modules/realtime-message/LINGYUN.Abp.IM/LINGYUN/Abp/IM/Messages/MessageSourceType.cs) - [IMessageRepository.cs](file://aspnet-core/modules/realtime-message/LINGYUN.Abp.MessageService.Domain/LINGYUN/Abp/MessageService/Chat/IMessageRepository.cs) - [EfCoreMessageRepository.cs](file://aspnet-core/modules/realtime-message/LINGYUN.Abp.MessageService.EntityFrameworkCore/LINGYUN/Abp/MessageService/Chat/EfCoreMessageRepository.cs) - [MessageStore.cs](file://aspnet-core/modules/realtime-message/LINGYUN.Abp.MessageService.Domain/LINGYUN/Abp/MessageService/Chat/MessageStore.cs) - [IMessageStore.cs](file://aspnet-core/modules/realtime-message/LINGYUN.Abp.IM/LINGYUN/Abp/IM/Messages/IMessageStore.cs) - [ChatMessage.cs](file://aspnet-core/modules/realtime-message/LINGYUN.Abp.IM/LINGYUN/Abp/IM/Messages/ChatMessage.cs) - [LastChatMessage.cs](file://aspnet-core/modules/realtime-message/LINGYUN.Abp.IM/LINGYUN/Abp/IM/Messages/LastChatMessage.cs) - [InitialRealtimeMessage.cs](file://aspnet-core/migrations/LY.MicroService.RealtimeMessage.EntityFrameworkCore/Migrations/20230110063428_Initial-Realtime-Message.cs) - [MessageServiceErrorCodes.cs](file://aspnet-core/modules/realtime-message/LINGYUN.Abp.MessageService.Domain.Shared/LINGYUN/Abp/MessageService/MessageServiceErrorCodes.cs)

目录

  1. 简介
  2. 核心实体设计
  3. 消息类型与状态
  4. 数据库表结构
  5. 消息存储与检索
  6. 索引优化策略
  7. 高并发处理机制
  8. 消息分片策略
  9. 扩展性设计
  10. 最佳实践指南

简介

实时消息模块是ABP Next Admin框架中的核心组件，专门设计用于处理高并发的即时通讯场景。该模块采用领域驱动设计（DDD）原则，通过抽象的消息模型、灵活的存储策略和完善的索引优化，确保在大规模用户场景下仍能保持高性能和数据一致性。

核心实体设计

消息基类架构

classDiagram
class Message {
+Guid? TenantId
+long MessageId
+string SendUserName
+string Content
+MessageType Type
+MessageSourceType Source
+MessageState State
+ChangeSendState(state) void
#Message(id, sendUserId, sendUserName, content, type, source, tenantId)
}
class UserMessage {
+Guid ReceiveUserId
+UserMessage(id, sendUserId, sendUserName, receiveUserId, content, type, source, tenantId)
}
class GroupMessage {
+long GroupId
+GroupMessage(id, sendUserId, sendUserName, groupId, content, type, source, tenantId)
}
class ChatMessage {
+Guid? FormUserId
+string FormUserName
+Guid? ToUserId
+string GroupId
+DateTime SendTime
+bool IsAnonymous
+MessageType MessageType
+MessageSourceType Source
+ExtraPropertyDictionary ExtraProperties
+User(formUserId, formUserName, toUserId, content, clock, isAnonymous, type, source, tenantId)$ ChatMessage
+System(formUserId, toUserId, content, clock, type, tenantId)$ ChatMessage
+SystemLocalized(formUserId, toUserId, content, clock, type, tenantId)$ ChatMessage
}
Message <|-- UserMessage : "继承"
Message <|-- GroupMessage : "继承"
Message <|.. ChatMessage : "映射"

图表来源

  • Message.cs
  • UserMessage.cs
  • GroupMessage.cs
  • ChatMessage.cs

实体关系图

erDiagram
MESSAGE {
bigint Id PK
char(36)_TenantId
bigint_MessageId
varchar(64)_SendUserName
longtext_Content
int_Type
int_Source
tinyint_State
datetime_CreationTime
char(36)_CreatorId
varchar(40)_ConcurrencyStamp
}
USER_MESSAGE {
bigint Id PK
char(36)_ReceiveUserId
longtext_ExtraProperties
char(36)_TenantId
bigint_MessageId
varchar(64)_SendUserName
longtext_Content
int_Type
int_Source
tinyint_State
}
GROUP_MESSAGE {
bigint Id PK
bigint_GroupId
longtext_ExtraProperties
char(36)_TenantId
bigint_MessageId
varchar(64)_SendUserName
longtext_Content
int_Type
int_Source
tinyint_State
}
LAST_CHAT_MESSAGE {
bigint Id PK
char(36)_FormUserId
varchar(256)_FormUserName
char(36)_ToUserId
varchar(20)_GroupId
datetime_SendTime
tinyint_IsAnonymous
int_MessageType
int_Source
json_ExtraProperties
}
MESSAGE ||--|| USER_MESSAGE : "包含"
MESSAGE ||--|| GROUP_MESSAGE : "包含"
USER_MESSAGE ||--|| LAST_CHAT_MESSAGE : "映射"
GROUP_MESSAGE ||--|| LAST_CHAT_MESSAGE : "映射"

图表来源

  • InitialRealtimeMessage.cs

章节来源

  • Message.cs
  • UserMessage.cs
  • GroupMessage.cs

消息类型与状态

消息类型体系

系统支持多种消息类型，每种类型都有特定的用途和处理逻辑：

flowchart TD
MessageType["消息类型"] --> Text["文本消息<br/>Text = 0"]
MessageType --> Image["图片消息<br/>Image = 10"]
MessageType --> Link["链接消息<br/>Link = 20"]
MessageType --> Video["视频消息<br/>Video = 30"]
MessageType --> Voice["音频消息<br/>Voice = 40"]
MessageType --> File["文件消息<br/>File = 50"]
MessageType --> Notifier["通知消息<br/>Notifier = 100"]
Text --> TextDesc["支持纯文本内容<br/>最大长度：无限制"]
Image --> ImageDesc["支持各种图片格式<br/>大小限制：10MB"]
Link --> LinkDesc["支持网页链接预览<br/>自动提取标题和描述"]
Video --> VideoDesc["支持主流视频格式<br/>大小限制：100MB"]
Voice --> VoiceDesc["支持语音消息<br/>格式：MP3/WAV<br/>时长限制：5分钟"]
File --> FileDesc["支持各种文件类型<br/>大小限制：100MB"]
Notifier --> NotifierDesc["系统错误通知<br/>特殊处理逻辑"]

图表来源

  • MessageType.cs

消息状态管理

stateDiagram-v2
[*] --> Send : "消息创建"
Send --> Read : "接收方已读"
Send --> ReCall : "消息撤回"
Send --> Failed : "发送失败"
Read --> ReCall : "消息撤回"
ReCall --> [*] : "删除消息"
Failed --> [*] : "重试或清理"
note right of Send : "状态值：0<br/>消息成功发送"
note right of Read : "状态值：1<br/>接收方已读取"
note right of ReCall : "状态值：10<br/>消息被撤回"
note right of Failed : "状态值：50<br/>发送过程中出错"

图表来源

  • MessageState.cs

章节来源

  • MessageType.cs
  • MessageState.cs

数据库表结构

主要表结构设计

系统采用分离式存储策略，将用户消息和群组消息分别存储在不同的表中，以优化查询性能：

erDiagram
APP_USER_MESSAGES {
bigint Id PK
char(36)_ReceiveUserId
longtext_ExtraProperties
varchar(40)_ConcurrencyStamp
datetime_CreationTime
char(36)_CreatorId
char(36)_TenantId
bigint_MessageId
varchar(64)_SendUserName
longtext_Content
int_Type
int_Source
tinyint_State
}
APP_GROUP_MESSAGES {
bigint Id PK
bigint_GroupId
longtext_ExtraProperties
varchar(40)_ConcurrencyStamp
datetime_CreationTime
char(36)_CreatorId
char(36)_TenantId
bigint_MessageId
varchar(64)_SendUserName
longtext_Content
int_Type
int_Source
tinyint_State
}
APP_USER_CHAT_CARDS {
bigint Id PK
char(36)_UserId
varchar(256)_UserName
int_Sex
varchar(30)_Sign
varchar(256)_NickName
varchar(50)_Description
varchar(512)_AvatarUrl
datetime_Birthday
int_Age
datetime_LastOnlineTime
int_State
longtext_ExtraProperties
varchar(40)_ConcurrencyStamp
datetime_CreationTime
char(36)_CreatorId
char(36)_TenantId
}
APP_CHAT_GROUPS {
bigint Id PK
char(36)_AdminUserId
bigint_GroupId
varchar(20)_Name
varchar(512)_Tag
varchar(256)_Address
varchar(64)_Notice
int_MaxUserCount
tinyint_AllowAnonymous
tinyint_AllowSendMessage
varchar(128)_Description
varchar(128)_AvatarUrl
datetime_CreationTime
char(36)_CreatorId
char(36)_TenantId
}
APP_USER_CHAT_FRIENDS {
bigint Id PK
char(36)_UserId
char(36)_FrientId
tinyint_IsStatic
tinyint_Black
tinyint_DontDisturb
tinyint_SpecialFocus
varchar(256)_RemarkName
varchar(50)_Description
tinyint_unsigned_Status
longtext_ExtraProperties
varchar(40)_ConcurrencyStamp
datetime_CreationTime
char(36)_CreatorId
char(36)_TenantId
}
APP_USER_CHAT_SETTINGS {
bigint Id PK
char(36)_UserId
tinyint_AllowAnonymous
tinyint_AllowAddFriend
tinyint_RequireAddFriendValition
tinyint_AllowReceiveMessage
tinyint_AllowSendMessage
char(36)_TenantId
}
APP_USER_CHAT_GROUPS {
bigint Id PK
char(36)_UserId
bigint_GroupId
datetime_CreationTime
char(36)_CreatorId
char(36)_TenantId
}
APP_GROUP_CHAT_BLACKS {
bigint Id PK
bigint_GroupId
char(36)_ShieldUserId
datetime_CreationTime
char(36)_CreatorId
char(36)_TenantId
}
APP_USER_GROUP_CARDS {
bigint Id PK
char(36)_UserId
varchar(256)_NickName
tinyint_IsAdmin
datetime_SilenceEnd
longtext_ExtraProperties
varchar(40)_ConcurrencyStamp
datetime_CreationTime
char(36)_CreatorId
char(36)_TenantId
}
APP_USER_NOTIFICATIONS {
bigint Id PK
char(36)_UserId
bigint_NotificationId
int_ReadStatus
char(36)_TenantId
}
APP_NOTIFICATION_DEFINITIONS {
char(36)_Id PK
varchar(64)_Name
varchar(64)_GroupName
varchar(255)_DisplayName
varchar(255)_Description
int_NotificationLifetime
int_NotificationType
int_ContentType
varchar(200)_Providers
tinyint_AllowSubscriptionToClients
longtext_ExtraProperties
}
APP_NOTIFICATION_DEFINITION_GROUPS {
char(36)_Id PK
varchar(64)_Name
varchar(255)_DisplayName
varchar(255)_Description
tinyint_AllowSubscriptionToClients
longtext_ExtraProperties
}
APP_NOTIFICATIONS {
bigint Id PK
char(36)_TenantId
tinyint_Severity
int_Type
int_ContentType
bigint_NotificationId
varchar(100)_NotificationName
varchar(512)_NotificationTypeName
datetime_ExpirationTime
datetime_CreationTime
longtext_ExtraProperties
}
APP_USER_SUBSCRIBES {
bigint Id PK
char(36)_UserId
varchar(128)_UserName
char(36)_TenantId
datetime_CreationTime
varchar(100)_NotificationName
}
APP_USER_MESSAGES ||--|| APP_USER_CHAT_CARDS : "关联用户"
APP_GROUP_MESSAGES ||--|| APP_CHAT_GROUPS : "关联群组"
APP_USER_CHAT_FRIENDS ||--|| APP_USER_CHAT_CARDS : "好友关系"
APP_USER_CHAT_GROUPS ||--|| APP_CHAT_GROUPS : "用户群组关系"
APP_GROUP_CHAT_BLACKS ||--|| APP_CHAT_GROUPS : "黑名单"
APP_USER_GROUP_CARDS ||--|| APP_CHAT_GROUPS : "群组成员"
APP_USER_NOTIFICATIONS ||--|| APP_NOTIFICATIONS : "通知状态"
APP_NOTIFICATION_DEFINITIONS ||--|| APP_NOTIFICATION_DEFINITION_GROUPS : "通知分类"

图表来源

  • InitialRealtimeMessage.cs

章节来源

  • InitialRealtimeMessage.cs

消息存储与检索

存储架构设计

sequenceDiagram
participant Client as 客户端
participant MessageStore as 消息存储器
participant MessageRepo as 消息仓库
participant UserRepo as 用户仓库
participant GroupRepo as 群组仓库
participant DB as 数据库
Client->>MessageStore : StoreMessageAsync(chatMessage)
MessageStore->>MessageStore : 判断消息类型
alt 私聊消息
MessageStore->>UserRepo : 检查好友关系
UserRepo->>DB : 查询好友信息
DB-->>UserRepo : 返回结果
UserRepo-->>MessageStore : 验证通过
MessageStore->>MessageRepo : InsertUserMessageAsync()
MessageRepo->>DB : 插入用户消息
else 群聊消息
MessageStore->>GroupRepo : 检查群组权限
GroupRepo->>DB : 查询群组信息
DB-->>GroupRepo : 返回群组详情
GroupRepo-->>MessageStore : 权限验证
MessageStore->>MessageRepo : InsertGroupMessageAsync()
MessageRepo->>DB : 插入群组消息
end
MessageRepo->>DB : 提交事务
DB-->>MessageRepo : 确认插入
MessageRepo-->>MessageStore : 存储完成
MessageStore-->>Client : 返回结果

图表来源

  • MessageStore.cs
  • IMessageRepository.cs

查询优化策略

系统实现了多层次的查询优化机制：

flowchart TD
QueryRequest["查询请求"] --> TypeCheck{"消息类型"}
TypeCheck --> |私聊| UserQuery["用户消息查询"]
TypeCheck --> |群聊| GroupQuery["群组消息查询"]
UserQuery --> UserFilter["过滤条件"]
GroupQuery --> GroupFilter["群组过滤"]
UserFilter --> UserSort["排序处理"]
GroupFilter --> GroupSort["群组排序"]
UserSort --> UserPaging["分页处理"]
GroupSort --> GroupPaging["群组分页"]
UserPaging --> UserResult["返回用户消息"]
GroupPaging --> GroupResult["返回群组消息"]
UserResult --> ObjectMapper["对象映射"]
GroupResult --> ObjectMapper
ObjectMapper --> ChatMessage["转换为ChatMessage"]
ChatMessage --> FinalResult["最终结果"]

图表来源

  • EfCoreMessageRepository.cs

章节来源

  • MessageStore.cs
  • EfCoreMessageRepository.cs

索引优化策略

多维索引设计

为了支持高效的查询操作，系统在关键字段上建立了复合索引：

erDiagram
APP_USER_MESSAGES {
bigint Id PK
char(36)_TenantId
char(36)_ReceiveUserId
bigint_MessageId
varchar(64)_SendUserName
int_Type
tinyint_State
datetime_CreationTime
}
APP_GROUP_MESSAGES {
bigint Id PK
char(36)_TenantId
bigint_GroupId
bigint_MessageId
varchar(64)_SendUserName
int_Type
tinyint_State
datetime_CreationTime
}
APP_USER_CHAT_CARDS {
bigint Id PK
char(36)_TenantId
char(36)_UserId
varchar(256)_UserName
datetime_LastOnlineTime
}
APP_CHAT_GROUPS {
bigint Id PK
char(36)_TenantId
bigint_GroupId
varchar(20)_Name
datetime_CreationTime
}
APP_USER_CHAT_FRIENDS {
bigint Id PK
char(36)_TenantId
char(36)_UserId
char(36)_FrientId
tinyint_Status
}
APP_USER_CHAT_GROUPS {
bigint Id PK
char(36)_TenantId
bigint_GroupId
char(36)_UserId
datetime_CreationTime
}
INDEX_APP_USER_MESSAGES_TENANT_RECEIVEUSER["IX_AppUserMessages_TenantId_ReceiveUserId<br/>复合索引：租户+接收用户"]
INDEX_APP_GROUP_MESSAGES_TENANT_GROUP["IX_AppGroupMessages_TenantId_GroupId<br/>复合索引：租户+群组ID"]
INDEX_APP_USER_CHAT_CARDS_TENANT_USER["IX_AppUserChatCards_TenantId_UserId<br/>复合索引：租户+用户ID"]
INDEX_APP_CHAT_GROUPS_TENANT_NAME["IX_AppChatGroups_TenantId_Name<br/>复合索引：租户+群组名称"]
INDEX_APP_USER_CHAT_FRIENDS_TENANT_USER_FRIEND["IX_AppUserChatFriends_TenantId_UserId_FrientId<br/>三列复合索引：租户+用户+好友"]
INDEX_APP_USER_CHAT_GROUPS_TENANT_GROUP_USER["IX_AppUserChatGroups_TenantId_GroupId_UserId<br/>三列复合索引：租户+群组+用户"]

图表来源

  • InitialRealtimeMessage.cs

查询性能优化

系统采用了多种查询优化技术：

  1. 延迟加载优化：使用AsNoTracking()避免不必要的跟踪开销
  2. 投影查询：只选择需要的字段，减少数据传输量
  3. 分页查询：支持大结果集的分页处理
  4. 缓存策略：对频繁访问的数据建立缓存层

章节来源

  • InitialRealtimeMessage.cs
  • EfCoreMessageRepository.cs

高并发处理机制

事务隔离与锁机制

sequenceDiagram
participant User1 as 用户1
participant User2 as 用户2
participant MessageStore as 消息存储器
participant Transaction as 事务管理器
participant Lock as 锁机制
participant DB as 数据库
User1->>MessageStore : 发送消息A
User2->>MessageStore : 发送消息B
MessageStore->>Transaction : 开始事务A
MessageStore->>Transaction : 开始事务B
Transaction->>Lock : 获取行级锁A
Lock->>DB : 尝试锁定消息A
DB-->>Lock : 锁定成功
Transaction->>Lock : 获取行级锁B
Lock->>DB : 尝试锁定消息B
DB-->>Lock : 锁定成功
MessageStore->>DB : 执行消息A插入
MessageStore->>DB : 执行消息B插入
MessageStore->>Transaction : 提交事务A
MessageStore->>Transaction : 提交事务B
Transaction->>DB : 提交所有更改
DB-->>Transaction : 确认提交
Transaction-->>MessageStore : 事务完成
MessageStore-->>User1 : 发送成功
MessageStore-->>User2 : 发送成功

并发控制策略

系统采用以下策略确保高并发场景下的数据一致性：

  1. 乐观锁机制：使用ConcurrencyStamp字段防止并发更新冲突
  2. 事务隔离：合理设置事务隔离级别，平衡性能和一致性
  3. 批量处理：对大量消息采用批量插入和更新
  4. 异步处理：非关键路径的操作采用异步执行

章节来源

  • MessageStore.cs

消息分片策略

租户隔离设计

系统采用租户维度的分片策略，确保不同租户间的数据完全隔离：

graph TB
    subgraph "租户A"
        TA_DB[(租户A数据库)]
        TA_UserMsg[用户消息表]
        TA_GroupMsg[群组消息表]
        TA_ChatCards[聊天卡片表]
        TA_Friends[好友关系表]
    end
    
    subgraph "租户B"
        TB_DB[(租户B数据库)]
        TB_UserMsg[用户消息表]
        TB_GroupMsg[群组消息表]
        TB_ChatCards[聊天卡片表]
        TB_Friends[好友关系表]
    end
    
    subgraph "租户C"
        TC_DB[(租户C数据库)]
        TC_UserMsg[用户消息表]
        TC_GroupMsg[群组消息表]
        TC_ChatCards[聊天卡片表]
        TC_Friends[好友关系表]
    end
    
    TA_DB --> TA_UserMsg
    TA_DB --> TA_GroupMsg
    TA_DB --> TA_ChatCards
    TA_DB --> TA_Friends
    
    TB_DB --> TB_UserMsg
    TB_DB --> TB_GroupMsg
    TB_DB --> TB_ChatCards
    TB_DB --> TB_F