理解ASP.NET Core 依賴注入(Dependency Injection)

更新時間：2021年09月07日 16:19:01 作者：xiaoxiaotank

把有依賴關(guān)系的類放到容器中，解析出這些類的實例，就是依賴注入。目的是實現(xiàn)類的解耦。本文主要介紹了ASP.NET Core 依賴注入(Dependency Injection)，需要了解具體內(nèi)容的可以仔細(xì)閱讀這篇文章，希望對你有所幫助

依賴注入

什么是依賴注入

簡單說，就是將對象的創(chuàng)建和銷毀工作交給DI容器來進(jìn)行，調(diào)用方只需要接收注入的對象實例即可。

微軟官方文檔-DI

依賴注入有什么好處

依賴注入在.NET中，可謂是“一等公民”，處處都離不開它，那么它有什么好處呢？

假設(shè)有一個日志類 FileLogger，用于將日志記錄到本地文件。

public class FileLogger
{
    public void LogInfo(string message)
    {

    }
}

日志很常用，幾乎所有服務(wù)都需要記錄日志。如果不使用依賴注入，那么我們就必須在每個服務(wù)中手動 new FileLogger 來創(chuàng)建一個 FileLogger 實例。

public class MyService
{
    private readonly FileLogger _logger = new FileLogger();

    public void Get()
    {
        _logger.LogInfo("MyService.Get");
    }
}

如果某一天，想要替換掉 FileLogger，而是使用 ElkLogger，通過ELK來處理日志，那么我們就需要將所有服務(wù)中的代碼都要改成 new ElkLogger。

public class MyService
{
    private readonly ElkLogger _logger = new ElkLogger();

    public void Get()
    {
        _logger.LogInfo("MyService.Get");
    }
}

在一個大型項目中，這樣的代碼分散在項目各處，涉及到的服務(wù)均需要進(jìn)行修改，顯然一個一個去修改不現(xiàn)實，且違反了“開閉原則”。
如果Logger中還需要其他一些依賴項，那么用到Logger的服務(wù)也要為其提供依賴，如果依賴項修改了，其他服務(wù)也必須要進(jìn)行更改，更加增大了維護(hù)難度。
很難進(jìn)行單元測試，因為它無法進(jìn)行 mock

正因如此，所以依賴注入解決了這些棘手的問題：

通過接口或基類（包含抽象方法或虛方法等）將依賴關(guān)系進(jìn)行抽象化
將依賴關(guān)系存放到服務(wù)容器中
由框架負(fù)責(zé)創(chuàng)建和釋放依賴關(guān)系的實例，并將實例注入到構(gòu)造函數(shù)、屬性或方法中

ASP.NET Core內(nèi)置的依賴注入

服務(wù)生存周期

Transient
瞬時，即每次獲取，都是一個全新的服務(wù)實例

Scoped
范圍（或稱為作用域），即在某個范圍（或作用域內(nèi)）內(nèi)，獲取的始終是同一個服務(wù)實例，而不同范圍（或作用域）間獲取的是不同的服務(wù)實例。對于Web應(yīng)用，每個請求為一個范圍（或作用域）。

Singleton
單例，即在單個應(yīng)用中，獲取的始終是同一個服務(wù)實例。另外，為了保證程序正常運(yùn)行，要求單例服務(wù)必須是線程安全的。

服務(wù)釋放

若服務(wù)實現(xiàn)了IDisposable接口，并且該服務(wù)是由DI容器創(chuàng)建的，那么你不應(yīng)該去Dispose，DI容器會對服務(wù)自動進(jìn)行釋放。

如，有Service1、Service2、Service3、Service4四個服務(wù)，并且都實現(xiàn)了IDisposable接口，如：

public class Service1 : IDisposable
{
    public void Dispose()
    {
        Console.WriteLine("Service1.Dispose");
    }
}

public class Service2 : IDisposable
{
    public void Dispose()
    {
        Console.WriteLine("Service2.Dispose");
    }
}

