[Abp vNext 源码分析] - 2. 模块系统的变化

一、简要说明

本篇文章主要分析 Abp vNext 当中的模块系统，从类型构造层面上来看，Abp vNext 当中不再只是单纯的通过 AbpModuleManager 来管理其他的模块，它现在则是 IModuleManager 和 IModuleLoader 来协同工作，其他的代码逻辑并无太大变化。

Abp vNext 规定每个模块必须继承自 IAbpModule 接口，这样 vNext 系统在启动的时候才会扫描到相应的模块。与原来 Abp 框架一样，每个模块可以通过 DependsOnAttribute 特性来确定依赖关系，算法还是使用拓扑排序算法，来根据依赖性确定模块的加载顺序。(从最顶层的模块，依次加载，直到启动模块。)

640?wx_fmt=png

以我们的 Demo 项目为例，这里通过拓扑排序之后的依赖关系如上图，这样最开始执行的即 AbpDataModule 模块，然后再是 AbpAuditingModule 以此类推，直到我们的启动模块 DemoAppModule。

在 Abp vNext 当中，所有的组件库/第三方库都是以模块的形式呈现的，模块负责管理整个库的生命周期，包括注册组件，配置组件，销毁组件等。

在最开始的 Abp 框架当中，一个模块有 4 个生命周期，它们都是在抽象基类 AbpModule 当中定义的，分别是 预加载、初始化、初始化完成、销毁。前三个生命周期是依次执行的预加载->初始化->初始化完成，而最后一个销毁动作则是在程序终止的时候，通过 AbpModuleManager 遍历模块，调用其 ShutDown() 方法进行销毁动作。

640?wx_fmt=png

新的 Abp vNext 框架除了原有的四个生命周期以外，还抽象出了 IOnPreApplicationInitialization、IOnApplicationInitialization、IOnPostApplicationInitialization、IOnApplicationShutdown。从名字就可以看出来，新的四个生命周期是基于应用程序级别的，而不是模块级别。

这是什么意思呢？在 Abp vNext 框架当中，模块按照功能用途划分为两种类型的模块。第一种是 框架模块，它是框架的核心模块，比如缓存、EF Core 等基础设施就属于框架模块，其模块的逻辑与处理基本都在传统的三个生命周期进行处理。

在我们的 services.AddApplication（） 阶段就已经完成所有初始化，可以给 应用程序模块 提供服务。

第二种则是 应用程序模块，这种模块则是实现了特定的业务/功能，例如身份管理、租户管理等，而新增加的四个生命周期基本是为这种类型的模块服务的。

在代码和结构上来说，两者并没有区别，在这里仅仅是按用途进行了一次分类。单就模块系统来说，其基本的作用就类似于一个配置类，配置某种组件的各种参数和一些默认逻辑。

二、源码分析

2.1 模块系统的基础设施

模块的初始化动作是在 AbpApplicationBase 基类开始的，在该基类当中除了注入模块相关的基础设施以外。还定义了模块的初始化方法，即 LoadModules() 方法，在该方法内部是调用的 IModuleLoader 去执行具体的加载操作。

internal AbpApplicationBase(
    [NotNull] Type startupModuleType,
    [NotNull] IServiceCollection services,
    [CanBeNull] Action<AbpApplicationCreationOptions> optionsAction)
{
    Check.NotNull(startupModuleType, nameof(startupModuleType));
    Check.NotNull(services, nameof(services));


    StartupModuleType = startupModuleType;
    Services = services;

    services.TryAddObjectAccessor<IServiceProvider>();

var options = new AbpApplicationCreationOptions(services);
    optionsAction?.Invoke(options);


    services.AddSingleton<IAbpApplication>(this);
    services.AddSingleton<IModuleContainer>(this);

    services.AddCoreServices();

    services.AddCoreAbpServices(this, options);


    Modules = LoadModules(services, options);
}

private IReadOnlyList<IAbpModuleDescriptor> LoadModules(IServiceCollection services, AbpApplicationCreationOptions options)
{

return services
        .GetSingletonInstance<IModuleLoader>()
        .LoadModules(
            services,
            StartupModuleType,
            options.PlugInSources
        );
}

2.2 模块的初始化

进入 IModuleLoader 的默认实现 ModuleLoader，在它的 LoadModules() 方法中，基本逻辑如下：

