深入理解ASP.NET Core依賴註入_ZenDei技術網路在線

概述 ASP.NET Core可以說是處處皆註入，本文從基礎角度理解一下原生DI容器，及介紹下怎麼使用並且如何替換官方提供的預設依賴註入容器。什麼是依賴註入百度百科中對於依賴註入的定義：控制反轉（Inversion of Control，縮寫為 IoC ），是 "面向對象編程" 中的一種設計 ...

概述

ASP.NET Core可以說是處處皆註入，本文從基礎角度理解一下原生DI容器，及介紹下怎麼使用並且如何替換官方提供的預設依賴註入容器。

什麼是依賴註入

百度百科中對於依賴註入的定義：控制反轉（Inversion of Control，縮寫為IoC），是面向對象編程中的一種設計原則，可以用來減低電腦代碼之間的耦合度。其中最常見的方式叫做依賴註入（Dependency Injection，簡稱DI），還有一種方式叫“依賴查找”（Dependency Lookup）。通過控制反轉，對象在被創建的時候，由一個調控系統內所有對象的外界實體將其所依賴的對象的引用傳遞給它。也可以說，依賴被註入到對象中。

依賴反轉前

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

依賴反轉後

應用依賴關係反轉原則後，A 可以調用 B 實現的抽象上的方法，讓 A 可以在運行時調用 B，而 B 又在編譯時依賴於 A 控制的介面（因此，典型的編譯時依賴項發生反轉）。運行時，程式執行的流程保持不變，但介面引入意味著可以輕鬆插入這些介面的不同實現。

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

何謂容器

如果你用過Spring，就知道其龐大而全能的生態圈正是因為有了它包含各種各樣的容器來做各種事情，其本質也是一個依賴反轉工廠，那麼不知道你註意到沒有，控制反轉後產生依賴註入，這樣的工作我們可以手動來做，那麼如果註入的服務成千上萬呢，那怎麼玩呢？那麼問題來了，控制反轉了，依賴的關係也交給了外部，現在的問題就是依賴太多，我們需要有一個地方來管理所有的依賴，這就是容器的角色。
容器的主要職責有兩個：綁定服務與實例之間的關係（控制生命周期）。獲取實例並對實例進行管理（創建和銷毀）。

ASP.NET Core里依賴註入是怎麼實現的

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

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中定義：

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());
 }