public class Service3 : IDisposable
{
    public void Dispose()
    {
        Console.WriteLine("Service3.Dispose");
    }
}

public class Service4 : IDisposable
{
    public void Dispose()
    {
        Console.WriteLine("Service4.Dispose");
    }
}

并注冊為：

public void ConfigureServices(IServiceCollection services)
{
    // 每次使用完（請求結(jié)束時）即釋放
    services.AddTransient<Service1>();
    // 超出范圍（請求結(jié)束時）則釋放
    services.AddScoped<Service2>();
    // 程序停止時釋放
    services.AddSingleton<Service3>();
    // 程序停止時釋放
    services.AddSingleton(sp => new Service4());
}

構(gòu)造函數(shù)注入一下

public ValuesController(
    Service1 service1, 
    Service2 service2, 
    Service3 service3, 
    Service4 service4)
{ }

請求一下，獲取輸出：

Service2.Dispose
Service1.Dispose

這些服務(wù)實例都是由DI容器創(chuàng)建的，所以DI容器也會負(fù)責(zé)服務(wù)實例的釋放和銷毀。注意，單例此時還沒到釋放的時候。

但如果注冊為：

public void ConfigureServices(IServiceCollection services)
{
    // 注意與上面的區(qū)別，這個是直接 new 的，而上面是通過 sp => new 的
    services.AddSingleton(new Service1());
    services.AddSingleton(new Service2());
    services.AddSingleton(new Service3());
    services.AddSingleton(new Service4());
}

此時，實例都是咱們自己創(chuàng)建的，DI容器就不會負(fù)責(zé)去釋放和銷毀了，這些工作都需要我們開發(fā)人員自己去做。

更多注冊方式，請參考官方文檔-Service registration methods

TryAdd{Lifetime}擴(kuò)展方法

當(dāng)你將同樣的服務(wù)注冊了多次時，如：

services.AddSingleton<IMyService, MyService>();
services.AddSingleton<IMyService, MyService>();

那么當(dāng)使用IEnumerable<{Service}>（下面會講到）解析服務(wù)時，就會產(chǎn)生多個MyService實例的副本。

為此，框架提供了TryAdd{Lifetime}擴(kuò)展方法，位于命名空間Microsoft.Extensions.DependencyInjection.Extensions下。當(dāng)DI容器中已存在指定類型的服務(wù)時，則不進(jìn)行任何操作；反之，則將該服務(wù)注入到DI容器中。

services.AddTransient<IMyService, MyService1>();
// 由于上面已經(jīng)注冊了服務(wù)類型 IMyService，所以下面的代碼不不會執(zhí)行任何操作（與生命周期無關(guān)）
services.TryAddTransient<IMyService, MyService1>();
services.TryAddTransient<IMyService, MyService2>();

TryAdd：通過參數(shù)ServiceDescriptor將服務(wù)類型、實現(xiàn)類型、生命周期等信息傳入進(jìn)去
TryAddTransient：對應(yīng)AddTransient
TryAddScoped：對應(yīng)AddScoped
TryAddSingleton：對應(yīng)AddSingleton
TryAddEnumerable：這個和TryAdd的區(qū)別是，TryAdd僅根據(jù)服務(wù)類型來判斷是否要進(jìn)行注冊，而TryAddEnumerable則是根據(jù)服務(wù)類型和實現(xiàn)類型一同進(jìn)行判斷是否要進(jìn)行注冊，常常用于注冊同一服務(wù)類型的多個不同實現(xiàn)。舉個例子吧：

// 注冊了 IMyService - MyService1
services.TryAddEnumerable(ServiceDescriptor.Singleton<IMyService, MyService1>());
// 注冊了 IMyService - MyService2
services.TryAddEnumerable(ServiceDescriptor.Singleton<IMyService, MyService2>());
// 未進(jìn)行任何操作，因為 IMyService - MyService1 在上面已經(jīng)注冊了
services.TryAddEnumerable(ServiceDescriptor.Singleton<IMyService, MyService1>());

