文字首發地址

一、前言

這上一篇中，主要講述了什么是IoC容器，以及了解到它是DI構造函注入的框架，它管理著依賴項的生命周期以及映射關系，同時也介紹實踐了在ASP.Net Core中,默認提供的內置IoC容器，以及它的實體注冊方式和相應的生命周期，

但考慮到在實際專案中，如果需要一個個添加實體，會略顯麻煩，為了達到可以簡化我們作業量,因此我們也可以引入其他的Ioc容器框架，實作更多的功能和擴展，

這里選擇用Autofac，這也是在.net下比較流行的，其他的框架不做說明，可自行查閱了解，

二、說明

AutoFac是一個開源的輕量級的依賴注入容器，也是.net下比較流行的實作依賴注入的工具之一，

將Autofac整合到你的應用的基本流程如下:

按照 控制反轉 (IoC) 的思想構建你的應用.
添加Autofac參考.
在應用的 startup 處
創建 ContainerBuilder.
注冊組件.
創建容器,將其保存以備后續使用.
應用執行階段
從容器中創建一個生命周期.
在此生命周期作用域內決議組件實體.

三、開始

3.1 默認容器

在上一篇中定義的三個介面，分別測驗Singleton，Scope，Transient三種，一個 TestService服務，

在內置的IoC容器中，在Startup.cs類檔案ConfigureServices方法中，注入依賴方式如下：

public void ConfigureServices(IServiceCollection services)
{
    services.AddControllers();
    services.AddTransient<ITransientService, TransientService>();
    services.AddSingleton<ISingletonService, SingletonService>();
    services.AddScoped<IScopedService, ScopedService>();
    services.AddScoped<ITestService, TestService>();
}

其他不清楚的可以回看上一篇說明

3.2 Autofac框架

現在我們使用其他的IoC容器框架來替換默認的內置IoC，這里選擇使用Autofac框架

.net core 2.x和3.x 使用autofac注入方式不一樣，此文章是針對.net core 3.x

首先,我們需要從nuget參考相關的包.

Autofac.Extensions.DependencyInjection(這個包擴展了一些微軟提供服務的類.來方便替換autofac)

然后在Program.cs 新增一行代碼

        public static IHostBuilder CreateHostBuilder(string[] args)
        {
            //var assemblyName = typeof(Startup).GetTypeInfo().Assembly.FullName;
            return Host.CreateDefaultBuilder(args)
                    .UseServiceProviderFactory(new AutofacServiceProviderFactory())  //設定工廠來替換實體
                    .ConfigureWebHostDefaults(webBuilder =>
                    {
                        webBuilder.UseStartup<Startup>();
                    });
        }

UseServiceProviderFactory 設定工廠來替換實體，

然后在Startup類增加ConfigureContainer方法，在方法中注入依賴：

    public void ConfigureContainer(ContainerBuilder builder)
    {
        // Register your own things directly with Autofac, like:
        builder.RegisterType<TransientService>().As<ITransientService>();
        builder.RegisterType<SingletonService>().As<ISingletonService>().SingleInstance();
        builder.RegisterType<ScopedService>().As<IScopedService>().InstancePerLifetimeScope();
        builder.RegisterType<TestService>().As<ITestService>().InstancePerLifetimeScope();
    }

說明

ASP.NET Core 引入了具有強型別容器配置的能力，它提供了一個ConfigureContainer方法，您可以使用Autofac單獨注冊，而不是使用ServiceCollection注冊，

使用ConfigureContainer配置

在配置WebHostBuilder的Program.Main方法中，呼叫AddAutofac將Autofac掛鉤到啟動管道中，

在Startup類的ConfigureServices方法中，使用其他庫提供的擴展方法將內容注冊到IServiceCollection中，

在Startup類的ConfigureContainer方法中，將內容直接注冊到AutofacContainerBuilder中，

3.3 測驗

啟動運行專案，訪問介面/Test

效果如下：

對比之前默認容器可以發現，在兩次的請求訪問都一樣，可以得到了 4個Transient實體，2個Scope實體，1個Singleton實體，

四、說明

