ABP – 依赖注入(1)

  • ABP – 依赖注入(1)已关闭评论
  • 178 次浏览
  • A+
所属分类:.NET技术
摘要

依赖注入实现了系统之间、模块之间和对象之间依赖关系的解耦,基本上是现代应用程序框架必不可少的一个组成部分。


依赖注入实现了系统之间、模块之间和对象之间依赖关系的解耦,基本上是现代应用程序框架必不可少的一个组成部分。

ABP的依赖注入系统是基于Microsoft的依赖注入扩展库(Microsoft.Extensions.DependencyInjection),所以能够完全兼容.net Core中的依赖注入的用法,同时使用 Autofac 替换了.net Core中的内部容器,利用了Autofac中的一些特性。

Abp依赖注入的配置方式

手动注册依赖注入关系

与Asp.Net Core在Startup类中的ConfigureServices()方法中,通过IServiceCollection向容器中添加依赖注入关系没有区别,在Abp框架中也完成兼容这种方式。

不过这些依赖关系的配置一般会在各自的模块中配置,而不是全部都写在Startup类中,这样使得各个模块之间更加独立,开箱即用。

[DependsOn(typeof(AbpAspNetCoreModule))] [DependsOn(typeof(SuncereAbpDataModule))] public class SuncereAbpFreeSqlModule : AbpModule {     public override void ConfigureServices(ServiceConfigurationContext context)     {         context.Services.AddFreeSql();     } } 

示例中的代码是我们项目中一个ORM模块的依赖注入配置,这是模块基于FreeSql这个ORM框架进行了一层分组,兼容了Abp的工作单元、默认仓储模式。上一篇文章中讲在Abp框架初始化时,会将容器对象在各个模块类中进行传递,context.Services 就是传递过来的IServiceCollection

按照约定自动注册

除了手动注册的方式之外,Abp框架依赖注入体系的很方便的一个点,就是提供了按照约定的自动依赖注入关系注册。最基本的,在只使用了Volo.Abp核心库的情况下,会将实现了特定接口的类进行注册,根据依赖注入的生命周期,Abp提供了三个接口。

• ITransientDependency 注册为transient生命周期. • ISingletonDependency 注册为singleton生命周期. • IScopedDependency 注册为scoped生命周期. 

这些接口,都是空接口,起到标记的作用。这种设计方式,在微软的代码和很多框架中都很常见。

通过对源码的研究,可以发现这其实是Abp提供了一个约定注册器接口IConventionalRegistrar,并且Abp提供了实现默认的实现。并且在Abp引擎初始化的时候,将所有的模块程序集遍历了一遍,将其中满足约定的类进行了依赖注入注册。

查看自动依赖注入源码的入口点,其实就在上篇文章中提到的Abp引擎初始化过程中,AbpApplicationBase构造函数中调用的AddCoreAbpServices()方法中,其中的services.AddAssemblyOf<IAbpApplication>()是关键。

ABP - 依赖注入(1)

可以看到,这里向集合中添加了默认预定注册器,并且通过规则进行依赖注入注册。那么规则注册器是如何查找程序集中的类,并且注册依赖关系的呢?

ABP - 依赖注入(1)

ABP - 依赖注入(1)

ABP - 依赖注入(1)

这里就看到了上面提到的三个接口了,但是从这里可以看出,这三个接口只是提供了生命周期的信息,但是依赖注入的注册,除了生命周期,还有类与接口的对应关系。

ABP - 依赖注入(1)

通过对DefaultConventionalRegistrarConventionalRegistrarBaseExposedServiceExplorerExposeServicesAttribute代码的查看,可以明白Abp默认的依赖关系注册是怎么样的,以及它是怎么实现的。

默认规则注册: 1)实现了ITransientDependency等三个接口的公开、非泛型类,会被注册到容器中。 2)如果这个类实现了其他接口,并且这个接口和类之间的命名符合规则,接口和类的关系会被注册到容器中。 

例如

public class BookRepository: IRepository, IBookRepository, IBookStore, ITransientDependency { } 

上面的代码中,BookRepository在容器中是可以找到三个依赖关系配置的。

除了默认规则注册之外,Abp还在其他模块中提供了其他的注册规则,如Volo.Abp.AspNetCore.Mvc模块中的AbpAspNetCoreMvcConventionalRegistrarVolo.Abp.AspNetCore.Components中的AbpWebAssemblyConventionalRegistrar等。

Abp框架固有的注册类型 一些特定类型会默认注册到依赖注入.例子: • 模块类注册为singleton. • MVC控制器(继承Controller或AbpController)被注册为transient. • MVC页面模型(继承PageModel或AbpPageModel)被注册为transient. • MVC视图组件(继承ViewComponent或AbpViewComponent)被注册为transient. • 应用程序服务(实现IApplicationService接口或继承ApplicationService类)注册为transient. • 存储库(实现IRepository接口)注册为transient. • 域服务(实现IDomainService接口)注册为transient. 

我们也可以通过实现自己的依赖注入注册规则,只需要实现IConventionalRegistrar接口,并在模块类中的PreConfigureServices()方法中将其添加到ConventionalRegistrarList中。

通过特性注册

从上面的源码中也可以看出,Abp框架也支持通过特性的方式声明依赖注入关系的,而且特性的声明方式会优先于默认约定的方式。

我们可以用 DependencyAttribute 声明依赖注入的生命周期和注入的方式,ExposeServicesAttribute 声明类和接口之间的对应关系。ExposeServicesAttribute 就是 IExposedServiceTypesProvider 的实现类。

特别注意的,在声明了ExposeServicesAttribute,并且未设置IncludeDefaultsIncludeSelf 的值的情况下,由于默认值的关系,这两个值会是false,即默认约定不起作用了,该类注册为ExposeServicesAttribute中指定的接口的实现。 当然ExposeServicesAttribute可以指定多个接口。

[Dependency(ServiceLifetime.Transient, ReplaceServices = true)] [ExposeServices(typeof(IBookRepository))] public class BookRepository: IRepository, IBookRepository, IBookStore { } 

泛型类的注册

通过源码可以知道,无论是按照约定自动注册,还是通过特性的方式进行注册,都是无法注册泛型类的依赖注入关系的,泛型类的依赖注入关系只能够通过手动注册的方式注入。

context.service.AddTransient<IRepository<,>, Repository<,>>(); 

通过以上方式可以注册泛型类的依赖注入关系,<> 中一个,表示该类有两个泛型类型。

以上是依赖注入配置部分的内容,这里拆成了两篇,避免文章太长大家阅读不适

ABP 系列总结:

目录:ABP 系列总结
上一篇:ABP - 模块加载机制