>依賴註入實現了系統之間、模塊之間和對象之間依賴關係的解耦,基本上是現代應用程式框架必不可少的一個組成部分。 > >ABP的依賴註入系統是基於Microsoft的依賴註入擴展庫(Microsoft.Extensions.DependencyInjection),所以能夠完全相容.net Core中的 ...
依賴註入實現了系統之間、模塊之間和對象之間依賴關係的解耦,基本上是現代應用程式框架必不可少的一個組成部分。
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>()
是關鍵。
可以看到,這裡向集合中添加了預設預定註冊器,並且通過規則進行依賴註入註冊。那麼規則註冊器是如何查找程式集中的類,並且註冊依賴關係的呢?
這裡就看到了上面提到的三個介面了,但是從這裡可以看出,這三個介面只是提供了生命周期的信息,但是依賴註入的註冊,除了生命周期,還有類與介面的對應關係。
通過對DefaultConventionalRegistrar
、ConventionalRegistrarBase
、ExposedServiceExplorer
、ExposeServicesAttribute
代碼的查看,可以明白Abp預設的依賴關係註冊是怎麼樣的,以及它是怎麼實現的。
預設規則註冊:
1)實現了ITransientDependency等三個介面的公開、非泛型類,會被註冊到容器中。
2)如果這個類實現了其他介面,並且這個介面和類之間的命名符合規則,介面和類的關係會被註冊到容器中。
例如
public class BookRepository: IRepository, IBookRepository, IBookStore, ITransientDependency
{
}
上面的代碼中,BookRepository
在容器中是可以找到三個依賴關係配置的。
除了預設規則註冊之外,Abp還在其他模塊中提供了其他的註冊規則,如Volo.Abp.AspNetCore.Mvc模塊中的AbpAspNetCoreMvcConventionalRegistrar
、Volo.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
,並且未設置IncludeDefaults
、IncludeSelf
的值的情況下,由於預設值的關係,這兩個值會是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 - 模塊載入機制