.NET CORE 依賴注入 實踐總結

知識點回顧

• 依賴包。 Microsoft.Extensions.DependencyInjection.Abstractions
• 核心對象和方法。
  • IServiceCollection。注入對象的容器。注意它只存儲對象的元數據，並不保存實例對象。
  • IServiceProvider。注入對象的提供者。它負責提供具體的對象實例。在架構中，IServiceProvider有2種身份，一種是Root ServiceProvider，由service.BuildServiceProvider()創建，生命周期貫穿整個應用程序，AddSingleton對象保存在這里。另外一種則是普通IServiceProvider，由IServiceScope創建，生命周期即為AddScoped的生命周期。AddScope 的對象保存在這里。普通ServiceProvider由Root ServiceProvider創建的IServiceScope創建。
  • IServiceScope。表某一個生命周期范圍。由ServiceProvider.CreateScope()創建。
  • 注入方式，知識點一。
    • 注入功能默認在Startup類中的ConfigureServices方法中。
  • 注入方式，知識點二。支持以下三種方式
    • AddScoped。生命周期為Scoped類型。例如在web框架中，即表示一次Request請求范圍內。
    • AddSingleton。單例，應用程序全局使用同一個實例。
    • AddTransient。即時的，即對象每次使用都會重新實例化。　　
  • 注入方式，知識點三。提供多種注入技巧，以Transient為例
    • 實例注入。AddTransient<TService>(this IServiceCollection services)。
    • 泛型注入。AddTransient<TService, TImplementation>(this IServiceCollection services)。
    • 工廠注入。AddTransient<TService>(this IServiceCollection services, Func<IServiceProvider, TService> implementationFactory)。
    • TryAddXXX。僅當XXX尚未注冊實現時，注冊該服務。此方法用來避免在容器中注冊一個實例的兩個副本。
  • 獲取實例的方法 GetService和GetRequiredService的區別，前置如果service不存在會返回NULL，后者會直接拋出異常。根據需要選擇GetRequiredService，可能會讓你的代碼變得簡潔一點。

WHY 依賴注入

這里只談益處。

• 使用接口或基類抽象化依賴關系實現，明確各個類之間的依賴關系。
• 生命周期的統一管理，尤其對於某些類被多處依賴，關系會變得分散難以管理，依賴注入容器可以解決這點。
• 非常利於單元測試。

最佳實踐

部分來自官方文檔的一些建議

• 對於需要注入為單例的實例，不要依賴Scoped實例。會觸發 .NET CORE作用域驗證失敗。
• 不要從Root IServiceProvider解析有作用域的實例，這樣會導致該作用域的實例變成單一實例。同樣會觸發作用域驗證失敗。
• 對於Asp.Net Core，盡量通過構造函數而不是HttpContext.RequestServices獲取實例，這樣更易於單元測試。
• 需要對某個組件服務或是一些服務集合（包括其依賴注入時），使用約定的 Add{SERVICE_NAME} 擴展方法來注冊該服務所需的所有服務。
• 若必須要從IServiceProvider中解析實例（如在單元測試中），請通過using (var scope = ServiceProvider.CreateScope()){ }方式創建作用域來獲取實例。
• 代碼中避免設計有狀態的、靜態類和成員。可以考慮設計注入為單一實例。
• 代碼中避免在服務中直接實例化以來類。盡量采用依賴注入的方式
• 注意以下兩種方式注入的區別，后者的實例化不是服務容器創建的，所以容器不會處理實例的Dispose !!

  public class Service1 : IDisposable {}
  public class Service2 : IDisposable {}
  
  //方式一
  public void ConfigureServices(IServiceCollection services)
  {
      services.AddSingleton<Service1>();
      services.AddSingleton<IService2>(sp => new Service2());
  }
  
  //方式二
  public void ConfigureServices(IServiceCollection services)
  {
      services.AddSingleton<Service1>(new Service1());
      services.AddSingleton(new Service2());
  }

• 延伸上一點，對於復雜對象的創建，盡量采用提供的工廠注入方式。注意工廠注入的參數是IServiceProvider，可以通過它獲取你需要的實例對象。
• 繼續延伸上一點，不要在ConfigureServices方法中 通過collection.BuildServiceProvider()來獲取IServiceProvider。這個創建的是一個Root IServiceProvider。單例會實例化一次，然后ConfigureServices方法結束后框架會再次調用collection.BuildServiceProvider()，單例又會重新實例化一次。
• 不支持基於async/await和Task的服務解析。C# 不支持異步構造函數；因此建議模式是在同步解析服務后使用異步方法
• 避免在容器中直接存儲數據和配置。配置應使用NET CORE的選項模型。
• 避免使用服務定位器模式。例如直接注入IServiceProvider來獲取多個需要的服務。PS，如果你的服務依賴項過多，應該考慮分割成幾個小功能服務了。

引入第三方IOC框架

.NET CORE 3.x版本后，引入第三方IOC框架的方式變更了，這里不再貼出2.x的方式。以Autofac框架為例。

Program.cs

        public static IHostBuilder CreateHostBuilder(string[] args) =>
            Host.CreateDefaultBuilder(args)
                .UseServiceProviderFactory(new AutofacServiceProviderFactory())
                .ConfigureWebHostDefaults(webBuilder =>
                {
                    webBuilder.UseStartup<Startup>()
                            .ConfigureLogging((hostingContext, logging) =>
                            {
                                logging.ClearProviders();
                                logging.AddConsole();
                                logging.AddNLog();
                            });
                });

Startup.cs

　　　　 
　　　　 //原來的 ConfigureServices保留，也可以使用原來的框架繼續注入

        public void ConfigureServices(IServiceCollection services)
        {
            services.AddControllers();
            services.AddMemoryCache();
            services.Configure<List<string>>(Configuration.GetSection("BlackPhoneList"));
            services.Configure<Dictionary<string, string>>(Configuration.GetSection("BusinessMessages"));
        }
        //增加ConfigureContainer(ContainerBuilder builder) 方式，使用Autofac框架注入
        public void ConfigureContainer(ContainerBuilder builder)
        {
            builder.RegisterType<PhoneBlackListValidator>().Named<IPhoneValidator>("PHONE_BLACKLIST").SingleInstance();
            builder.RegisterType<PhonePerDayCountValidator>().Named<IPhoneValidator>("PHONE_PERDAYCOUNT").SingleInstance();
            builder.RegisterType<UniqueIdPerDayCountValidator>().Named<IUniqueIdValidator>("UNIQUEID_PERDAYCOUNT").SingleInstance();

            //可遍歷類型注入，注意 只支持IEnumerable\IList\ICollection 類型
            builder.RegisterType<MessageSendValidator>().As<IMessageSendValidator>().SingleInstance();
        }

3.x 主要是在IServiceCollection和IServiceProvider之間增加了一個 ContainerBuilder 容器適配，使得第三方IOC框架引入更加合理了。具體實現原理可以網上源碼查找。

特別關注-線程安全

• 創建線程安全的單一實例服務。 如果單例服務依賴於一個Transient服務，那么Transient服務可能也需要線程安全，具體取決於單例使用它的方式。
• 工廠注入方式的Func<IServiceProvider,TService>不需要是線程安全的，框架保證它由單個線程調用一次。