下面主要針對Autofac中的注冊組件、決議服務兩大步驟，以及其中容器中對應實體的生命周期，進行說明，

4.1 注冊組件

通過創建 ContainerBuilder 來注冊組件，并且告訴容器哪些組件，暴露了哪些服務，

使用 Register() 方法來注冊實作：

ContainerBuilder 包含一組 Register() 注冊方法，而組件暴露服務，可用使用 ContainerBuilder 上的 As() 方法，

即在容器初始化時候，向容器組件添加物件的操作程序，

通過梳理Autofac所有可用的注冊組件方法，顯示如下圖展示的流程圖，

這里我們只說明下幾種便捷的注冊方法

4.1.1 反射注冊

直接注冊的組件必須是具體的型別，并可用暴露抽象和介面作為服務，但不能注冊一個抽象和介面組件，

使用RegisterType<T>()或者RegisterType(typeof(T))方法：

builder.RegisterType<TestService>().As<ITestService>();
// 或者
builder.RegisterType(typeof(TestService)).As(typeof(ITestService))

在多個建構式時，如果需要，也可手動指定一個建構式，

使用 UsingConstructor 方法和構造方法中代表引數型別的型別，
builder.RegisterType<TestService>()
       .UsingConstructor(typeof(TransientService), typeof(SingletonService));

4.1.2 實體注冊

提前生成物件的實體并加入容器，以供注冊組件時使用，

使用RegisterInstance()方法

// new出一個物件注冊：
var output = new StringWriter();
builder.RegisterInstance(output).As<TestService>();

如果單例中存在實體且需要在容器中被組件使用時，

builder.RegisterInstance(MySingleton.Instance).ExternallyOwned();

4.1.3 Lambda運算式注冊

當組件創建不再是簡單呼叫構造方法時，可用利用lambda運算式來實作一些常規反射無法實作的操作，

比如一些復雜引數注冊，引數注入，以及選擇引數值實作等，

  builder.Register(x => new TransientService()).As<ITransientService>();
// 或者指定引數
  builder.Register(x => new TestService(x.Resolve<ITransientService>(), x.Resolve<IScopedService>(), x.Resolve<ISingletonService>()))
  .As<ITestService>().InstancePerLifetimeScope();

4.1.4 泛型注冊

支持泛型注冊操作，使用 RegisterGeneric() 方法:

builder.RegisterGeneric(typeof(NHibernateRepository<>))
       .As(typeof(IRepository<>))
       .InstancePerLifetimeScope();

4.1.5 條件注冊

在一些特殊場景，可能需要通過加上判斷條件，來決定是否執行該條注冊陳述句，

兩種方法：

OnlyIf() - 提供一個運算式, 表示只有滿足條件，才會執行陳述句，

builder.RegisterType<Manager>()
       .As<IManager>()
       .OnlyIf(reg =>
         reg.IsRegistered(new TypedService(typeof(IService))) &&
         reg.IsRegistered(new TypedService(typeof(HandlerB))));

IfNotRegistered() - 表示沒有其他服務注冊的情況下，就執行陳述句，

方法在 ContainerBuilder.Build() 時執行并且以實際組件注冊的順序執行，

builder.RegisterType<ServiceA>()
       .As<IService>();
builder.RegisterType<ServiceB>()
       .As<IService>()
       .IfNotRegistered(typeof(IService));

4.1.6 屬性注入

構造方法引數注入是一種傳值給組件的首選的方法，

在建構式中是直接使用服務型別作為引數，然后AutoFac決議該類時，就會去容器內部已存在的組件中查找，然后將匹配的物件注入到建構式中去，

但你同樣也可以使用屬性方法注入來傳值，

是將容器內對應的組件直接注入到類內的屬性中去,在注冊該屬性所屬類的時候，需要使用PropertiesAutowired()方法額外標注，

這里不討論屬性注入的好壞，也不做說明服務層屬性怎么注入，只討論說明控制器中屬性如何實作注入

注冊組件方法，并使用屬性注入PropertiesAutowired()標注，

builder.RegisterType<TransientService>().As<ITransientService>().PropertiesAutowired();

