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.
3165 Commits
72 Branches
54 Tags
77 MiB
 
 
 
 
 
 
Tree: f6e753eaeb
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'f6e753eaeb'
${ noResults }
abp-next-admin2/docs/wiki/数据库设计/数据模型/数据模型.md

13 KiB
Raw Blame History

数据模型

**本文档中引用的文件** - [EntityTypeInfo.cs](file://aspnet-core/modules/data-protection/LINGYUN.Abp.DataProtectionManagement.Domain/LINGYUN/Abp/DataProtectionManagement/EntityTypeInfo.cs) - [EntityPropertyInfo.cs](file://aspnet-core/modules/data-protection/LINGYUN.Abp.DataProtectionManagement.Domain/LINGYUN/Abp/DataProtectionManagement/EntityPropertyInfo.cs) - [IdentitySessionDto.cs](file://aspnet-core/modules/identity/LINGYUN.Abp.Identity.Application.Contracts/LINGYUN/Abp/Identity/Dto/IdentitySessionDto.cs) - [MessageEto.cs](file://aspnet-core/modules/platform/LINGYUN.Platform.Domain.Shared/LINGYUN/Platform/Messages/MessageEto.cs) - [MessageStatus.cs](file://aspnet-core/modules/platform/LINGYUN.Platform.Domain.Shared/LINGYUN/Platform/Messages/MessageStatus.cs) - [RealtimeMessageMigrationsDbContext.cs](file://aspnet-core/migrations/LY.MicroService.RealtimeMessage.EntityFrameworkCore/RealtimeMessageMigrationsDbContext.cs) - [TaskManagementMigrationsDbContext.cs](file://aspnet-core/migrations/LY.MicroService.TaskManagement.EntityFrameworkCore/TaskManagementMigrationsDbContext.cs)

目录

  1. 简介
  2. 核心实体模型
  3. 身份管理模块
  4. 平台服务模块
  5. 实时消息模块
  6. 任务管理模块
  7. 领域驱动设计应用
  8. 实体扩展与自定义指导
  9. 数据库ER图
  10. 结论

简介

本文档全面介绍ABP Next Admin项目中各核心模块的实体关系模型。项目基于ABP框架构建，采用领域驱动设计（DDD）原则，实现了身份管理、平台服务、实时消息和任务管理等核心功能模块。数据模型设计遵循模块化、可扩展和高内聚低耦合的原则，通过实体类型信息管理实现了灵活的数据保护和审计机制。

核心实体模型

项目中的核心实体模型主要围绕数据保护管理模块构建，通过EntityTypeInfo和EntityPropertyInfo两个核心实体实现了对系统中所有实体类型的元数据管理。

EntityTypeInfo实体作为实体类型信息的聚合根，负责管理实体的基本信息和属性集合。该实体继承自AuditedAggregateRoot<Guid>，具备完整的审计功能，包括创建人、创建时间、最后修改人和最后修改时间等字段。

EntityPropertyInfo实体表示实体的属性信息，与EntityTypeInfo形成一对多关系。每个属性包含名称、显示名称、类型全名、JavaScript类型等元数据信息，并通过Enums集合支持枚举值定义。

erDiagram
EntityTypeInfo {
uuid Id PK
string Name
string DisplayName
string TypeFullName
boolean IsAuditEnabled
timestamp CreationTime
uuid CreatorId
timestamp LastModificationTime
uuid LastModifierId
}
EntityPropertyInfo {
uuid Id PK
uuid TypeInfoId FK
string Name
string DisplayName
string TypeFullName
string JavaScriptType
}
EntityTypeInfo ||--o{ EntityPropertyInfo : "包含"

图源

  • EntityTypeInfo.cs
  • EntityPropertyInfo.cs

本节源

  • EntityTypeInfo.cs
  • EntityPropertyInfo.cs

身份管理模块

身份管理模块主要负责用户身份认证、会话管理和安全控制。核心实体为IdentitySession，用于跟踪用户的登录会话信息。

IdentitySession实体记录了用户的会话ID、设备信息、用户ID、客户端ID、IP地址、登录时间和最后访问时间等关键信息。该实体通过UserId外键与用户实体关联，实现了对用户会话的完整追踪。

erDiagram
IdentitySession {
uuid Id PK
string SessionId
string Device
string DeviceInfo
uuid UserId FK
string ClientId
string IpAddresses
datetime SignedIn
datetime LastAccessed
}
User {
uuid Id PK
string UserName
string Email
string PhoneNumber
}
IdentitySession }o--|| User : "属于"

图源

  • IdentitySessionDto.cs

本节源

  • IdentitySessionDto.cs

平台服务模块

平台服务模块提供了消息服务、通知和通用平台功能。核心实体为MessageEto，作为消息事件的基类，定义了消息的基本结构。

MessageEto是一个抽象实体，包含消息ID、用户ID、发送者、创建时间、创建人ID和消息状态等通用属性。消息状态通过MessageStatus枚举定义，包含待发送、已发送和发送失败三种状态。

erDiagram
MessageEto {
uuid Id PK
uuid UserId FK
string Sender
datetime CreationTime
uuid CreatorId
int Status
}
MessageStatus {
int Value PK
string Description
}
MessageEto }o--|| MessageStatus : "状态"

图源

  • MessageEto.cs
  • MessageStatus.cs

本节源

  • MessageEto.cs
  • MessageStatus.cs

实时消息模块

实时消息模块基于ABP框架的通知和消息服务功能构建，支持实时通信和消息推送。该模块通过RealtimeMessageMigrationsDbContext管理数据模型。

