深刻理解ASP.NET Core依賴注入

時間 2020-02-19

標籤深刻理解 asp.net asp core 依賴注入欄目 ASP 简体版

原文原文鏈接

概述

ASP.NET Core能夠說是到處皆注入，本文從基礎角度理解一下原生DI容器，及介紹下怎麼使用而且如何替換官方提供的默認依賴注入容器。html

什麼是依賴注入

百度百科中對於依賴注入的定義：控制反轉（Inversion of Control，縮寫爲IoC），是面向對象編程中的一種設計原則，能夠用來減低計算機代碼之間的耦合度。其中最多見的方式叫作依賴注入（Dependency Injection，簡稱DI），還有一種方式叫「依賴查找」（Dependency Lookup）。經過控制反轉，對象在被建立的時候，由一個調控系統內全部對象的外界實體將其所依賴的對象的引用傳遞給它。也能夠說，依賴被注入到對象中。
web

依賴反轉前

那麼在依賴反轉以前或者叫控制反轉以前，直接依賴是怎麼工做的呢，這裏ClassA直接依賴ClassB，而ClassB又直接依賴ClassC，任何一處的變更都會牽一髮而動全身，不符合軟件工程的設計原則。

編程

依賴反轉後

應用依賴關係反轉原則後，A 能夠調用 B 實現的抽象上的方法，讓 A 能夠在運行時調用 B，而 B 又在編譯時依賴於 A 控制的接口（所以，典型的編譯時依賴項發生反轉）。運行時，程序執行的流程保持不變，但接口引入意味着能夠輕鬆插入這些接口的不一樣實現。

依賴項反轉是生成鬆散耦合應用程序的關鍵一環，由於能夠將實現詳細信息編寫爲依賴並實現更高級別的抽象，而不是相反。所以，生成的應用程序的可測試性、模塊化程度以及可維護性更高。遵循依賴關係反轉原則可實現依賴關係注入。app

何謂容器

若是你用過Spring，就知道其龐大而全能的生態圈正是由於有了它包含各類各樣的容器來作各類事情，其本質也是一個依賴反轉工廠，那麼不知道你注意到沒有，控制反轉後產生依賴注入，這樣的工做咱們能夠手動來作，那麼若是注入的服務成千上萬呢，那怎麼玩呢？那麼問題來了，控制反轉了，依賴的關係也交給了外部，如今的問題就是依賴太多，咱們須要有一個地方來管理全部的依賴，這就是容器的角色。
容器的主要職責有兩個：綁定服務與實例之間的關係（控制生命週期）。獲取實例並對實例進行管理（建立和銷燬）。框架

ASP.NET Core裏依賴注入是怎麼實現的

在.Net Core裏提供了默認的依賴注入容器IServiceCollection，它是一個輕量級容器。核心組件爲兩個IServiceCollection和IServiceProvider，IServiceCollection負責註冊，IServiceProvider負責提供實例。
使用兩個核心組件前導入命名空間Microsoft.Extensions.DependencyInjection.
默認的ServiceCollection有如下三個方法：asp.net

IServiceCollection serviceCollection=new ServiceCollection();
#三個方法都是註冊實例，只不過實例的生命週期不同。
#單例模式，只有一個實例
serviceCollection.AddSingleton<ILoginService, EFLoginService>();
#每次請求都是同一個實例，好比EntityFramework.Context
serviceCollection.AddScoped<ILoginService, EFLoginService>();
#每次調用都是不一樣的實例
serviceCollection.AddTransient<ILoginService, EFLoginService>();

#接口聲明
public interface IServiceCollection : IList<ServiceDescriptor>, ICollection<ServiceDescriptor>, IEnumerable<ServiceDescriptor>, IEnumerable
{
}

#默認的ServiceCollection其實是一個提供了ServiceDescriptor的List。 
public class ServiceCollection : IServiceCollection, ICollection<ServiceDescriptor>, IEnumerable<ServiceDescriptor>, IEnumerable, IList<ServiceDescriptor>
  {
    private readonly List<ServiceDescriptor> _descriptors = new List<ServiceDescriptor>();

    public int Count
    {
      get
      {
        return this._descriptors.Count;
      }
    }
    
    public bool IsReadOnly
    {
      get
      {
        return false;
      }
    }

    public ServiceDescriptor this[int index]
    {
      get
      {
        return this._descriptors[index];
      }
      set
      {
        this._descriptors[index] = value;
      }
    }

    public void Clear()
    {
      this._descriptors.Clear();
    }

    public bool Contains(ServiceDescriptor item)
    {
      return this._descriptors.Contains(item);
    }
    
    public void CopyTo(ServiceDescriptor[] array, int arrayIndex)
    {
      this._descriptors.CopyTo(array, arrayIndex);
    }

    public bool Remove(ServiceDescriptor item)
    {
      return this._descriptors.Remove(item);
    }

    public IEnumerator<ServiceDescriptor> GetEnumerator()
    {
      return (IEnumerator<ServiceDescriptor>) this._descriptors.GetEnumerator();
    }

    void ICollection<ServiceDescriptor>.Add(ServiceDescriptor item)
    {
      this._descriptors.Add(item);
    }

    IEnumerator IEnumerable.GetEnumerator()
    {
      return (IEnumerator) this.GetEnumerator();
    }

    public int IndexOf(ServiceDescriptor item)
    {
      return this._descriptors.IndexOf(item);
    }
    
    public void Insert(int index, ServiceDescriptor item)
    {
      this._descriptors.Insert(index, item);
    }

    public void RemoveAt(int index)
    {
      this._descriptors.RemoveAt(index);
    }
  }