扫描当前应用程序的所有模块类，并构建模块描述对象。
基于模块描述对象，使用拓扑排序算法来按照模块的依赖性进行排序。
排序完成之后，遍历排序完成的模块描述对象，依次执行它们的三个生命周期方法。

public IAbpModuleDescriptor[] LoadModules(
    IServiceCollection services,
    Type startupModuleType,
    PlugInSourceList plugInSources)
{

    Check.NotNull(services, nameof(services));
    Check.NotNull(startupModuleType, nameof(startupModuleType));
    Check.NotNull(plugInSources, nameof(plugInSources));


var modules = GetDescriptors(services, startupModuleType, plugInSources);


    modules = SortByDependency(modules, startupModuleType);


    ConfigureServices(modules, services);

return modules.ToArray();
}

在搜索模块类型的时候，是使用的 AbpModuleHelper 工具类提供的 .FindAllModuleTypes() 方法。该方法会将我们的启动模块传入，根据模块上面的 DependsOn() 标签递归构建 模块描述对象 的集合。

private List<IAbpModuleDescriptor> GetDescriptors(
    IServiceCollection services,
    Type startupModuleType,
    PlugInSourceList plugInSources)
{

var modules = new List<AbpModuleDescriptor>();


    FillModules(modules, services, startupModuleType, plugInSources);

    SetDependencies(modules);


return modules.Cast<IAbpModuleDescriptor>().ToList();
}

protected virtual void FillModules(
    List<AbpModuleDescriptor> modules,
    IServiceCollection services,
    Type startupModuleType,
    PlugInSourceList plugInSources)
{

foreach (var moduleType in AbpModuleHelper.FindAllModuleTypes(startupModuleType))
    {
        modules.Add(CreateModuleDescriptor(services, moduleType));
    }


}

走进 AbpModuleHelper 静态类，其代码与结构与原有的 Abp 框架类似，首先看下它的 FindAllModuleTypes() 方法，根据启动模块的类型递归查找所有的模块类型，并添加到一个集合当中。

public static List<Type> FindAllModuleTypes(Type startupModuleType)
{
var moduleTypes = new List<Type>();

    AddModuleAndDependenciesResursively(moduleTypes, startupModuleType);
return moduleTypes;
}

private static void AddModuleAndDependenciesResursively(List<Type> moduleTypes, Type moduleType)
{

    AbpModule.CheckAbpModuleType(moduleType);


if (moduleTypes.Contains(moduleType))
    {
return;
    }

    moduleTypes.Add(moduleType);


foreach (var dependedModuleType in FindDependedModuleTypes(moduleType))
{
        AddModuleAndDependenciesResursively(moduleTypes, dependedModuleType);
    }
}

public static List<Type> FindDependedModuleTypes(Type moduleType)
{
    AbpModule.CheckAbpModuleType(moduleType);

var dependencies = new List<Type>();


var dependencyDescriptors = moduleType
        .GetCustomAttributes()
        .OfType<IDependedTypesProvider>();


foreach (var descriptor in dependencyDescriptors)
    {

foreach (var dependedModuleType in descriptor.GetDependedTypes())
        {
            dependencies.AddIfNotContains(dependedModuleType);
        }
    }

return dependencies;
}

以上操作完成之后，我们就能获得一个平级的模块描述对象集合，我们如果要使用拓扑排序来重新针对这个集合进行排序，就需要知道每个模块的依赖项，根据 IAbpModuleDescriptor 的定义，我们可以看到它有一个 Dependencies 集合来存储它的依赖项。

public interface IAbpModuleDescriptor
{

    Type Type { get; }


    Assembly Assembly { get; }


    IAbpModule Instance { get; }


bool IsLoadedAsPlugIn { get; }


    IReadOnlyList<IAbpModuleDescriptor> Dependencies { get; }
}

而 SetDependencies(List<AbpModuleDescriptor> modules) 方法就是来设置每个模块的依赖项的，代码逻辑很简单。遍历之前的平级模块描述对象集合，根据当前模块的类型定义，找到其依赖项的类型定义。根据这个类型定义去平级的模块描述对象集合搜索，将搜索到的结果存储到当前的模块描述对象中的 Dependencies 属性当中。

