跳到主要内容
版本：Next

模块扩展配置

本文档引用的文件

  • /lmes-template/src/CMS.Plugin.MyPluginName.Domain.Shared/CMSPluginModuleExtensionConfigurator.cs
  • /lmes-template/src/CMS.Plugin.MyPluginName.EntityFrameworkCore/CMSPluginEfCoreEntityExtensionMappings.cs
  • /lmes-template/src/CMS.Plugin.MyPluginName.Application.Contracts/CMSPluginDtoExtensions.cs
  • /lmes-template/src/CMS.Plugin.MyPluginName.EntityFrameworkCore/CMSPluginEntityFrameworkCoreModule.cs

目录​

  1. 引言
  2. 核心组件分析
  3. 模块扩展配置机制
  4. 现有属性配置
  5. 额外属性配置
  6. 配置执行保障机制
  7. 开发建议与迁移命令
  8. 总结

引言​

在ABP框架驱动的CMS插件架构中，模块扩展能力是实现灵活定制的核心机制之一。CMSPluginModuleExtensionConfigurator作为静态配置类，承担着对系统核心实体进行属性扩展和调整的关键职责。本文将深入解析该类在模块扩展中的作用机制，重点阐述其如何通过OneTimeRunner确保初始化配置的幂等性执行，以及ConfigureExistingProperties和ConfigureExtraProperties方法的具体应用场景、技术实现与潜在风险。

核心组件分析​

CMSPluginModuleExtensionConfigurator位于CMS.Plugin.MyPluginName.Domain.Shared项目中，是整个插件模块扩展配置的中枢。该类通过调用ABP框架提供的ObjectExtensionManager，实现了对身份认证模块（如用户、角色实体）等现有系统实体的非侵入式扩展。

Section sources

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

模块扩展配置机制​

模块扩展配置遵循分层设计原则，将配置逻辑与数据映射分离。CMSPluginModuleExtensionConfigurator负责定义扩展属性的元数据（如名称、类型、验证规则），而CMSPluginEfCoreEntityExtensionMappings则负责将这些元数据映射到数据库层面的具体字段。

Diagram sources

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

现有属性配置​

ConfigureExistingProperties方法提供了修改系统预定义实体属性长度限制的能力。

使用场景​

当标准的实体属性长度（如用户名、角色名）无法满足特定业务需求时，可通过此方法进行调整。例如：

IdentityUserConsts.MaxNameLength = 99;
IdentityRoleConsts.MaxNameLength = 99;

风险提示​

  • 数据兼容性风险：修改长度限制可能导致与现有数据或第三方系统不兼容。
  • 升级冲突风险：框架升级时，常量值的变更可能引发冲突。
  • 维护复杂性：过度自定义会增加系统维护难度和升级成本。

Section sources

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

额外属性配置​

ConfigureExtraProperties方法利用ABP的ObjectExtensionManager为现有模块实体添加额外属性。

配置流程​

  1. 获取模块配置入口：通过ObjectExtensionManager.Instance.Modules().ConfigureIdentity()进入身份模块配置。
  2. 选择目标实体：使用identity.ConfigureUser()指定对用户实体进行扩展。
  3. 定义新属性：调用AddOrUpdateProperty<T>方法添加新属性。

属性定义示例​

以添加“社保号码”（SocialSecurityNumber）为例：

  • 属性类型：string
  • 属性名称：SocialSecurityNumber
  • 验证规则：
    • RequiredAttribute：标记为必填项
    • StringLengthAttribute(64) {MinimumLength = 4}：长度限制为4-64字符
  • 可编辑性配置：通过Configuration[IdentityModuleExtensionConsts.ConfigurationNames.AllowUserToEdit] = true允许用户编辑

应用范围​

此机制不仅适用于用户实体，还可用于角色、组织单位等任何支持扩展的实体。

Section sources

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

配置执行保障机制​

为确保配置初始化仅执行一次，系统采用了双重保障机制。

OneTimeRunner模式​

CMSPluginModuleExtensionConfigurator内部使用OneTimeRunner静态实例，确保Configure()方法的幂等性执行。即使在多线程环境下，也只会执行一次配置逻辑。

执行时序​

配置在模块启动的PreConfigureServices阶段被调用：

public override void PreConfigureServices(ServiceConfigurationContext context)
{
    CMSPluginEfCoreEntityExtensionMappings.Configure();
}

CMSPluginEfCoreEntityExtensionMappings.Configure()内部首先调用CMSPluginModuleExtensionConfigurator.Configure()，确保扩展定义先于EF Core映射配置。

Diagram sources

  • /lmes-template/src/CMS.Plugin.MyPluginName.Domain.Shared/CMSPluginModuleExtensionConfigurator.cs
  • /lmes-template/src/CMS.Plugin.MyPluginName.EntityFrameworkCore/CMSPluginEfCoreEntityExtensionMappings.cs
  • /lmes-template/src/CMS.Plugin.MyPluginName.EntityFrameworkCore/CMSPluginEntityFrameworkCoreModule.cs

开发建议与迁移命令​

开发建议​

  1. 谨慎修改现有属性：除非绝对必要，否则应遵循ABP框架的标准配置。
  2. 合理命名扩展属性：使用清晰、无歧义的名称，避免与未来框架属性冲突。
  3. 充分测试验证规则：确保前端、后端验证逻辑一致。
  4. 文档化扩展内容：记录所有扩展属性及其业务含义。

EF Core迁移命令​

当添加了新的扩展属性后，必须执行EF Core迁移命令以更新数据库结构：

# 添加迁移
dotnet ef migrations add Added_SocialSecurityNumber_To_User

# 更新数据库
dotnet ef database update

这些命令将根据CMSPluginEfCoreEntityExtensionMappings中的配置，自动生成并执行相应的数据库变更脚本。

Section sources

  • /lmes-template/src/CMS.Plugin.MyPluginName.EntityFrameworkCore/CMSPluginEfCoreEntityExtensionMappings.cs

总结​

CMSPluginModuleExtensionConfigurator 使用 OneTimeRunner 控制配置只执行一次，并通过 ObjectExtensionManager 声明实体扩展属性。扩展配置和限制见前述示例。