ABP学习实践(十二)--模块系统

模块Module是ABP框架体系很重要的概念，不同的功能组件包括项目之间都是以模块的形式进行关联的。在ABP框架的启动过程中，模块的遍历、初始化、启动也是很重要的一环。

1.模块的定义

1.1定义

在ABP框架中定义了基类AbpModule，只要是继承自AbpModule的类就是模块。先来看看这个基类的定义。

namespace Abp.Modules
{public abstract class AbpModule{//获取对IOC管理器的引用protected internal IIocManager IocManager { get; internal set; }// 获取对ABP配置项的引用protected internal IAbpStartupConfiguration Configuration { get; internal set; }// 获取或设置日志public ILogger Logger { get; set; }protected AbpModule(){Logger = NullLogger.Instance;}// 预初始化public virtual void PreInitialize(){}// 初始化public virtual void Initialize(){}//初始化后public virtual void PostInitialize(){}// 关闭public virtual void Shutdown(){}public virtual Assembly[] GetAdditionalAssemblies(){return new Assembly[0];}// 检查是否为模块public static bool IsAbpModule(Type type){var typeInfo = type.GetTypeInfo();returntypeInfo.IsClass &&!typeInfo.IsAbstract &&!typeInfo.IsGenericType &&typeof(AbpModule).IsAssignableFrom(type);}// 查找依赖模块public static List<Type> FindDependedModuleTypes(Type moduleType){if (!IsAbpModule(moduleType)){throw new AbpInitializationException("This type is not an ABP module: " + moduleType.AssemblyQualifiedName);}var list = new List<Type>();if (moduleType.GetTypeInfo().IsDefined(typeof(DependsOnAttribute), true)){var dependsOnAttributes = moduleType.GetTypeInfo().GetCustomAttributes(typeof(DependsOnAttribute), true).Cast<DependsOnAttribute>();foreach (var dependsOnAttribute in dependsOnAttributes){foreach (var dependedModuleType in dependsOnAttribute.DependedModuleTypes){list.Add(dependedModuleType);}}}return list;}//根据给定的模块递归查找其所依赖的模块public static List<Type> FindDependedModuleTypesRecursivelyIncludingGivenModule(Type moduleType){var list = new List<Type>();AddModuleAndDependenciesRecursively(list, moduleType);list.AddIfNotContains(typeof(AbpKernelModule));return list;}//递归添加模块和依赖private static void AddModuleAndDependenciesRecursively(List<Type> modules, Type module){if (!IsAbpModule(module)){throw new AbpInitializationException("This type is not an ABP module: " + module.AssemblyQualifiedName);}if (modules.Contains(module)){return;}modules.Add(module);var dependedModules = FindDependedModuleTypes(module);foreach (var dependedModule in dependedModules){AddModuleAndDependenciesRecursively(modules, dependedModule);}}}
}

在AbpModule中可以看到其内部以接口形式定义了IoC管理器、模块配置项和日志组件，此外还有模块的生命周期事件和查找当前模块所依赖模块的方法。

1.2生命周期

在AbpModule可以看到模块的四个生命周期事件：

生命周期事件	说明
PreInitialize	预初始化：在初始化之前配置框架和其他模块。能够在依赖注入注册之前，在这个方法中指定需要注入的自定义启动类
Initialize	初始化：一般是来进行依赖注入的注册，常通过 IocManager.RegisterAssemblyByConvention 来实现
PostInitialize	初始化后：用来解析依赖关系
Shutdown	关闭：当应用关闭以后被调用

对于任意一个模块，这四个方法的执行顺序依次为PreInitialize–>Initialize–>PostInitialize–>Shutdown。

2.模块的依赖

2.1特性

ABP框架提供了DependsOn属性来显式说明模块间的依赖关系。可以看到DependsOn属性支持的是数组，所以一个模块可以依赖于多个模块。

namespace Abp.Modules
{[AttributeUsage(AttributeTargets.Class, AllowMultiple = true)]public class DependsOnAttribute : Attribute{public Type[] DependedModuleTypes { get; private set; }public DependsOnAttribute(params Type[] dependedModuleTypes){DependedModuleTypes = dependedModuleTypes;}}
}

再来看看示例解决方案中各模块的依赖关系。

//Web项目--呈现与分布式服务层
[DependsOn(typeof(AbpDemoApplicationModule), typeof(AbpDemoEntityFrameworkCoreModule), typeof(AbpAspNetCoreModule))]
public class AbpDemoWebModule : AbpModule
{//to do
}//EntityFrameworkCore项目--基础设施层
[DependsOn(typeof(AbpDemoCoreModule), typeof(AbpEntityFrameworkCoreModule))]
public class AbpDemoEntityFrameworkCoreModule : AbpModule
{// to do
}//Application项目--应用层
[DependsOn(typeof(AbpDemoCoreModule), typeof(AbpAutoMapperModule))]
public class AbpDemoApplicationModule : AbpModule
{// to do
}//Core项目--领域层
public class AbpDemoCoreModule : AbpModule
{// to do
}

3.模块的启动

3.1启动顺序

对于每个模块都用同样的生命周期事件，但是有多个模块而且这些模块互相之间存在依赖关系时，这些生命周期事件又该如何执行？对于这种情况，ABP框架作了清晰的定义：所有模块执行完PreInitialize预初始化方法后，所有模块再执行Initialize初始化方法，之后所有模块再执行PostInitialize初始化后方法。在ABP框架的启动过程中也遵循这一流程。
现在再回到AbpBootstrapper的Initialize初始化方法中，仔细查看模块启动的全过程。

