跳到主要内容
版本：Next

模块依赖关系

本文档引用的文件

  • /lmes-template/src/CMS.Plugin.MyPluginName/CMSPluginModule.cs
  • /lmes-template/src/CMS.Plugin.MyPluginName.Abstractions/CMSPluginMyPluginNameAbstractionsModule.cs
  • /lmes-template/src/CMS.Plugin.MyPluginName.Application/CMSPluginApplicationModule.cs
  • /lmes-template/src/CMS.Plugin.MyPluginName.Application.Contracts/CMSPluginApplicationContractsModule.cs
  • /lmes-template/src/CMS.Plugin.MyPluginName.Domain/CMSPluginDomainModule.cs
  • /lmes-template/src/CMS.Plugin.MyPluginName.EntityFrameworkCore/CMSPluginEntityFrameworkCoreModule.cs
  • /lmes-template/src/CMS.Plugin.MyPluginName.Domain.Shared/CMSPluginDomainSharedModule.cs
  • /lmes-template/src/CMS.Plugin.MyPluginName.Domain.Shared/CMSPluginModuleExtensionConfigurator.cs
  • /lmes-template/src/CMS.Plugin.MyPluginName/CMSPluginEntry.cs
  • /lmes-template/src/CMS.Plugin.MyPluginName.Abstractions/CMSPluginMyPluginNameExtensions.cs

目录​

  1. 引言
  2. 模块依赖链分析
  3. 模块生命周期与执行阶段
  4. 服务注册与后台作业配置
  5. 程序集共享机制
  6. 模块扩展与配置
  7. 模块间解耦与接口暴露
  8. 常见模块注册问题与排查
  9. 结论

引言​

本文说明基于ABP框架的模块化依赖管理体系，重点解读CMSPluginModule类中[DependsOn]特性所声明的模块依赖链，说明各依赖模块的作用及其在启动过程中的加载顺序。结合ABP模块生命周期，阐述PreInitialize、Initialize、PostInitialize各阶段的执行逻辑，并解释模块间如何通过接口实现解耦与服务暴露。

模块依赖链分析​

CMSPluginModule作为插件的主启动模块，通过[DependsOn]特性声明了对多个核心模块的依赖，形成清晰的依赖链结构。这些依赖模块按加载顺序依次为：

  • CMSPluginAbpModule：基础ABP功能模块
  • CMSPluginAbpAspNetCoreModule：ASP.NET Core集成模块
  • CMSPluginApplicationModule：应用服务模块
  • CMSPluginEntityFrameworkCoreModule：EF Core数据访问模块

该依赖链确保了底层基础设施先于上层业务逻辑加载，保障了服务注册的正确顺序。

Section sources

  • /lmes-template/src/CMS.Plugin.MyPluginName/CMSPluginModule.cs

模块生命周期与执行阶段​

ABP框架定义了模块的三个核心生命周期阶段，各阶段执行逻辑如下：

PreInitialize 阶段​

在模块初始化前执行，主要用于预配置服务。例如：

  • CMSPluginDomainSharedModule在此阶段调用CMSPluginModuleExtensionConfigurator.Configure()进行扩展配置
  • CMSPluginApplicationContractsModule调用CMSPluginDtoExtensions.Configure()配置DTO映射

Initialize 阶段​

模块初始化阶段，主要进行服务注册和配置。例如：

  • CMSPluginApplicationModule注册AutoMapper服务
  • CMSPluginEntityFrameworkCoreModule配置实体扩展映射

PostInitialize 阶段​

模块初始化完成后执行，用于处理跨模块依赖或启动后台任务。例如：

  • CMSPluginEntry在AfterReadyAsync中注册MyPluginNameWorker后台工作器

Diagram sources

  • /lmes-template/src/CMS.Plugin.MyPluginName.Domain.Shared/CMSPluginDomainSharedModule.cs
  • /lmes-template/src/CMS.Plugin.MyPluginName.Application/CMSPluginApplicationModule.cs
  • /lmes-template/src/CMS.Plugin.MyPluginName.EntityFrameworkCore/CMSPluginEntityFrameworkCoreModule.cs
  • /lmes-template/src/CMS.Plugin.MyPluginName/CMSPluginEntry.cs

Section sources

  • /lmes-template/src/CMS.Plugin.MyPluginName.Domain.Shared/CMSPluginDomainSharedModule.cs
  • /lmes-template/src/CMS.Plugin.MyPluginName.Application/CMSPluginApplicationModule.cs
  • /lmes-template/src/CMS.Plugin.MyPluginName.EntityFrameworkCore/CMSPluginEntityFrameworkCoreModule.cs

服务注册与后台作业配置​

CMSPluginModule继承自AbpStartupModule，通过重写ConfigureServices方法实现服务注册。其中关键配置为后台作业的注册：