解析同一服務(wù)的多個不同實現(xiàn)

默認(rèn)情況下，如果注入了同一個服務(wù)的多個不同實現(xiàn)，那么當(dāng)進(jìn)行服務(wù)解析時，會以最后一個注入的為準(zhǔn)。

如果想要解析出同一服務(wù)類型的所有服務(wù)實例，那么可以通過IEnumerable<{Service}>來解析（順序同注冊順序一致）：

public interface IAnimalService { }
public class DogService : IAnimalService { }
public class PigService : IAnimalService { }
public class CatService : IAnimalService { }

public void ConfigureServices(IServiceCollection services)
{
    // 生命周期沒有限制
    services.AddTransient<IAnimalService, DogService>();
    services.AddScoped<IAnimalService, PigService>();
    services.AddSingleton<IAnimalService, CatService>();
}

public ValuesController(
    // CatService
    IAnimalService animalService,   
    // DogService、PigService、CatService
    IEnumerable<IAnimalService> animalServices)
{
}

Replace && Remove 擴(kuò)展方法

上面我們所提到的，都是注冊新的服務(wù)到DI容器中，但是有時我們想要替換或是移除某些服務(wù)，這時就需要使用Replace和Remove了

// 將 IMyService 的實現(xiàn)替換為 MyService1
services.Replace(ServiceDescriptor.Singleton<IMyService, MyService>());
// 移除 IMyService 注冊的實現(xiàn) MyService
services.Remove(ServiceDescriptor.Singleton<IMyService, MyService>());
// 移除 IMyService 的所有注冊
services.RemoveAll<IMyService>();
// 清除所有服務(wù)注冊
services.Clear();

Autofac

Autofac 是一個老牌DI組件了，接下來我們使用Autofac替換ASP.NET Core自帶的DI容器。

1.安裝nuget包：

Install-Package Autofac
Install-Package Autofac.Extensions.DependencyInjection

2.替換服務(wù)提供器工廠

public static IHostBuilder CreateHostBuilder(string[] args) =>
    Host.CreateDefaultBuilder(args)
        .ConfigureWebHostDefaults(webBuilder =>
        {
            webBuilder.UseStartup<Startup>();
        })
        // 通過此處將默認(rèn)服務(wù)提供器工廠替換為 autofac
        .UseServiceProviderFactory(new AutofacServiceProviderFactory());

3.在 Startup 類中添加 ConfigureContainer 方法

public class Startup
{
    public Startup(IConfiguration configuration)
    {
        Configuration = configuration;
    }

    public IConfiguration Configuration { get; }

    public ILifetimeScope AutofacContainer { get; private set; }

    public void ConfigureServices(IServiceCollection services)
    {
        // 1. 不要 build 或返回任何 IServiceProvider，否則會導(dǎo)致 ConfigureContainer 方法不被調(diào)用。
        // 2. 不要創(chuàng)建 ContainerBuilder，也不要調(diào)用 builder.Populate()，AutofacServiceProviderFactory 已經(jīng)做了這些工作了
        // 3. 你仍然可以在此處通過微軟默認(rèn)的方式進(jìn)行服務(wù)注冊
        
        services.AddOptions();
        services.AddControllers();
        services.AddSwaggerGen(c =>
        {
            c.SwaggerDoc("v1", new OpenApiInfo { Title = "WebApplication.Ex", Version = "v1" });
        });
    }

    // 1. ConfigureContainer 用于使用 Autofac 進(jìn)行服務(wù)注冊
    // 2. 該方法在 ConfigureServices 之后運(yùn)行，所以這里的注冊會覆蓋之前的注冊
    // 3. 不要 build 容器，不要調(diào)用 builder.Populate()，AutofacServiceProviderFactory 已經(jīng)做了這些工作了
    public void ConfigureContainer(ContainerBuilder builder)
    {
        // 將服務(wù)注冊劃分為模塊，進(jìn)行注冊
        builder.RegisterModule(new AutofacModule());
    }
    
