Fork me on GitHub

ABP源码分析四:Configuration

核心模块的配置

Configuration是ABP中设计比较巧妙的地方。其通过AbpStartupConfiguration,Castle的依赖注入,Dictionary对象和扩展方法很巧妙的实现了配置中心化。配置中心化是一个支持模块开发的框架必备功能。

 

ABP中核心功能模块中的一些功能的运行时的行为是依赖于一些外部配置的。这一点应该不难理解。 简单解释下,比如Localization这个功能模块,最基本Abp需要知道要做哪些语言的本地化。而这些具体的配置对于Abp底层框架来说是不可预知的,那么ABP底层框架就很有必要提供一种手段供外部模块自定义Congfiguration. 这就是下文要分析的IAbpStartupConfiguration和他的小伙伴们(各种I***Configuration)。 下图描述了这些Configuration之间的关系(稍后解释)。

(图一)

 

上面图中的都是接口,我们还需要知道这些接口的实例对象是在哪里生成的呢?

这要看回AbpBootstrapper的Initialize方法了(AbpBootstrapper在前面的文章已有介绍)。
首先,第一行通过AbpCoreInstaller注册的是系统框架级的所有configuration.
接着通过容器生成IAbpStartupConfiguration的实例AbpStartupConfiguration对象。
最后调用AbpStartupConfiguration的Initialize方法,该方法最终调用容器生成他的小伙伴的各种实例(****Configuration)。

(图二)

 

(图三)

 

ABP的作者为了方便管理,他把所有需要在ABP初始化阶段就要被实例化的接口都放到了Startup文件夹下(贴心啊!)。

 (图四)

 

至此,ABP核心功能组件的Configuration就已经完成实例化了, 此后需要调用或修改某个组件的Configuration,只要引用其IAbpStartupConfiguration的实例Configuration即可访问各个组件的Configuration了。如下图AbpModule下的Configuration其实就是AbpStartupConfiguration,是一个单例。而Localization就是AbpStartupConfiguration实例的一个小伙伴LocalizationConfiguration。通过它就可以配置本地化了。同样的逻辑也适合其他****Configuration。

 (图五)

 

 

自定义模块的配置

上面基本解释了Abp核心功能模块的配置的运作方式,接下来在分析下自定义module的Configuration 是如何实现的。下图描述了Abp中哪些原生Module会有自定义的configuration.(请注意箭头的方向,和第一张图中的箭头方向是相反的。)

 

Abp底层框架清楚有哪些核心功能模块,所以就很自然的给每个核心功能模块各自定义一个Configuration接口。但是Abp底层框架并不知道自定义的module有哪些,所以也就无法给每个自定义的module都创建一个Configuration接口。那么ABP底层框架是怎么管理每个自定义的module的Configuration的呢?

如果仔细观察图一的话,我们发现IAbpStartupConfiguration引用了一个IDictionaryBasedConfig的接口对象,IDictionaryBasedConfig的实现是DictionaryBasedConfig如下图。DictionaryBasedConfig下有个dictionary,这个就是最终保存自定义的module的Configuration的地方,因为Configuration的类型未知,所以dictionary的value是object类型。

 

下面以AbpWebModule为例讲一下自定义的module是如何实现Configuration。
第一步, 如下图, AbpWebModule定义了自己的接口IAbpWebModuleConfiguration和AbpWebModuleConfiguration,以及AbpConfigurationExtension

 

第二步, 如下图, 在AbpWebModule的preInitialize方法中将接口IAbpWebModuleConfiguration和其实现AbpWebModuleConfiguration注册到容器中。

 

第三步, 如下图, 看下AbpConfigurationExtension的实现。这是一个扩展方法,扩展了IModuleConfigurations接口,这个接口是在Abp底层框架中定义和实现的。其属性AbpConfiguration就是AbpStartupConfiguration实例。通过AbpStartupConfiguration的getorCreate方法(具体通过DictionaryBasedConfig来实现)就可以获取到AbpWebModule自定义的AbpWebModuleConfiguration的实例了。

 

具体访问方式如下,Configuration.Modules就是IModuleConfigurations的实例。通过其扩展方法AbpWeb访问AbpWebModuleConfiguration

Configuration.Modules.AbpWeb.SendAllExceptionsToClients=True;

 

最后这张图列出了AbpStartupConfiguration的所有可访问的configuration。

返回ABP源码分析系列文章目录

posted @ 2016-03-17 15:00 ZHK的博客 阅读(...) 评论(...) 编辑 收藏