在控制器中使用屬性來接收, 其中注入屬性必須標注為public

    [ApiController]
    [Route("[controller]")]
    public class TestController : ControllerBase
    {
        
        public ITransientService _transientService { get; set; }  
        
        [HttpGet]
        public JsonResult Get()
        {
            var data1 =   _transientService.GetGuid();
            return new JsonResult(new { 
                data1
            });
        }
    }

運行測驗，發現如下

發現_transientService為null,所以根本沒有注入成功，

這是因為控制器本身的實體（以及它的處理）是由框架創建和擁有的，而不是由容器所有

因此我們需要改變控制器本身的創建及其擁有，

在Startup.cs中修改ConfigureServices方法，替換從IServiceProvider中決議控制器實體的所有者，

        public void ConfigureServices(IServiceCollection services)
        {
            //替換控制器的所有者
            services.Replace(ServiceDescriptor.Transient<IControllerActivator, ServiceBasedControllerActivator>());

            services.AddControllers();

        }

注意,替換的方法一定要在AddControllers之前，

在ContainerBuilder中通過注冊控制器，并使用屬性注入功能實作.

public void ConfigureContainer(ContainerBuilder builder)
{ 
    //找到所有的controller進行注冊，并使用屬性注入功能
    var controllerTypesInassembly = typeof(Startup).Assembly.GetExportedTypes()
        .Where(type => typeof(ControllerBase).IsAssignableFrom(type)).ToArray();
  builder.RegisterTypes(controllerTypesInassembly).PropertiesAutowired();
    
    builder.RegisterType<TransientService>().As<ITransientService>().PropertiesAutowired();
}

這樣就可以在Controller中進行屬性注入了；

再次運行查看，發現已經成功注入了，

4.1.7 程式集注冊

當我們需要實作批量注冊的時候，也可以使用程式集的方式來注冊，這也是常用的方法，

可通過指定過濾型別，服務，掃描模塊等方式來找到需要注冊的組件，

var assemblies = Assembly.GetExecutingAssembly();

builder.RegisterAssemblyTypes(assemblies)//程式集內所有具象類 
.Where(c => c.Name.EndsWith("Service"))
.PublicOnly()//只要public訪問權限的
.Where(cc => cc.IsClass)//只要class型（主要為了排除值和interface型別） 
.AsImplementedInterfaces();//自動以其實作的所有介面型別暴露（包括IDisposable介面）

說明：

RegisterAssemblyTypes() ：接收包含一個或多個程式集的陣列作為引數
RegisterAssemblyModules() : 接收模塊作為引數，進行模塊掃描注冊
PublicOnly() ：指定公有方法被注冊
Where() ：要過濾注冊的型別
Except() ：要排除的型別
As() ：反射出其實作的介面
AsImplementedInterfaces() ：自動以其實作的所有介面型別暴露（包括IDisposable介面）

4.2 暴露服務

上面提到了注冊組件時, 我們得告訴Autofac, 組件暴露了哪些服務，

在上面注冊實作中，大部分使用到了As() 方法，

當然，Autofac也提供了其他標注來暴露服務的方法，

4.2.1 默認暴露自身型別服務

常用的幾種方法如下：

builder.RegisterType<CallLogger>();//不標注，默認以自身型別暴露服務
builder.RegisterType<CallLogger>().AsSelf();
builder.RegisterType<CallLogger>().As<CallLogger>();
builder.RegisterType<CallLogger>().As(typeof(CallLogger));

4.2.2 多個暴露服務型別

以其實作的介面（interface）暴露服務，暴露的型別可以是多個，比如CallLogger類實作了ILogger介面和ICallInterceptor介面，

暴露服務后, 可以決議基于該服務的組件了. 但請注意, 一旦將組件暴露為一個特定的服務, 默認的服務 (組件型別) 將被覆寫，

所以，為了防止被其他服務覆寫，可以使用 AsSelf() 方法，

Copybuilder.RegisterType<CallLogger>()
       .As<ILogger>()
       .As<ICallInterceptor>()
       .AsSelf();

這樣你既可以實作組件暴露一系列特定的服務, 又可以讓它暴露默認的服務，

4.2.3 程式集注冊指定暴露型別