RealtimeMessageMigrationsDbContext继承自AbpDbContext，配置了通知、消息服务和通知定义的实体模型。该上下文通过OnModelCreating方法调用ConfigureNotifications、ConfigureNotificationsDefinition和ConfigureMessageService扩展方法，实现了对相关实体的配置。

erDiagram
RealtimeMessageMigrationsDbContext {
DbContextOptions Options
}
NotificationDefinition {
string Name PK
string DisplayName
string Description
}
Notification {
uuid Id PK
string NotificationName
string Data
datetime CreationTime
}
UserNotification {
uuid Id PK
uuid UserId
uuid NotificationId
int State
}
RealtimeMessageMigrationsDbContext }|--|> NotificationDefinition : "配置"
RealtimeMessageMigrationsDbContext }|--|> Notification : "配置"
RealtimeMessageMigrationsDbContext }|--|> UserNotification : "配置"

图源

  • RealtimeMessageMigrationsDbContext.cs

本节源

  • RealtimeMessageMigrationsDbContext.cs

任务管理模块

任务管理模块负责后台任务的调度和执行。该模块通过TaskManagementMigrationsDbContext管理任务相关的数据模型。

TaskManagementMigrationsDbContext继承自AbpDbContext，在OnModelCreating方法中通过ConfigureTaskManagement扩展方法配置任务管理相关的实体模型。该设计模式实现了关注点分离，将任务管理的实体配置逻辑封装在独立的扩展方法中。

erDiagram
TaskManagementMigrationsDbContext {
DbContextOptions Options
}
TaskInfo {
uuid Id PK
string Name
string JobName
string CronExpression
datetime NextRunTime
int Status
}
TaskLog {
uuid Id PK
uuid TaskId FK
datetime ExecutionTime
int Duration
string Result
}
TaskManagementMigrationsDbContext }|--|> TaskInfo : "配置"
TaskManagementMigrationsDbContext }|--|> TaskLog : "配置"

图源

  • TaskManagementMigrationsDbContext.cs

本节源

  • TaskManagementMigrationsDbContext.cs

领域驱动设计应用

本项目在数据模型设计中充分应用了领域驱动设计（DDD）原则，主要体现在以下几个方面：

  1. 聚合根设计：EntityTypeInfo作为聚合根，管理EntityPropertyInfo和EntityEnumInfo等子实体，确保了业务规则的一致性和完整性。

  2. 值对象应用：通过EntityPropertyInfo和EntityEnumInfo等实体，将复杂的业务概念分解为可重用的值对象，提高了代码的可维护性。

  3. 领域服务：EntityTypeInfo类中定义了AddProperty、RemoveProperty等业务方法，封装了领域逻辑，确保了业务规则的正确执行。

  4. 仓储模式：通过IEntityTypeInfoRepository接口定义了对EntityTypeInfo实体的访问契约，实现了数据访问逻辑与业务逻辑的分离。

  5. 事件驱动架构：通过RealTimeEto<T>等事件传输对象，实现了模块间的松耦合通信，支持了系统的可扩展性。

实体扩展与自定义指导

为支持实体的扩展和自定义，项目提供了以下指导原则：

  1. 继承扩展：对于需要扩展的实体，建议通过继承方式创建子类，保持原有实体的完整性。

  2. 接口实现：通过实现特定接口（如IEntityTypeInfoRepository）来扩展实体的功能，遵循依赖倒置原则。

  3. 配置扩展：利用AbpModelBuilderConfigurationOptions等配置类，通过扩展方法模式实现实体模型的可配置性。

  4. 事件订阅：通过订阅领域事件（如RealTimeEto<T>）来实现业务逻辑的扩展，避免直接修改核心实体。

  5. 元数据管理：利用EntityTypeInfo和EntityPropertyInfo的元数据管理能力，实现动态属性的添加和管理。

数据库ER图

以下是项目核心实体的综合ER图：

erDiagram
EntityTypeInfo {
uuid Id PK
string Name
string DisplayName
string TypeFullName
boolean IsAuditEnabled
timestamp CreationTime
uuid CreatorId
timestamp LastModificationTime
uuid LastModifierId
}
EntityPropertyInfo {
uuid Id PK
uuid TypeInfoId FK
string Name
string DisplayName
string TypeFullName
string JavaScriptType
}
IdentitySession {
uuid Id PK
string SessionId
string Device
string DeviceInfo
uuid UserId FK
string ClientId
string IpAddresses
datetime SignedIn
datetime LastAccessed
}
MessageEto {
uuid Id PK
uuid UserId FK
string Sender
datetime CreationTime
uuid CreatorId
int Status
}
TaskInfo {
uuid Id PK
string Name
string JobName
string CronExpression
datetime NextRunTime
int Status
}
EntityTypeInfo ||--o{ EntityPropertyInfo : "包含"
IdentitySession }o--|| User : "属于"
MessageEto }o--|| MessageStatus : "状态"
TaskInfo ||--o{ TaskLog : "包含"

图源

  • EntityTypeInfo.cs
  • EntityPropertyInfo.cs
  • IdentitySessionDto.cs
  • MessageEto.cs
  • MessageStatus.cs
  • TaskManagementMigrationsDbContext.cs

结论

本项目的数据模型设计充分体现了领域驱动设计的思想，通过合理的实体划分和关系设计，实现了高内聚、低耦合的系统架构。核心的元数据管理机制为系统的可扩展性和灵活性提供了坚实基础。各模块通过标准化的实体设计模式，确保了代码的一致性和可维护性。未来扩展时，建议遵循现有的设计模式和扩展指导原则，保持系统架构的统一性。