版本：Next

动态模块加载

本文档引用的文件

/lmes-template/src/CMS.Plugin.MyPluginName/CMSPluginEntry.cs
/lmes-template/src/CMS.Plugin.MyPluginName/CMSPluginModule.cs
/lmes-template/src/CMS.Plugin.MyPluginName.MySQL/CMSPluginMySQLModule.cs
/lmes-template/src/CMS.Plugin.MyPluginName.SqlServer/CMSPluginSqlServerModule.cs
/lmes-template/src/CMS.Plugin.MyPluginName.PostgreSql/CMSPluginPostgreSqlModule.cs
/lmes-template/src/CMS.Plugin.MyPluginName/appsettings.json
/lmes-template/src/CMS.Plugin.MyPluginName/CMS.Plugin.MyPluginName.csproj

简介

本文说明CMSPluginEntry如何作为插件入口点实现动态模块加载机制。重点分析其继承PluginEntry并重写Register方法的过程，以及如何通过IRegisteContext获取配置项中的DatabaseType，并基于此动态注入对应的数据库模块。该机制实现了运行时数据库适配器的选择与加载，为系统提供了灵活的数据持久化支持。

项目结构

本项目采用模块化分层架构设计，核心组件包括主插件模块、数据库特定模块和共享抽象层。项目通过独立的数据库模块（MySQL、SqlServer、PostgreSql）实现数据库无关性，各模块通过依赖注入和插件机制协同工作。

图示来源

/lmes-template/src/CMS.Plugin.MyPluginName/CMSPluginEntry.cs
/lmes-template/src/CMS.Plugin.MyPluginName/CMSPluginModule.cs
/lmes-template/src/CMS.Plugin.MyPluginName.MySQL/CMSPluginMySQLModule.cs
/lmes-template/src/CMS.Plugin.MyPluginName.SqlServer/CMSPluginSqlServerModule.cs
/lmes-template/src/CMS.Plugin.MyPluginName.PostgreSql/CMSPluginPostgreSqlModule.cs

本节来源

/lmes-template/src/CMS.Plugin.MyPluginName/CMSPluginEntry.cs
/lmes-template/src/CMS.Plugin.MyPluginName/CMS.Plugin.MyPluginName.csproj

核心组件

CMSPluginEntry作为插件系统的入口点，负责初始化和注册所有必要的服务与模块。它继承自PluginEntry基类，并通过重写Register方法实现自定义的模块注册逻辑。CMSPluginModule则是ABP框架的启动模块，定义了插件的依赖关系和配置。

本节来源

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

动态模块加载机制详解

CMSPluginEntry通过继承PluginEntry并重写Register方法实现动态模块加载。在Register方法中，系统首先获取配置上下文，然后根据配置中的DatabaseType值决定加载哪个数据库模块。

图示来源

/lmes-template/src/CMS.Plugin.MyPluginName/CMSPluginEntry.cs

本节来源

/lmes-template/src/CMS.Plugin.MyPluginName/CMSPluginEntry.cs

插件源注册流程分析

在AddApplication<CMSPluginModule>调用过程中，系统会根据配置动态注册相应的数据库模块。这一过程通过TypePlugInSource机制实现，允许在运行时将特定类型的模块注入到ABP模块系统中。

图示来源

/lmes-template/src/CMS.Plugin.MyPluginName/CMSPluginEntry.cs

本节来源

/lmes-template/src/CMS.Plugin.MyPluginName/CMSPluginEntry.cs

数据库适配器运行时选择机制

系统通过IRegisteContext获取配置项中的DatabaseType（mysql/sqlserver/postgresql），并基于此使用TypePlugInSource将对应的数据库模块注入到ABP模块系统中。这种设计实现了真正的运行时数据库适配器选择，无需重新编译代码即可切换数据库。

图示来源

/lmes-template/src/CMS.Plugin.MyPluginName/CMSPluginEntry.cs
/lmes-template/src/CMS.Plugin.MyPluginName.MySQL/CMSPluginMySQLModule.cs
/lmes-template/src/CMS.Plugin.MyPluginName.SqlServer/CMSPluginSqlServerModule.cs
/lmes-template/src/CMS.Plugin.MyPluginName.PostgreSql/CMSPluginPostgreSqlModule.cs

本节来源

/lmes-template/src/CMS.Plugin.MyPluginName/CMSPluginEntry.cs

配置示例

以下是在主配置文件中设置数据库类型的示例：

{
  "Database": {
    "DatabaseType": "mysql"
  },
  "IMyPluginNameExternalApi": {
    "HttpHost": "http://127.0.0.1:18000/"
  }
}

或者：

{
  "Database": {
    "DatabaseType": "sqlserver"
  },
  "IMyPluginNameExternalApi": {
    "HttpHost": "http://127.0.0.1:18000/"
  }
}

本节来源

/lmes-template/src/CMS.Plugin.MyPluginName/appsettings.json

常见问题排查

模块未正确加载

当遇到模块未正确加载的问题时，请检查以下几点：

确认配置文件中DatabaseType的值是否正确（mysql/sqlserver/postgresql）
检查对应数据库模块的项目引用是否存在于主项目文件中
验证TypePlugInSource中指定的模块类型是否正确

类型找不到异常

出现类型找不到异常时，应检查：

对应数据库模块的程序集是否已正确编译并部署
TypePlugInSource中使用的类型是否具有正确的命名空间和类名
项目文件中是否包含了对应数据库模块的ProjectReference

本节来源

/lmes-template/src/CMS.Plugin.MyPluginName/CMSPluginEntry.cs
/lmes-template/src/CMS.Plugin.MyPluginName/CMS.Plugin.MyPluginName.csproj

结论

CMSPluginEntry 继承 PluginEntry 并重写 Register，通过 IRegisteContext 读取 DatabaseType，再使用 TypePlugInSource 加载对应的数据库模块。

目录​

简介​

项目结构​

核心组件​

动态模块加载机制详解​

插件源注册流程分析​

数据库适配器运行时选择机制​

配置示例​

常见问题排查​

模块未正确加载​

类型找不到异常​

结论​

目录

简介

项目结构

核心组件

动态模块加载机制详解

插件源注册流程分析

数据库适配器运行时选择机制

配置示例

常见问题排查

模块未正确加载

类型找不到异常

结论