三個方法對應的生命週期值，在枚舉ServiceLifeTime中定義：ide

public enum ServiceLifetime
{
   Singleton, 
   Scoped,
   Transient,
}

三個方法確切來講是定義在擴展方法ServiceCollectionServiceExtensions中定義：模塊化

#這裏我列出個別方法，詳細可參看源碼
#導入Microsoft.Extensions.DependencyInjection
public static class ServiceCollectionServiceExtensions
{   
    public static IServiceCollection AddTransient(
      this IServiceCollection services,
      Type serviceType,
      Type implementationType)
    {
      if (services == null)
        throw new ArgumentNullException(nameof (services));
      if (serviceType == (Type) null)
        throw new ArgumentNullException(nameof (serviceType));
      if (implementationType == (Type) null)
        throw new ArgumentNullException(nameof (implementationType));
      //這裏注入時指定ServiceLifetime.Transient
      return ServiceCollectionServiceExtensions.Add(services, serviceType, implementationType, ServiceLifetime.Transient);
    }
    
    public static IServiceCollection AddScoped(
      this IServiceCollection services,
      Type serviceType,
      Type implementationType)
    {
      if (services == null)
        throw new ArgumentNullException(nameof (services));
      if (serviceType == (Type) null)
        throw new ArgumentNullException(nameof (serviceType));
      if (implementationType == (Type) null)
        throw new ArgumentNullException(nameof (implementationType));
      //這裏注入時指定ServiceLifetime.Scoped
      return ServiceCollectionServiceExtensions.Add(services, serviceType, implementationType, ServiceLifetime.Scoped);
    }
    
    public static IServiceCollection AddSingleton(
      this IServiceCollection services,
      Type serviceType,
      Type implementationType)
    {
      if (services == null)
        throw new ArgumentNullException(nameof (services));
      if (serviceType == (Type) null)
        throw new ArgumentNullException(nameof (serviceType));
      if (implementationType == (Type) null)
        throw new ArgumentNullException(nameof (implementationType));
      //這裏注入時指定ServiceLifetime.Singleton
      return ServiceCollectionServiceExtensions.Add(services, serviceType, implementationType, ServiceLifetime.Singleton);
    }
}

ASP.NET Core裏依賴注入是怎樣運行的

在Startup中初始化

ASP.NET Core在Startup.ConfigureService中注入指定服務，能夠從方法參數IServiceCollection中看出，這裏還有個方法services.AddMvc(), 這個MVC框架自己本身注入的服務，定義在MvcServiceCollectionExtesnsions類中。函數

#Startup
public void ConfigureServices(IServiceCollection services)
{
     services.AddMvc();
     services.AddSingleton<ILoginService, EFLoginService>();        
}

在構造函數中注入

官方推薦在構造器中注入，這裏也是爲了體現顯示依賴。測試

public class AccountController
{
    private ILoginService _loginService;
    public AccountController(ILoginService loginService)
    {
        _loginService = loginService;
    }
}

如何替換其餘容器

前面提到原生的依賴注入容器只是一個輕量級容器，可是功能真的頗有限，好比屬性注入、方法注入、子容器、lazy對象初始化支持。爲什麼很差好借鑑一下Spring強大的背景呢，因此這裏咱們用Autofac替換系統默認的依賴注入容器。先引用命名空間Autofac、Autofac.Extensions.DependencyInjection。我本機環境使用的.Net Core3.0。 3.0不能修改直接修改Startup的ConfigureService方法了，直接修改ConfigureService方法返回值會拋出異常ConfigureServices returning an System.IServiceProvider isn't supported. 這裏能夠參考Autofac文檔，已經有說明。

修改Startup

#直接聲明方法ConfigureContainer 
public class Startup
 {
     public Startup(IConfiguration configuration)
     {
         Configuration = configuration;
     }

     public IConfiguration Configuration { get; }

     public void ConfigureServices(IServiceCollection services)
     {
         services.AddControllersWithViews();
         services.AddMvc();
     }

     public void ConfigureContainer(ContainerBuilder containerBuilder)
     {
         containerBuilder.RegisterType<EFLoginService>().As<ILoginService>();
     }

     public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
     {
         if (env.IsDevelopment())
         {
             app.UseDeveloperExceptionPage();
         }
         else
         {
             app.UseExceptionHandler("/Home/Error");
             app.UseHsts();
         }

         app.UseStaticFiles();
         app.UseRouting();
         app.UseAuthorization();
         app.UseEndpoints(endpoints =>
                          {
                              endpoints.MapControllerRoute(
                                  name: "default",
                                  pattern: "{controller=Home}/{action=Index}/{id?}");
                          });
     }
 }

修改Program

#導入命名空間Autofac.Extensions.DependencyInjections,而後調用UseServiceProviderFactory 
public class Program
 {
     public static void Main(string[] args)
     {
         CreateHostBuilder(args).Build().Run();
     }

     public static IHostBuilder CreateHostBuilder(string[] args) =>
         Host.CreateDefaultBuilder(args)
         .ConfigureWebHostDefaults(
         webBuilder => { webBuilder.UseStartup<Startup>(); })
         .UseServiceProviderFactory(new AutofacServiceProviderFactory());
 }