# 依賴註入的使用 ## 構造方法註入 這是將服務註入類的最常用方法,是將依賴項註入類的首選方式,也是微軟推崇的模式。這樣,除非提供了所有構造方法註入的依賴項,否則無法構造類,顯示的聲明瞭類必需的服務,使開發人員一目瞭然。 ```csharp public class BookAppService ...
依賴註入的使用
構造方法註入
這是將服務註入類的最常用方法,是將依賴項註入類的首選方式,也是微軟推崇的模式。這樣,除非提供了所有構造方法註入的依賴項,否則無法構造類,顯示的聲明瞭類必需的服務,使開發人員一目瞭然。
public class BookAppService : ApplicationService
{
private readonly IBookRepository _bookRepository;
public TaxAppService(IBookRepository bookRepository)
{
_bookRepository = bookRepository;
}
public void DoSomething()
{
//...使用 _bookRepository...
}
}
屬性註入
Microsoft依賴註入庫不支持屬性註入, 屬性註入是Abp框架使用autofac容器替換了微軟預設的容器之後才能使用的,屬於autofac的特性。
public class BookAppService : ITransientDependency
{
public ILogger<BookAppService> Logger { get; set; }
public BookAppService()
{
Logger = NullLogger<BookAppService>.Instance;
}
public void DoSomething()
{
//...使用 Logger 寫日誌...
}
}
屬性註入依賴項通常被視為可選依賴項.這意味著不是必須的,沒有它們服務也可以正常工作.Logger就是這樣的依賴項,BookAppService可以繼續工作而無需日誌記錄。為了使依賴項成為可選的,我們通常會為依賴項設置預設值。一般是介面的一個空實現,內部不做任何操作。
屬性註入的一個限制是你不能在構造函數中使用依賴項,因為它是在對象構造之後設置的.
從IServiceProvider解析服務
public class MyService : ITransientDependency
{
private readonly IServiceProvider _serviceProvider;
public MyService(IServiceProvider serviceProvider)
{
_serviceProvider = serviceProvider;
}
public void DoSomething()
{
using (var scope = _serviceProvider.CreateScope())
{
var service1 = scope.ServiceProvider.GetService<IMyService1>();
// …
}
}
}
通過GetService
、GetRequiredService
可以直接從容器中解析出我們需要的服務,這兩個方法有一定的區別,推薦使用GetRequiredService
方法。
這種情況下一般會使用using (var scope = _serviceProvider.CreateScope()){}
創建一個域,以便解析出來的服務能夠安全的被釋放,這也能夠減少一些記憶體消耗。
要註意的一個點是,在以前的ASP.NET Boilerplate 中服務的手動解析使用是通過IocManager
的,這是靜態類,通過IocManager.Instance
可以獲得容器對象,很方便使用。但是在現在的ABP中已經將這種方式移除了,以至於有時候在靜態類中需要使用一些服務的時候很不方便(雖然這種方式不是很正確,但是確實有時候會有這樣子的需求)。
所以在項目中如果真的有需要的話,可以自己構建一個類似於IocManager
的方式,但是不推薦這樣子用,因為在某些情況確實會存在一些問題,導致一些資源和生命周期的衝突,特別是在單元測試之中。
/// <summary>
/// ServiceManager構建一個單例,用於寄放IServiceProvider
/// 使用此類時,需要在應用啟動的時候,調用Init方法
/// 一般情況下不推薦使用
/// </summary>
public class ServiceManager
{
private ServiceManager()
{
}
public static IServiceProvider ServiceProvider { get; private set; }
public static void Init(IServiceProvider service)
{
ServiceProvider = service;
}
}
public override void OnApplicationInitialization(ApplicationInitializationContext context)
{
var app = context.GetApplicationBuilder();
// 保存全局Ioc
if (app != null)
{
ServiceManager.Init(app.ApplicationServices);
}
}
Autofac的使用
容器替換
Abp框架中使用autofac依賴註入框架替換了微軟預設的容器,在volo.abp.autofac模塊中按照模塊化設計的思想進行了稍微的封裝,提供了便捷的替換方式。
使用autofac替換預設容器的方式:
(1) 在startup類中的ConfigureServices()中,在添加Abp的依賴註入時,通過選項替換。
public IServiceProvider ConfigureServices(IServiceCollection services)
{
services.AddApplication<MyWebModule>(options =>
{
//Integrate Autofac!
options.UseAutofac();
});
return services.BuildServiceProviderFromFactory();
}
(2) 在program.cs中,在.net Core 主機(host)創建的時候,調用userAutofac()擴展方法。
internal static IHostBuilder CreateHostBuilder(string[] args) =>
Host.CreateDefaultBuilder(args)
.ConfigureWebHostDefaults(webBuilder =>
{
webBuilder.UseStartup<Startup>();
})
.UseAutofac();
攔截器與動態代理
Abp框架使用autofac替換微軟預設容器的目的,主要就是為了利用autofac的攔截器功能,這是一種動態aop的實現方式,可以動態的攔截往容器中註冊的類,做一些想要的操作。abp框架中的很多橫切關註點都是通過這種方式實現的,如許可權認證,審計等。
在模塊類的PreConfigureServices()
中,可以使用OnRegistred()
方法,註冊一個回調,每次有類向容器中註冊時,都會調用這個回調。在回調中,我們可以對當前註冊的類型進行判斷(一般通過介面、特性等),如果滿足我們的條件,就添加一個攔截器。
在我們調用useAutofac()
時,內部會調用UseServiceProviderFactory()
創建了一個AbpAutofacServiceProviderFactory
,這是實現了微軟IServiceProviderFactory<>
介面的一個容器工廠,任何容器提供了這個介面實現類,並且按照約定提供了ContainerBuilder
,都可以作為.net core中的依賴註入容器。
在.net Core應用程式啟動的時候會調用IServiceProviderFactory<>
介面的CreateBuilder(IServiceCollection services)
方法,我們註冊的回調函數就是在這個時候執行的。遍歷每一個類,在多個回調中進行執行,符合條件的都會添加一個攔截器。
最終是向autofac容器註冊攔截器。
攔截器類需要實現IAbpInterceptor
介面,或者繼承AbpInterceptor
,實現其中的InterceptAsync
方法。如果對某一個類配置了攔截器,實際上它在註冊到容器中時,abp會基於攔截器動態生成一個代理類,再將代理類註冊到autofac中。
動態代理是基於Castle實現的。abp繼承了Castle動態代理的AsyncDeterminationInterceptor
,通過繼承了AsyncInterceptorBase
使用適配器模式將攔截器進行包裝,並且將方法執行的參數進行封裝傳遞到我們定義的攔截器中。
執行被攔截的類的方法時,實際上通過代理類在執行InterceptAsync()
方法,這類似於傳統過濾器的效果,所以通過這種方式,我們可以在方法執行前後添加一些和業務無關的全局的操作,即一些橫切關註點。
ABP 系列總結:
目錄:ABP 系列總結
上一篇:ABP - 依賴註入(1)