可通過指定介面型別暴露服務，使用As() 方法

publi void ConfigureContainer(ContainerBuilder builder)
{
    builder.RegisterAssemblyTypes(assemblies)//程式集內所有具象類 
        .Where(cc =>cc.Name.EndsWith("Repository")|//篩選
               cc.Name.EndsWith("Service"))
        .As(x=>x.GetInterfaces()[0])//反射出其實作的介面，并指定以其實作的第一個介面型別暴露
}

指定所有實作的介面型別進行暴露

使用AsImplementedInterfaces()函式實作，相當于一個類實作了幾個介面（interface）就會暴露出幾個服務，等價于上面連寫多個As()的作用，

publi void ConfigureContainer(ContainerBuilder builder)
{
builder.RegisterAssemblyTypes(asm)
       .Where(t => t.Name.EndsWith("Repository"))
       .AsImplementedInterfaces();//自動以其實作的所有介面型別暴露（包括IDisposable介面）
}

4.3 決議服務

在注冊完組件并暴露相應的服務后, 可以從創建的容器或其生命周期中決議服務，

使用 Resolve() 方法來決議實作：

通過梳理Autofac所有可用的決議服務方法，顯示如下圖展示的流程圖，

在注冊完組件并暴露相應的服務后, 你可以從創建的容器或其子生命周期中決議服務. 讓我們使用 Resolve() 方法來實作:

var builder = new ContainerBuilder();
builder.RegisterType<MyComponent>().As<IService>();
var container = builder.Build();

using(var scope = container.BeginLifetimeScope())
{
  var service = scope.Resolve<IService>();
}

4.3.1 決議時傳參

當決議服務時, 需要傳參，可以使用Resolve() 方法來接受可變長度的引數，

可用引數型別

NamedParameter - 通過名稱匹配目標引數

TypedParameter - 通過型別匹配目標引數 (需要匹配具體型別)

ResolvedParameter - 靈活的引數匹配

反射組件的引數

var reader = scope.Resolve<ConfigReader>(new NamedParameter("configSectionName", "sectionName"));

Lambda運算式組件的引數
不顯式呼叫Resolve傳參

4.3.2 隱式關系型別

這里不做詳細說明，詳見官方檔案

4.4 生命周期

下面講下AutoFac定義的幾種生命周期作用域，并與.NET Core默認的生命周期作了簡要的對比，

4.4.1 暫時性

每次在向服務容器進行請求時都會創建新的實體，相當于每次都new出一個，

注冊方式：

使用InstancePerDependency()方法標注，如果不標注，這也是默認的選項，以下兩種注冊方法是等效的：

//不指定，默認就是瞬時的
builder.RegisterType<TransientService>().As<ITransientService>();

//指定其生命周期域為瞬時
builder.RegisterType<TransientService>().As<ITransientService>().InstancePerDependency();

對比：

與默認的容器中自帶的生命周期AddTransient相同，也是每次都是全新的實體，
使用AddTransient()注冊：

 services.AddTransient<ITransientService, TransientService>()

4.4.2 作用域內

在每次Web請求時被創建一次實體，生命周期橫貫整次請求，即在每個生命周期作用域內是單例的，

注冊方式：

使用InstancePerLifetimeScope()方法標識：

builder.RegisterType<ScopedService>().As<IScopedService>().InstancePerLifetimeScope();

對比

與默認的容器中自帶的生命周期AddScoped相同，.NET Core框架自帶的容器全權接管了請求和生命周期作用域的創建，使用Scoped()可以實作相同的效果，
使用AddScoped()注冊：

 services.AddScoped<IScopedService, ScopedService>();

4.4.3 匹配作用域內

即每個匹配的生命周期作用域一個實體，
該型別其實是上面的“作用域內”的其中一種，可以對實體的共享有更加精準的控制.，我們通過允許給域“打標簽”，只要在這個特定的標簽域內就是單例的，

注冊
使用InstancePerMatchingLifetimeScope(string tagName)方法注冊：

var builder = new ContainerBuilder();
builder.RegisterType<Worker>().InstancePerMatchingLifetimeScope("myrequest");