Configure<AbpBackgroundJobOptions>(options =>
{
    options.AddJob<MyPluginNameJob>();
});

此配置将MyPluginNameJob添加到后台作业调度系统中，使其能够在应用运行时被触发执行。MyPluginNameJob通过依赖注入获取IMyEntityNameRepository等服务，实现定时数据处理任务。

Section sources

  • /lmes-template/src/CMS.Plugin.MyPluginName/CMSPluginModule.cs

程序集共享机制​

GetSharedAssemblies方法用于指定需要共享的程序集，以便其他模块能够访问当前模块的类型。在CMSPluginModule中：

public override Assembly[]? GetSharedAssemblies()
{
    return base.GetSharedAssemblies().Concat(new[]
    {
        typeof(CMSPluginMyPluginNameAbstractionsModule).Assembly,
    }).ToArray();
}

此机制允许其他模块引用CMS.Plugin.MyPluginName.Abstractions程序集中的接口和DTO类型，实现跨模块类型传递和解耦。特别是对于IMyPluginNameFlowService等服务接口的暴露至关重要。

Section sources

  • /lmes-template/src/CMS.Plugin.MyPluginName/CMSPluginModule.cs
  • /lmes-template/src/CMS.Plugin.MyPluginName.Abstractions/CMSPluginMyPluginNameAbstractionsModule.cs

模块扩展与配置​

CMSPluginModuleExtensionConfigurator是模块扩展配置的核心组件，提供静态方法Configure()用于一次性运行扩展配置。其主要功能包括：

  • ConfigureExistingProperties：修改已有实体属性的配置（如最大长度）
  • ConfigureExtraProperties：为现有实体添加扩展属性，支持通过ObjectExtensionManager动态添加字段

该配置器在CMSPluginDomainSharedModule的PreConfigureServices阶段被调用，确保扩展配置在模块初始化前完成。

Diagram sources

  • /lmes-template/src/CMS.Plugin.MyPluginName.Domain.Shared/CMSPluginModuleExtensionConfigurator.cs
  • /lmes-template/src/CMS.Plugin.MyPluginName.Domain.Shared/CMSPluginDomainSharedModule.cs

Section sources

  • /lmes-template/src/CMS.Plugin.MyPluginName.Domain.Shared/CMSPluginModuleExtensionConfigurator.cs
  • /lmes-template/src/CMS.Plugin.MyPluginName.Domain.Shared/CMSPluginDomainSharedModule.cs

模块间解耦与接口暴露​

本系统通过分层架构实现模块间解耦：

  • Application.Contracts：定义服务接口（如IMyEntityNameAppService），供外部调用
  • Abstractions：定义领域服务接口（如IMyPluginNameFlowService），供其他模块实现
  • Domain：包含实体和仓储接口，不依赖具体实现
  • EntityFrameworkCore：实现数据访问，依赖Domain层

这种设计使得上层模块仅依赖接口而非具体实现，支持灵活替换和单元测试。

Diagram sources

  • /lmes-template/src/CMS.Plugin.MyPluginName.Abstractions/IMyPluginNameFlowService.cs
  • /lmes-template/src/CMS.Plugin.MyPluginName.Application.Contracts/Services/IMyEntityNameAppService.cs
  • /lmes-template/src/CMS.Plugin.MyPluginName.Domain/MyEntityNames/IMyEntityNameRepository.cs

常见模块注册问题与排查​

循环依赖​

当模块A依赖B，B又依赖A时发生。排查方法：

  • 检查[DependsOn]特性声明
  • 使用ABP模块依赖图分析工具

程序集未加载​

原因可能包括：

  • 插件未正确注册（CMSPluginEntry中未添加TypePlugInSource）
  • 程序集路径错误或文件缺失
  • 依赖的NuGet包未正确引用

配置未生效​

常见原因：

  • 生命周期阶段错误（如应在PreConfigureServices却放在ConfigureServices）
  • OneTimeRunner未正确执行
  • 配置代码被条件编译排除

Section sources

  • /lmes-template/src/CMS.Plugin.MyPluginName/CMSPluginEntry.cs
  • /lmes-template/src/CMS.Plugin.MyPluginName.Abstractions/CMSPluginMyPluginNameExtensions.cs

结论​

本系统基于ABP框架构建了清晰的模块化依赖管理体系。通过[DependsOn]特性明确模块依赖关系，利用模块生命周期各阶段完成不同配置任务，通过程序集共享机制实现跨模块类型访问。CMSPluginModuleExtensionConfigurator提供了灵活的扩展配置能力，而分层架构确保了模块间的良好解耦。开发者在扩展新功能时，应遵循此模式，注意避免循环依赖，确保程序集正确加载，并合理使用生命周期事件。