.NET Core 依賴註入的基本用法 話接上篇,這一章介紹 .NET Core 框架自帶的輕量級 Ioc 容器下服務使用的一些知識點,大家可以先看看上一篇文章 [ASP.NET Core - 依賴註入(一)] 2.3 服務解析 通過 IServiceCollection 註冊了服務之後,可以通過以 ...
- .NET Core 依賴註入的基本用法
話接上篇,這一章介紹 .NET Core 框架自帶的輕量級 Ioc 容器下服務使用的一些知識點,大家可以先看看上一篇文章 [ASP.NET Core - 依賴註入(一)]
2.3 服務解析
通過 IServiceCollection 註冊了服務之後,可以通過以下方式解析相應服務的實例:
- IServiceProvider
IServiceProiver 實例由 IServiceCollection 通過 BuildServiceProvider() 方法創建,在 ASP.NET Core 中,主機啟動的時候會創建一個全局的 IServiceProvider,並且此實例也在容器當中。所有在容器註冊過的服務都可以通過 IServiceProiver 進行解析,當然該服務的依賴項必須也在容器中註冊。 - ActivatorUtilities
用於手動創建未在DI容器中註冊的服務實例
2.3.1 服務註入方式
當我們通過容器解析一個服務實例的時候,容器根據當前服務的鏈式依賴關係圖解析其依賴項,根據依賴項的生命周期或創建、或從已有的實例獲取,然後註入到我們解析的服務當中。在一個服務中獲取另一個服務實例的方式由以下幾種:
(1) 構造函數註入
構造函數註入是非常常見的服務註入方式,也是微軟最推薦的方式,這種方式可以明確地聲明當前類所依賴的東西,一目瞭然。如同上面的示例代碼中,使用的就是構造函數註入方式。構造函數註入,對於類的構造函數有以下要求:
-
構造函數可以接收非依賴註入的參數,但必須提供預設值
-
當服務通過 IServiceProvider 解析時,要求構造函數必須是 public
當服務由 ActivatorUtilities 解析時,構造函數註入要求只存在一個適用的構造函數。 支持構造函數重載,但其參數可以全部通過依賴註入來實現的重載只能存在一個。
-
如果發現構造函數時存在歧義,將引發異常,例如以下情況:
public class ExampleService { public ExampleService() { } public ExampleService(ILogger<ExampleService> logger) { // omitted for brevity } public ExampleService(IOptions<ExampleOptions> options) { // omitted for brevity } }
(2) 屬性註入
這裡有一點需要說明,.NET Core 內置的依賴註入框架並不支持屬性註入,如果需要使用屬性註入需要結合第三方依賴註入框架進行使用,如autofac。
顧名思義,屬性註入就是通過類中的屬性註入需要的服務,要求屬性必須是 public ,並且具備 get、set 訪問器。如下:
屬性註入一般用於註入一些即使缺失了也不會導致當前類無法工作的依賴項,如日誌記錄等。這種時候會為數據註入設置一個預設實現,防止該屬性為空,導致當前類的功能受影響。
(3) 方法註入
通過 FromServicesAttribute 特性在控制器的方法參數中註入,這種方式只能用於控制器。預設情況下,控制器示例由容器來管理,在入口文件調用 builder.Services.AddControllers(); 時註冊到容器中。
[HttpGet(nameof(InjectTest3))]
public Task InjectTest3([FromServices] IRabbit rabbit)
{
Console.WriteLine(rabbit is Rabbit);
return Task.CompletedTask;
}
這種方式用於縮小依賴註入的粒度,適用於註入的服務只在當前方法使用的時候,是對構造函數註入的簡化。
(4) 手動解析
在.NET框架中,任何可以拿得到 IServiceProvider 實例的地方都可以通過 GetRequiredService() 或者 GetService() 解析我們需要的服務。直接使用 IServiceProvider 是服務定位器模式的一個示例。這通常被認為是反模式,因為它隱藏了類的依賴關係。這種方式在某些情況下是有用的,但是應該儘量避免。
GetService() 與 GetRequiredService() 的區別在於解析服務時,如果該服務沒有在容器中註冊,前者會返回Null,而後者會拋出異常。兩者的區別可參考以下文件:ASP.NET Core中GetService()和GetRequiredService()之間的區別
除了通過註入 IServiceProvider 來解析服務之外,其他的方式,例如 HttpContext 中也包含 IServiceProvider 實例,如:
var rabbit1 = HttpContext.RequestServices.GetRequiredService<IRabbit>();
2.3.2 ActivatorUtilities 使用
通過 ActivatorUtilities 解析服務比較簡單,常用的由以下兩個方法:
ActivatorUtilities.CreateInstance<HelloService>(provider, "test");
ActivatorUtilities.GetServiceOrCreateInstance<IHelloService>(provider);
其中 CreateInstance 方法的泛型類型需要是具體的類型,而不是介面,這個方法還可以傳入構造函數需要的,但沒有在容器中註冊的參數。GetServiceOrCreateInstance 方法會先嘗試從容器獲取實例,獲取不到再創建,不支持不在容器中註冊的構造函數參數。
參考文章:
ASP.NET Core 依賴註入 | Microsoft Learn
理解ASP.NET Core - 依賴註入(Dependency Injection)
ASP.NET Core 系列:
目錄:ASP.NET Core 系列總結
上一篇:ASP.NET Core - 依賴註入(一)