當你開始一個生命周期時, 提供的標簽值和它就關聯起來了，

決議

// myrequest標簽子域一
using(var scope1 = container.BeginLifetimeScope("myrequest"))
{
  for(var i = 0; i < 100; i++)
  {
    var w1 = scope1.Resolve<Worker>();
    using(var scope2 = scope1.BeginLifetimeScope())
    {
      var w2 = scope2.Resolve<Worker>();

      //決議了2次，但2次都是同一個實體（w1和w2指向同一個記憶體塊Ⅰ）
    }
  }
}

// //myrequest標簽子域二
using(var scope3 = container.BeginLifetimeScope("myrequest"))
{
  for(var i = 0; i < 100; i++)
  {
   //因為標簽域內已注冊過，所以可以決議成功
    var w3 = scope3.Resolve<Worker>();
    using(var scope4 = scope3.BeginLifetimeScope())
    {
      var w4 = scope4.Resolve<Worker>();
       //因為和上面不是同一個子域,所以決議出的實體w3, w4是同一個實體，但與之前的w1, w2并不是同一個實體 
    }
  }
}

//無標簽子域三
using(var noTagScope = container.BeginLifetimeScope())
{
  // 如果你嘗試從一個名稱并不匹配的生命周期中決議一個每個匹配生命周期作用域的組件你會得到一個例外!
  var fail = noTagScope.Resolve<Worker>();
}

如果你嘗試從一個名稱并不匹配的生命周期中決議一個每個匹配生命周期作用域的組件你會得到一個例外!

4.4.4 全域單例

即全域只有一個實體，即每一個后續請求都使用同一個實體，

注冊方式：

使用SingleInstance()方法標識：

 builder.RegisterType<SingletonService>().As<ISingletonService>().SingleInstance()

對比

與默認的容器中自帶的生命周期AddSingleton相同，
使用AddSingleton();注冊：

services.AddSingleton<ISingletonService, SingletonService>();

還有其他生命周期補充：

每個請求一個實體(Instance Per Request) ：其實是一種的“匹配作用域內單例”的一種，

每次被擁有一個實體(Instance Per Owned)

執行緒作用域(Thread Scope)

這幾種在這不做詳細說明，具體可以查看官網，

4.5 小結

在.NET Core中默認的容器自帶生命周期只有3種型別，而相比于autofac，其顯得更加豐富復雜些，

五、總結

本篇主要介紹autofac框架的使用，從注冊組件，到暴露服務，及決議服務的各個程序，

同時也與.NET Core框架默認容器相比，更加豐富了一些注冊方法和更復雜的生命周期，在應用上，也更加輕巧快捷，特別是在批量注冊上更顯實用，

文章展示的思維導圖

https://www.processon.com/view/link/6072ed8863768912ae50b483

參考資料：Autofac官方網站：

https://autofaccn.readthedocs.io/en/latest/getting-started/index.html

好啦，這篇文章就先講述到這里吧，希望對大家有所幫助，

如果有不對的或不理解的地方，希望大家可以多多指正，提出問題，一起討論,不斷學習,共同進步，??

轉載請註明出處，本文鏈接：https://www.uj5u.com/net/275640.html

標籤：.NET技术

上一篇：VS中設定版本號自動遞增

下一篇：VS中設定版本號自動遞增

Autofac 框架初識與應用

一、前言

二、說明

三、開始

3.1 默認容器

3.2 Autofac框架

3.3 測驗

四、說明

4.1 注冊組件

4.1.1 反射注冊

4.1.2 實體注冊

4.1.3 Lambda運算式注冊

4.1.4 泛型注冊

4.1.5 條件注冊

4.1.6 屬性注入

4.1.7 程式集注冊

4.2 暴露服務

4.2.1 默認暴露自身型別服務

4.2.2 多個暴露服務型別

4.2.3 程式集注冊指定暴露型別

4.3 決議服務

4.3.1 決議時傳參

4.3.2 隱式關系型別

4.4 生命周期

4.4.1 暫時性

4.4.2 作用域內

4.4.3 匹配作用域內

4.4.4 全域單例

4.5 小結

五、總結