   _moduleManager = IocManager.Resolve<AbpModuleManager>();_moduleManager.Initialize(StartupModule);_moduleManager.StartModules();

3.1.1 实例化模块管理器

在AbpBootstrapper的Initialize初始化方法中，首先是通过IocManager实例化一个模块管理器AbpModuleManager，模块管理器负责对程序中用到的模块进行管理。

3.1.2 初始化模块管理器

之后模块管理器开始对所有模块进行初始化。从下面的代码可以看出来，首先是实例化一个模块的集合AbpModuleCollection，这个模块的集合以启动模块xxxWebModule起点开始遍历。LoadAllModules就是遍历所有模块的方法。

 public virtual void Initialize(Type startupModule){_modules = new AbpModuleCollection(startupModule);LoadAllModules();}private void LoadAllModules(){Logger.Debug("Loading Abp modules...");List<Type> plugInModuleTypes;var moduleTypes = FindAllModuleTypes(out plugInModuleTypes).Distinct().ToList();Logger.Debug("Found " + moduleTypes.Count + " ABP modules in total.");//注册模块RegisterModules(moduleTypes);CreateModules(moduleTypes, plugInModuleTypes);//确保Kernel模块排在第一_modules.EnsureKernelModuleToBeFirst();//确保启动模块排在最后_modules.EnsureStartupModuleToBeLast();SetDependencies();Logger.DebugFormat("{0} modules loaded.", _modules.Count);}

在LoadAllModules方法中，除了遍历所有模块以及他们所依赖的模块外，还将这些模块进行了排序，确保AbpKernelModule这个核心模块能排在最前面首先启动，确保Web项目的启动模块xxxWebModule能排在最后。

3.1.3启动模块

启动模块的过程就是按照模块的排序，依照模块的生命周期顺序执行。首先是所有模块的预初始化，之后是所有模块的初始化，最后是所有模块的初始化后。

 public virtual void StartModules(){var sortedModules = _modules.GetSortedModuleListByDependency();sortedModules.ForEach(module => module.Instance.PreInitialize());//预初始化sortedModules.ForEach(module => module.Instance.Initialize());//初始化sortedModules.ForEach(module => module.Instance.PostInitialize());//初始化后}

3.2 AbpKernelModule

在所有模块启动的过程中，有一个要注意的是第一个预初始化的模块AbpKernelModule。这个模块的重要新从它的名称和排序上就能看出来。

public sealed class AbpKernelModule : AbpModule
{public override void PreInitialize(){//注册过滤器与基础组件IocManager.AddConventionalRegistrar(new BasicConventionalRegistrar());IocManager.Register<IScopedIocResolver, ScopedIocResolver>(DependencyLifeStyle.Transient);IocManager.Register(typeof(IAmbientScopeProvider<>), typeof(DataContextAmbientScopeProvider<>), DependencyLifeStyle.Transient);AddAuditingSelectors();AddLocalizationSources();AddSettingProviders();AddUnitOfWorkFilters();ConfigureCaches();AddIgnoredTypes();AddMethodParameterValidators();AddDefaultNotificationDistributor();}public override void Initialize(){//foreach (var replaceAction in ((AbpStartupConfiguration)Configuration).ServiceReplaceActions.Values){replaceAction();}IocManager.IocContainer.Install(new EventBusInstaller(IocManager));IocManager.Register(typeof(IOnlineClientManager<>), typeof(OnlineClientManager<>), DependencyLifeStyle.Singleton);IocManager.Register(typeof(IOnlineClientStore<>), typeof(InMemoryOnlineClientStore<>), DependencyLifeStyle.Singleton);IocManager.Register(typeof(EventTriggerAsyncBackgroundJob<>), DependencyLifeStyle.Transient);IocManager.RegisterAssemblyByConvention(typeof(AbpKernelModule).GetAssembly(),new ConventionalRegistrationConfig{InstallInstallers = false});}public override void PostInitialize(){RegisterMissingComponents();IocManager.Resolve<SettingDefinitionManager>().Initialize();IocManager.Resolve<FeatureManager>().Initialize();IocManager.Resolve<PermissionManager>().Initialize();IocManager.Resolve<LocalizationManager>().Initialize();IocManager.Resolve<NotificationDefinitionManager>().Initialize();IocManager.Resolve<NavigationManager>().Initialize();if (Configuration.BackgroundJobs.IsJobExecutionEnabled){var workerManager = IocManager.Resolve<IBackgroundWorkerManager>();workerManager.Start();workerManager.Add(IocManager.Resolve<IBackgroundJobManager>());}}}

从这个模块的实现代码就能看出来，ABP框架核心的处理都在这里进行了。