    public class AutofacModule : Autofac.Module
    {
        protected override void Load(ContainerBuilder builder)
        {
            // 在此處進(jìn)行服務(wù)注冊
            builder.RegisterType<UserService>().As<IUserService>();
        }
    }

    public void Configure(IApplicationBuilder app, ILoggerFactory loggerFactory)
    {
        // 通過此方法獲取 autofac 的 DI容器
        AutofacContainer = app.ApplicationServices.GetAutofacRoot();
    }
}

服務(wù)解析和注入

上面我們主要講了服務(wù)的注入方式，接下來看看服務(wù)的解析方式。解析方式有兩種：

1.IServiceProvider

2.ActivatorUtilities

用于創(chuàng)建未在DI容器中注冊的服務(wù)實例
用于某些框架級別的功能

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

上面我們舉得很多例子都是使用了構(gòu)造函數(shù)注入——通過構(gòu)造函數(shù)接收參數(shù)。構(gòu)造函數(shù)注入是非常常見的服務(wù)注入方式，也是首選方式，這要求：

構(gòu)造函數(shù)可以接收非依賴注入的參數(shù)，但必須提供默認(rèn)值
當(dāng)服務(wù)通過IServiceProvider解析時，要求構(gòu)造函數(shù)必須是public
當(dāng)服務(wù)通過ActivatorUtilities解析時，要求構(gòu)造函數(shù)必須是public，雖然支持構(gòu)造函數(shù)重載，但必須只能有一個是有效的，即參數(shù)能夠全部通過依賴注入得到值

方法注入

顧名思義，方法注入就是通過方法參數(shù)來接收服務(wù)實例。

[HttpGet]
public string Get([FromServices]IMyService myService)
{
    return "Ok";
}

屬性注入

ASP.NET Core內(nèi)置的依賴注入是不支持屬性注入的。但是Autofac支持，用法如下：

老規(guī)矩，先定義服務(wù)和實現(xiàn)

public interface IUserService 
{
    string Get();
}

public class UserService : IUserService
{
    public string Get()
    {
        return "User";
    }
}

然后注冊服務(wù)

默認(rèn)情況下，控制器的構(gòu)造函數(shù)參數(shù)由DI容器來管理嗎，而控制器實例本身卻是由ASP.NET Core框架來管理，所以這樣“屬性注入”是無法生效的
通過AddControllersAsServices方法，將控制器交給 autofac 容器來處理，這樣就可以使“屬性注入”生效了

public void ConfigureServices(IServiceCollection services)
{
    services.AddControllers().AddControllersAsServices();
}

public void ConfigureContainer(ContainerBuilder builder)
{
    builder.RegisterModule<AutofacModule>();
}

public class AutofacModule : Autofac.Module
{
    protected override void Load(ContainerBuilder builder)
    {
        builder.RegisterType<UserService>().As<IUserService>();

        var controllerTypes = Assembly.GetExecutingAssembly().GetExportedTypes()
            .Where(type => typeof(ControllerBase).IsAssignableFrom(type))
            .ToArray();

        // 配置所有控制器均支持屬性注入
        builder.RegisterTypes(controllerTypes).PropertiesAutowired();
    }
}

最后，我們在控制器中通過屬性來接收服務(wù)實例

public class ValuesController : ControllerBase
{
    public IUserService UserService { get; set; }

    [HttpGet]
    public string Get()
    {
        return UserService.Get();
    }
}

通過調(diào)用Get接口，我們就可以得到IUserService的實例，從而得到響應(yīng)

User

一些注意事項

避免使用服務(wù)定位模式。盡量避免使用GetService來獲取服務(wù)實例，而應(yīng)該使用DI。

using Microsoft.Extensions.DependencyInjection;