protected virtual void SetDependencies(List<AbpModuleDescriptor> modules)
{

foreach (var module in modules)
    {
        SetDependencies(modules, module);
    }
}

protected virtual void SetDependencies(List<AbpModuleDescriptor> modules, AbpModuleDescriptor module)
{

foreach (var dependedModuleType in AbpModuleHelper.FindDependedModuleTypes(module.Type))
    {

var dependedModule = modules.FirstOrDefault(m => m.Type == dependedModuleType);
if (dependedModule == null)
        {
throw new AbpException("Could not find a depended module " + dependedModuleType.AssemblyQualifiedName + " for " + module.Type.AssemblyQualifiedName);
        }


        module.AddDependency(dependedModule);
    }
}

最后的拓扑排序就不在赘述，关于拓扑排序的算法，可以在我的这篇博文当中找到。

关于模块的最后操作，就是执行模块的三个生命周期方法了，这块代码在 ConfigureServices() 方法当中，没什么特别的的处理，遍历整个模块描述对象集合，依次执行几个方法就完了。

只是在这里的生命周期方法与之前的不一样了，这里会为每个方法传入一个服务上下文对象，主要是可以通过 IServiceCollection 来配置各个模块的参数，而不是原来的 Configuration 属性。

protected virtual void ConfigureServices(List<IAbpModuleDescriptor> modules, IServiceCollection services)
{

var context = new ServiceConfigurationContext(services);
    services.AddSingleton(context);

foreach (var module in modules)
    {
if (module.Instance is AbpModule abpModule)
        {
            abpModule.ServiceConfigurationContext = context;
        }
    }


foreach (var module in modules.Where(m => m.Instance is IPreConfigureServices))
    {
        ((IPreConfigureServices)module.Instance).PreConfigureServices(context);
    }


foreach (var module in modules)
    {
if (module.Instance is AbpModule abpModule)
        {
if (!abpModule.SkipAutoServiceRegistration)
            {
                services.AddAssembly(module.Type.Assembly);
            }
        }

        module.Instance.ConfigureServices(context);
    }


foreach (var module in modules.Where(m => m.Instance is IPostConfigureServices))
    {
        ((IPostConfigureServices)module.Instance).PostConfigureServices(context);
    }


foreach (var module in modules)
    {
if (module.Instance is AbpModule abpModule)
        {
            abpModule.ServiceConfigurationContext = null;
        }
    }
}

以上动作都是在 Startup 类当中的 ConfigureService() 方法中执行，你可能会奇怪，剩下的四个应用程序生命周期的方法在哪儿执行的呢？

这几个方法是被抽象成了 IModuleLifecycleContributor 类型，在前面的 AddCoreAbpService()方法的内部就被添加到了配置项里面。

internal static void AddCoreAbpServices(this IServiceCollection services,
    IAbpApplication abpApplication,
    AbpApplicationCreationOptions applicationCreationOptions)
{


    services.Configure<ModuleLifecycleOptions>(options =>
    {
        options.Contributors.Add<OnPreApplicationInitializationModuleLifecycleContributor>();
        options.Contributors.Add<OnApplicationInitializationModuleLifecycleContributor>();
        options.Contributors.Add<OnPostApplicationInitializationModuleLifecycleContributor>();
        options.Contributors.Add<OnApplicationShutdownModuleLifecycleContributor>();
    });
}

执行的话，则是在 Startup 类的 Configure() 方法当中，它会调用 AbpApplicationBase 基类的 InitializeModules() 方法，在该方法内部也是遍历所有的 Contributor (生命周期)，再将所有的模块对应的方法调用一次而已。

public void InitializeModules(ApplicationInitializationContext context)
{
    LogListOfModules();


foreach (var Contributor in _lifecycleContributors)
    {

foreach (var module in _moduleContainer.Modules)
        {
            Contributor.Initialize(context, module.Instance);
        }
    }

    _logger.LogInformation("Initialized all modules.");
}

这里操作可能有点看不懂，不是说调用模块的生命周期方法么，为啥还将实例传递给 Contributor 呢？我们找到一个 Contributor 的定义就知道了。

public class OnApplicationInitializationModuleLifecycleContributor : ModuleLifecycleContributorBase
{
public override void Initialize(ApplicationInitializationContext context, IAbpModule module)
{

        (module as IOnApplicationInitialization)?.OnApplicationInitialization(context);
    }
}