Asp.net?core中依賴注入的實(shí)現(xiàn)

更新時(shí)間：2022年07月02日 12:24:59 作者：天方

這篇文章介紹了Asp.net?core中依賴注入的實(shí)現(xiàn)方法，文中通過(guò)示例代碼介紹的非常詳細(xì)。對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值，需要的朋友可以參考下

使用服務(wù)

在Asp.net core的Controller中，可以通過(guò)如下兩種方式獲取系統(tǒng)注入的服務(wù)：

構(gòu)造函數(shù)

可以直接在構(gòu)造函數(shù)中傳入所依賴的服務(wù)，這是非常常見的DI注入方式。

public?ValuesController(IConfiguration?cfg)
{
    //…
}

FromService參數(shù)

也可以直接在參數(shù)中通過(guò)FromServiceAttribute引入服務(wù)，這個(gè)在Controller中用起來(lái)非常方便，可以不用再構(gòu)造函數(shù)中加一個(gè)變量以保存服務(wù)。

[HttpGet]
public?string?Get([FromServices]?IConfiguration?cfg)
{
    //…
}

注入服務(wù)

如果要注入我們自己的服務(wù)，可以通過(guò)如下幾步實(shí)現(xiàn)：

定義服務(wù)接口

在DI框架中，服務(wù)一般是面向接口實(shí)現(xiàn)的，首先需要定義我們服務(wù)的接口：

public interface IMyLogger
{
    void WriteMessage(string message);
}

雖然接口定義本身并不是必須的，我們的應(yīng)用也可以直接依賴于具體的服務(wù)對(duì)象。但基于良好的設(shè)計(jì)原則，最好定義接口。

編寫服務(wù)實(shí)現(xiàn)

定義完服務(wù)后，就需要編寫服務(wù)的實(shí)現(xiàn)。

public class MyLogger : IMyLogger
{
    public void WriteMessage(string message)
    {
        Console.WriteLine(message);
    }
}

注入服務(wù)

注入服務(wù)一般是通過(guò)IServiceCollection.Add方法來(lái)實(shí)現(xiàn)的。在asp.net core中，一般有如下兩個(gè)入口可以注入服務(wù)。

Startup.ConfigureServices回調(diào)函數(shù)中注冊(cè)

public void ConfigureServices(IServiceCollection services)
{
    services.AddScoped<IMyLogger, MyLogger>();
    services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_1);
}

調(diào)用IWebHostBuilder.ConfigureServices方法注冊(cè)

一般會(huì)在Main函數(shù)中創(chuàng)建WebHost，此時(shí)可以主動(dòng)注冊(cè)服務(wù)。

WebHost.CreateDefaultBuilder(args)
    .ConfigureServices(service => service.AddScoped<IMyLogger, MyLogger>())
    .UseStartup<Startup>();

我這里并沒(méi)有直接使用IServiceCollection.Add方法注冊(cè)，而是調(diào)用的IServiceCollection.AddScoped擴(kuò)展方法，它簡(jiǎn)化了我們服務(wù)注冊(cè)的過(guò)程。這個(gè)方法有三個(gè)：

AddTransient
AddScoped
AddSingleton

這三個(gè)方法使用方式類似，它們主要的區(qū)別是代表了不同的生命周期：

暫時(shí)(Transient) - 每次調(diào)用都會(huì)創(chuàng)建新實(shí)例
作用域(Scoped) - 在調(diào)用方生命周期類保持相同實(shí)例。（如同一個(gè)Controller對(duì)象在構(gòu)造函數(shù)中和參數(shù)中引入的Scoped對(duì)象是相同的）
單例(Singleton) - 在Host內(nèi)保持唯一

系統(tǒng)自帶服務(wù)

Asp.net core程序啟動(dòng)的時(shí)候，默認(rèn)就注入了一系列服務(wù)

Microsoft.AspNetCore.Hosting.Builder.IApplicationBuilderFactory
Microsoft.AspNetCore.Hosting.IApplicationLifetime
Microsoft.AspNetCore.Hosting.IHostingEnvironment
Microsoft.AspNetCore.Hosting.IStartup
Microsoft.AspNetCore.Hosting.IStartupFilter
Microsoft.AspNetCore.Hosting.Server.IServer
Microsoft.AspNetCore.Http.IHttpContextFactory
Microsoft.Extensions.Logging.ILogger<T>
Microsoft.Extensions.Logging.ILoggerFactory
Microsoft.Extensions.ObjectPool.ObjectPoolProvider
Microsoft.Extensions.Options.IConfigureOptions<T>
Microsoft.Extensions.Options.IOptions<T>
System.Diagnostics.DiagnosticSource
System.Diagnostics.DiagnosticListener

這些服務(wù)我們可以直接通過(guò)注入的方式使用。另外，一些框架級(jí)別的服務(wù)（如IServiceProvider，IConfiguration，ILogger<T>等）也是默認(rèn)可以使用的。

服務(wù)容器接口

除了在構(gòu)造函數(shù)中自動(dòng)獲取服務(wù)外，我們還可以使用服務(wù)容器框架的API構(gòu)建更為高級(jí)的操作，它一般需要用到如下對(duì)象：

IServiceProvider 可以在實(shí)例中通過(guò)依賴注入的方式獲取
ActivatorUtilities 輔助構(gòu)建任務(wù)實(shí)例

一個(gè)簡(jiǎn)單的示例如下：

using (var scope = services.CreateScope())
{
    var service = scope.ServiceProvider.GetRequiredService<IMyLogger>();
    service.WriteMessage("hello world");
}

這種方式在asp.net core并不常用，因?yàn)橄到y(tǒng)的Web框架已經(jīng)為我們處理好了大部分功能，但在我們使用通用主機(jī)構(gòu)建自己的后臺(tái)應(yīng)用時(shí)，這些API就大有用武之地了，限于篇幅這里就不詳細(xì)介紹了。