abp-next-admin2/docs/wiki/模块化设计/功能模块/功能模块.md

功能模块

**本文档中引用的文件** - [IdentityResourceAppService.cs](file://aspnet-core/modules/identityServer/LINGYUN.Abp.IdentityServer.Application/LINGYUN/Abp/IdentityServer/IdentityResources/IdentityResourceAppService.cs) - [IdentityResourceController.cs](file://aspnet-core/modules/identityServer/LINGYUN.Abp.IdentityServer.HttpApi/LINGYUN/Abp/IdentityServer/IdentityResources/IdentityResourceController.cs) - [IIdentityResourceAppService.cs](file://aspnet-core/modules/identityServer/LINGYUN.Abp.IdentityServer.Application.Contracts/LINGYUN/Abp/IdentityServer/IdentityResources/IIdentityResourceAppService.cs) - [IdentityResourceDto.cs](file://aspnet-core/modules/identityServer/LINGYUN.Abp.IdentityServer.Application.Contracts/LINGYUN/Abp/IdentityServer/IdentityResources/Dto/IdentityResourceDto.cs) - [MultiplePermissionManager.cs](file://aspnet-core/modules/permissions-management/LINGYUN.Abp.PermissionManagement.Application/LINGYUN/Abp/PermissionManagement/MultiplePermissionManager.cs) - [OrganizationUnitPermissionManagementProvider.cs](file://aspnet-core/modules/permissions-management/LINGYUN.Abp.PermissionManagement.Domain.OrganizationUnits/LINGYUN/Abp/PermissionManagement/OrganizationUnits/OrganizationUnitPermissionManagementProvider.cs) - [PermissionDefinitionAppService.cs](file://aspnet-core/modules/permissions-management/LINGYUN.Abp.PermissionManagement.Application/LINGYUN/Abp/PermissionManagement/Definitions/PermissionDefinitionAppService.cs) - [LocalizationManagementResource.cs](file://aspnet-core/modules/localization-management/LINGYUN.Abp.LocalizationManagement.Domain.Shared/LINGYUN/Abp/LocalizationManagement/Localization/LocalizationManagementResource.cs) - [LocalizationManagementFeatures.cs](file://aspnet-core/modules/localization-management/LINGYUN.Abp.LocalizationManagement.Domain.Shared/LINGYUN/Abp/LocalizationManagement/Features/LocalizationManagementFeatures.cs) - [JobDefinition.cs](file://aspnet-core/modules/task-management/LINGYUN.Abp.BackgroundTasks.Abstractions/LINGYUN/Abp/BackgroundTasks/JobDefinition.cs) - [IJobScheduler.cs](file://aspnet-core/modules/task-management/LINGYUN.Abp.BackgroundTasks/LINGYUN/Abp/BackgroundTasks/IJobScheduler.cs) - [JobActionStore.cs](file://aspnet-core/modules/task-management/LINGYUN.Abp.TaskManagement.Domain/LINGYUN/Abp/TaskManagement/JobActionStore.cs) - [VueVbenAdminSettingDefinitionProvider.cs](file://aspnet-core/modules/platform/LINGYUN.Platform.Settings.VueVbenAdmin/LINGYUN/Platform/Settings/VueVbenAdmin/VueVbenAdminSettingDefinitionProvider.cs) - [AbpUINavigationVueVbenAdminNavigationDefinitionProvider.cs](file://aspnet-core/modules/platform/LINGYUN.Abp.UI.Navigation.VueVbenAdmin/LINGYUN/Abp/UI/Navigation/VueVbenAdmin/AbpUINavigationVueVbenAdminNavigationDefinitionProvider.cs)

目录

1. 引言
2. 项目结构
3. 核心功能模块
4. 模块分层架构
5. 模块依赖关系
6. 模块注册与加载机制
7. 模块开发规范
8. 结论

引言

本项目是一个基于ABP框架的微服务管理平台，提供了身份管理、权限控制、本地化管理、任务调度等核心业务功能。系统采用模块化设计，每个功能模块都遵循统一的分层架构，包括Application、Domain、EntityFrameworkCore、HttpApi等层次。本文档将深入分析这些核心功能模块的设计与实现，为开发者提供详细的开发规范和指导。

项目结构

项目采用微服务架构，主要分为框架层、迁移层、模块层、服务层和网关层。模块层包含了各个独立的功能模块，如身份管理、权限管理、本地化管理、任务调度等。每个模块都遵循相同的分层结构，确保代码的一致性和可维护性。

graph TD
subgraph "框架层"
A[auditing]
B[authentication]
C[authorization]
D[cli]
E[cloud-aliyun]
F[cloud-tencent]
G[common]
H[console]
I[dapr]
J[data-protection]
K[dynamic-queryable]
L[elasticsearch]
M[entity-change]
N[exporter]
O[features]
P[localization]
Q[logging]
R[mvc]
S[navigation]
T[nexus]
U[open-api]
V[pushplus]
W[rules]
X[security]
Y[settings]
Z[telemetry]
AA[tenants]
AB[tui-juhe]
AC[wechat]
AD[wx-pusher]
end
subgraph "迁移层"
AE[LY.MicroService.Applications.Single.DbMigrator]
AF[LY.MicroService.Applications.Single.EntityFrameworkCore]
AG[LY.MicroService.AuthServer.DbMigrator]
AH[LY.MicroService.AuthServer.EntityFrameworkCore]
AI[LY.MicroService.BackendAdmin.DbMigrator]
AJ[LY.MicroService.BackendAdmin.EntityFrameworkCore]
AK[LY.MicroService.IdentityServer.DbMigrator]
AL[LY.MicroService.IdentityServer.EntityFrameworkCore]
AM[LY.MicroService.LocalizationManagement.DbMigrator]
AN[LY.MicroService.LocalizationManagement.EntityFrameworkCore]
AO[LY.MicroService.Platform.DbMigrator]
AP[LY.MicroService.Platform.EntityFrameworkCore]
AQ[LY.MicroService.RealtimeMessage.DbMigrator]
AR[LY.MicroService.RealtimeMessage.EntityFrameworkCore]
AS[LY.MicroService.TaskManagement.DbMigrator]
AT[LY.MicroService.TaskManagement.EntityFrameworkCore]
AU[LY.MicroService.WebhooksManagement.DbMigrator]
AV[LY.MicroService.WebhooksManagement.EntityFrameworkCore]
end
subgraph "模块层"
AW[account]
AX[auditing]
AY[caching-management]
AZ[data-protection]
BA[demo]
BB[elsa]
BC[feature-management]
BD[gdpr]
BE[identity]
BF[identityServer]
BG[localization-management]
BH[openIddict]
BI[oss-management]
BJ[permissions-management]
BK[platform]
BL[project]
BM[realtime-message]
BN[realtime-notifications]
BO[rules-management]
BP[saas]
BQ[settings]
BR[task-management]
BS[text-templating]
BT[webhooks]
end
subgraph "服务层"
BU[LY.MicroService.Applications.Single]
BV[LY.MicroService.AuthServer]
BW[LY.MicroService.AuthServer.HttpApi.Host]
BX[LY.MicroService.BackendAdmin.HttpApi.Host]
BY[LY.MicroService.IdentityServer]
BZ[LY.MicroService.IdentityServer.HttpApi.Host]
CA[LY.MicroService.LocalizationManagement.HttpApi.Host]
CB[LY.MicroService.PlatformManagement.HttpApi.Host]
CC[LY.MicroService.RealtimeMessage.HttpApi.Host]
CD[LY.MicroService.TaskManagement.HttpApi.Host]
CE[LY.MicroService.WebhooksManagement.HttpApi.Host]
CF[LY.MicroService.WechatManagement.HttpApi.Host]
CG[LY.MicroService.WorkflowManagement.HttpApi.Host]
CH[LY.MicroService.WorkflowManagement.Next.HttpApi.Host]
end
subgraph "网关层"
CI[internal]
CJ[web]
end
A --> BE
B --> BE
C --> BE
D --> BE
E --> BE
F --> BE
G --> BE
H --> BE
I --> BE
J --> BE
K --> BE
L --> BE
M --> BE
N --> BE
O --> BE
P --> BE
Q --> BE
R --> BE
S --> BE
T --> BE
U --> BE
V --> BE
W --> BE
X --> BE
Y --> BE
Z --> BE
AA --> BE
AB --> BE
AC --> BE
AD --> BE
AE --> BE
AF --> BE
AG --> BF
AH --> BF
AI --> BK
AJ --> BK
AK --> BF
AL --> BF
AM --> BG
AN --> BG
AO --> BK
AP --> BK
AQ --> BM
AR --> BM
AS --> BR
AT --> BR
AU --> BT
AV --> BT
AW --> BE
AX --> BE
AY --> BK
AZ --> BK
BA --> BE
BB --> BR
BC --> BE
BD --> BE
BE --> BU
BF --> BV
BG --> CA
BH --> BY
BI --> BK
BJ --> BE
BK --> CB
BL --> BE
BM --> CC
BN --> BE
BO --> BE
BP --> BE
BQ --> BE
BR --> CD
BS --> BE
BT --> CE
BU --> CI
BV --> CI
BW --> CI
BX --> CI
BY --> CI
BZ --> CI
CA --> CI
CB --> CI
CC --> CI
CD --> CI
CE --> CI
CF --> CI
CG --> CI
CH --> CI
CI --> CJ

图示来源

• 项目结构

核心功能模块

身份管理模块

身份管理模块负责用户、角色、身份标识和组织机构的管理。通过IdentityResourceAppService提供身份资源的增删改查功能，支持分页查询和权限验证。

classDiagram
class IdentityResourceAppService {
+GetAsync(Guid id) IdentityResourceDto
+GetListAsync(IdentityResourceGetByPagedDto input) PagedResultDto~IdentityResourceDto~
+CreateAsync(IdentityResourceCreateOrUpdateDto input) IdentityResourceDto
+UpdateAsync(Guid id, IdentityResourceCreateOrUpdateDto input) IdentityResourceDto
+DeleteAsync(Guid id) void
}
class IdentityResourceController {
+GetAsync(Guid id) IdentityResourceDto
+GetListAsync(IdentityResourceGetByPagedDto input) PagedResultDto~IdentityResourceDto~
+CreateAsync(IdentityResourceCreateOrUpdateDto input) IdentityResourceDto
+UpdateAsync(Guid id, IdentityResourceCreateOrUpdateDto input) IdentityResourceDto
+DeleteAsync(Guid id) void
}
class IIdentityResourceAppService {
+GetAsync(Guid id) IdentityResourceDto
+GetListAsync(IdentityResourceGetByPagedDto input) PagedResultDto~IdentityResourceDto~
+CreateAsync(IdentityResourceCreateOrUpdateDto input) IdentityResourceDto
+UpdateAsync(Guid id, IdentityResourceCreateOrUpdateDto input) IdentityResourceDto
+DeleteAsync(Guid id) void
}
class IdentityResourceDto {
+Name string
+DisplayName string
+Description string
+Enabled bool
+Required bool
+Emphasize bool
+ShowInDiscoveryDocument bool
+UserClaims IdentityResourceClaimDto[]
+Properties IdentityResourcePropertyDto[]
}
IdentityResourceAppService --> IIdentityResourceAppService : "实现"
IdentityResourceController --> IdentityResourceAppService : "依赖"

图示来源

• IdentityResourceAppService.cs
• IdentityResourceController.cs
• IIdentityResourceAppService.cs
• IdentityResourceDto.cs

权限控制模块

权限控制模块通过MultiplePermissionManager和OrganizationUnitPermissionManagementProvider实现多级权限管理。支持基于角色和用户的权限分配，以及组织机构的权限继承。

classDiagram
class MultiplePermissionManager {
+SetManyAsync(string providerName, string providerKey, IEnumerable~PermissionChangeState~ permissions) Task
}
class OrganizationUnitPermissionManagementProvider {
+GetPermissionAsync(string name, string providerName, string providerKey) Task~PermissionGrant~
+SetPermissionAsync(string name, string providerName, string providerKey, bool value) Task
+GetAllPermissionsAsync(string providerName, string providerKey) Task~IEnumerable~PermissionGrant~~
}
class PermissionDefinitionAppService {
+CreateAsync(PermissionDefinitionCreateDto input) PermissionDefinitionDto
+UpdateAsync(Guid id, PermissionDefinitionUpdateDto input) PermissionDefinitionDto
+DeleteAsync(Guid id) void
+GetAsync(Guid id) PermissionDefinitionDto
+GetListAsync(PermissionDefinitionGetByPagedDto input) PagedResultDto~PermissionDefinitionDto~
}
MultiplePermissionManager --> OrganizationUnitPermissionManagementProvider : "依赖"
PermissionDefinitionAppService --> MultiplePermissionManager : "依赖"

图示来源

• MultiplePermissionManager.cs
• OrganizationUnitPermissionManagementProvider.cs
• PermissionDefinitionAppService.cs

本地化管理模块

本地化管理模块通过LocalizationManagementResource和LocalizationManagementFeatures实现多语言支持。支持资源、语言和文本的管理，以及本地化缓存配置。

classDiagram
class LocalizationManagementResource {
+LocalizationManagement
}
class LocalizationManagementFeatures {
+GroupName string
+Enable string
}
LocalizationManagementResource --> LocalizationManagementFeatures : "关联"

图示来源

• LocalizationManagementResource.cs
• LocalizationManagementFeatures.cs

任务调度模块

任务调度模块通过JobDefinition、IJobScheduler和JobActionStore实现后台任务的管理和调度。支持任务的定义、调度、执行和监控。

classDiagram
class JobDefinition {
+Name string
+JobType Type
+IsVisibleToClients bool
+DisplayName ILocalizableString
+Description ILocalizableString
+Paramters IReadOnlyList~JobDefinitionParamter~
}
class IJobScheduler {
+QueueAsync(JobInfo job) Task~bool~
+QueuesAsync(IEnumerable~JobInfo~ jobs) Task
+ExistsAsync(JobInfo job) Task~bool~
+TriggerAsync(JobInfo job) Task
+PauseAsync(JobInfo job) Task
}
class JobActionStore {
+GetActionsAsync(string id) Task~JobAction[]~
}
JobActionStore --> IJobScheduler : "依赖"
JobDefinition --> JobActionStore : "关联"

图示来源

• JobDefinition.cs
• IJobScheduler.cs
• JobActionStore.cs

模块分层架构

Application层

Application层负责业务逻辑的编排和协调，提供应用服务接口和实现。每个模块都有独立的Application和Application.Contracts子模块，分别负责服务实现和接口定义。

Domain层

Domain层包含领域模型和领域服务，是业务逻辑的核心。包括Domain、Domain.Shared和EntityFrameworkCore子模块，分别负责领域实体、共享定义和数据访问。

EntityFrameworkCore层

EntityFrameworkCore层负责数据持久化，通过Entity Framework Core实现数据库操作。包含数据迁移、仓储实现和数据库上下文定义。

HttpApi层

HttpApi层提供HTTP API接口，将应用服务暴露为RESTful API。通过控制器实现API端点，支持远程服务调用和区域化路由。

模块依赖关系

模块之间通过依赖注入和接口调用建立关系。核心模块如身份管理、权限控制等被其他模块广泛依赖。框架层提供基础服务，被所有业务模块依赖。迁移层负责数据库迁移，依赖于各模块的EntityFrameworkCore层。

graph TD
A[框架层] --> B[身份管理]
A --> C[权限控制]
A --> D[本地化管理]
A --> E[任务调度]
B --> F[平台管理]
C --> F
D --> F
E --> F
B --> G[任务管理]
C --> G
D --> G
E --> G
B --> H[Webhooks管理]
C --> H
D --> H
E --> H
F --> I[服务层]
G --> I
H --> I
I --> J[网关层]

图示来源

• 项目结构

模块注册与加载机制

模块通过ABP框架的模块系统进行注册和加载。每个模块都有一个Module类，通过[DependsOn]特性声明依赖关系。在应用程序启动时，框架按依赖顺序加载模块，完成服务注册和配置初始化。

sequenceDiagram
participant A as 应用程序启动
participant B as 模块加载器
participant C as 模块A
participant D as 模块B
participant E as 模块C
A->>B : 启动应用程序
B->>B : 解析模块依赖
B->>C : 加载模块C
C->>C : 执行PreConfigureServices
C->>C : 执行ConfigureServices
B->>D : 加载模块B
D->>D : 执行PreConfigureServices
D->>D : 执行ConfigureServices
B->>E : 加载模块A
E->>E : 执行PreConfigureServices
E->>E : 执行ConfigureServices
B->>A : 完成模块加载
A->>A : 启动HTTP服务器

图示来源

• 项目结构

模块开发规范

代码组织

每个功能模块应包含以下子模块：

• Application: 应用服务实现
• Application.Contracts: 应用服务接口
• Domain: 领域模型和领域服务
• Domain.Shared: 共享定义
• EntityFrameworkCore: 数据访问实现
• HttpApi: HTTP API接口
• HttpApi.Client: API客户端代理

接口设计

应用服务接口应继承ICrudAppService或自定义接口，遵循RESTful设计原则。DTO对象用于数据传输，包含必要的验证属性。

异常处理

使用ABP框架的异常处理机制，通过UserFriendlyException提供用户友好的错误信息。自定义错误码通过ErrorCodes类定义，确保全局唯一。

测试策略

每个模块应包含单元测试和集成测试。