public class ValuesController : ControllerBase
{
    private readonly IServiceProvider _serviceProvider;

    // 應(yīng)通過依賴注入的方式獲取服務(wù)實例
    public ValuesController(IServiceProvider serviceProvider)
    {
        _serviceProvider = serviceProvider;
    }

    [HttpGet]
    public string Get()
    {
        // 盡量避免通過 GetService 方法獲取服務(wù)實例
        var myService = _serviceProvider.GetService<IMyService>();

        return "Ok";
    }
}

避免在ConfigureServices中調(diào)用BuildServiceProvider。因為這會導(dǎo)致創(chuàng)建第二個DI容器的副本，從而導(dǎo)致注冊的單例服務(wù)出現(xiàn)多個副本。

public void ConfigureServices(IServiceCollection services)
{
    // 不要在該方法中調(diào)用該方法
    var serviceProvider = services.BuildServiceProvider();
}

一定要注意服務(wù)解析范圍，不要在 Singleton 中解析 Transient 或 Scoped 服務(wù)，這可能導(dǎo)致服務(wù)狀態(tài)錯誤（如導(dǎo)致服務(wù)實例生命周期提升為單例）。允許的方式有：

1.在 Scoped 或 Transient 服務(wù)中解析 Singleton 服務(wù)

2.在 Scoped 或 Transient 服務(wù)中解析 Scoped 服務(wù)（不能和前面的Scoped服務(wù)相同）

當(dāng)在Development環(huán)境中運(yùn)行、并通過 CreateDefaultBuilder生成主機(jī)時，默認(rèn)的服務(wù)提供程序會進(jìn)行如下檢查：

1.不能在根服務(wù)提供程序解析 Scoped 服務(wù)，這會導(dǎo)致 Scoped 服務(wù)的生命周期提升為 Singleton，因為根容器在應(yīng)用關(guān)閉時才會釋放。

2.不能將 Scoped 服務(wù)注入到 Singleton 服務(wù)中

隨著業(yè)務(wù)增長，需要依賴注入的服務(wù)也越來越多，建議使用擴(kuò)展方法，封裝服務(wù)注入，命名為Add{Group_Name}，如將所有 AppService 的服務(wù)注冊封裝起來

namespace Microsoft.Extensions.DependencyInjection
{
    public static class ApplicationServiceCollectionExtensions
    {
        public static IServiceCollection AddApplicationService(this IServiceCollection services)
        {
            services.AddTransient<Service1>();
            services.AddScoped<Service2>();
            services.AddSingleton<Service3>();
            services.AddSingleton(sp => new Service4());

            return services;
        }
    }
}

然后在ConfigureServices中調(diào)用即可

public void ConfigureServices(IServiceCollection services)
{
    services.AddApplicationService();
}

框架默認(rèn)提供的服務(wù)

以下列出一些常用的框架已經(jīng)默認(rèn)注冊的服務(wù)：

服務(wù)類型	生命周期
Microsoft.AspNetCore.Hosting.Builder.IApplicationBuilderFactory	Transient
IHostApplicationLifetime	Singleton
IHostLifetime	Singleton
IWebHostEnvironment	Singleton
IHostEnvironment	Singleton
Microsoft.AspNetCore.Hosting.IStartup	Singleton
Microsoft.AspNetCore.Hosting.IStartupFilter	Transient
Microsoft.AspNetCore.Hosting.Server.IServer	Singleton
Microsoft.AspNetCore.Http.IHttpContextFactory	Transient
Microsoft.Extensions.Logging.ILogger	Singleton
Microsoft.Extensions.Logging.ILoggerFactory	Singleton
Microsoft.Extensions.ObjectPool.ObjectPoolProvider	Singleton
Microsoft.Extensions.Options.IConfigureOptions	Transient
Microsoft.Extensions.Options.IOptions	Singleton
System.Diagnostics.DiagnosticSource	Singleton
System.Diagnostics.DiagnosticListener	Singleton