Asp.Net Core 进阶（三）—— IServiceCollection依赖注入容器和使用Autofac替换它

时间  2019-12-13
标签 asp.net asp core 进阶 iservicecollection 依赖 注入 容器 使用 autofac 替换 栏目 ASP 繁體版
原文   原文链接

　　Asp.Net Core 提供了默认的依赖注入容器 IServiceCollection，它是一个轻量级的依赖注入容器，因此功能很少，只是提供了基础的一些功能，要实现AOP就有点麻烦，所以在实际工做当中，咱们经常会使用第三方依赖注入容器替换掉Asp.Net Core自带的依赖注入容器。cookie

　　咱们先来看下Asp.Net Core自带依赖注入容器IServiceCollection的主要用法，虽说在工做中常常会被替换掉，但有些状况下使用该自带的就已经足够了，因此天然也就须要先了解它的使用方法。ide

　　IServiceCollection依赖注入生命周期和其余大多数依赖注入容器同样，分为 瞬时生命周期、单例和请求单例。咱们能够在Startup.cs文件中的ConfigureServices方法中直接使用它。这里咱们单独把它拿出来看一下具体怎么使用，咱们定义ITestService1,ITestService2,ITestService3,ITestService4以及他们的4个实现类。函数

IServiceCollection container = new ServiceCollection();
container.AddTransient<ITestService1, TestService1>();//瞬时生命周期 
container.AddSingleton<ITestService2, TestService2>();//单例：全容器都是一个
container.AddScoped<ITestService3, TestService3>();//请求单例：一个请求做用域是一个实例
container.AddSingleton<ITestService4>(new TestService4());

var provider = container.BuildServiceProvider();
ITestService1 testService1 = provider.GetService<ITestService1>();
ITestService1 testService2 = provider.GetService<ITestService2>();
Console.WriteLine(object.ReferenceEquals(testService1, testService2));//输出 false

ITestService2 testService2_1 = provider.GetService<ITestService2>();
ITestService2 testService2_2 = provider.GetService<ITestService2>();
Console.WriteLine(object.ReferenceEquals(testService2_1, testService2_2));//输出 true

ITestService3 testService3_1 = provider.GetService<ITestService3>();
ITestService3 testService3_2 = provider.GetService<ITestService3>();
Console.WriteLine(object.ReferenceEquals(testService3_1, testService3_2));//输出 true var scope1 = provider.CreateScope();
var scope2 = provider.CreateScope();
ITestService3 testService3_3 = scope1.ServiceProvider.GetService<ITestService3>();
ITestService3 testService3_4 = scope2.ServiceProvider.GetService<ITestService3>();
Console.WriteLine(object.ReferenceEquals(testService3_3, testService3_4)); //输出 false

ITestService4 testService4_1 = provider.GetService<ITestService4>();
ITestService4 testService4_2 = provider.GetService<ITestService4>();
Console.WriteLine(object.ReferenceEquals(testService4_1, testService4_2)); //输出 true

 　　上述代码已经能够很好的阐述了IServiceCollection的用法，可是这些也只是基本的功能，接下来咱们就来看下使用Autofac如何替换掉IServiceCollection。测试

　　 Autofac是一个Microsoft .NET的IoC容器。 它管理类与类之间的依赖关系，使得应用程序层级之间实现了解耦，不至于在应用程序变得愈来愈复杂的状况下难以修改。ui

　　 那么如今就一块儿来看看怎么使用Autofac来替换掉Asp.Net Core自带的依赖注入容器吧，首先先来介绍最经常使用也是被推荐使用的构造函数注入方式。在Autofac官方文档中有例子可参考。要使用Autofac替换IServiceCollection，咱们须要在Startup.cs文件中将ConfigureServices方法的返回值从void修改成 IServiceProvider。this

　　在开始以前，咱们须要先从Nuget下载安装Autofac，可使用以下命令进行安装spa

Install-Package Autofac.Extensions.DependencyInjection -Version 4.4.0

　　接下来随便定义两个测试接口和实现类code

 public interface ITestServiceA
    {
        void Show();
    }

    public interface ITestServiceB
    {
        void Show();
    }

    public class TestServiceA : ITestServiceA
    {
        public   void Show()
        {
            Console.WriteLine("This is TestServiceA....");
        }
    }

    public class TestServiceB : ITestServiceB
    {
        public void Show()
        {
            Console.WriteLine("This is TestServiceB....");
        }
    }

　　接下来咱们修改Startup.cs的ConfigureServices方法对象

// This method gets called by the runtime. Use this method to add services to the container.
public IServiceProvider ConfigureServices(IServiceCollection services)
{
    services.Configure<CookiePolicyOptions>(options =>
    {
        // This lambda determines whether user consent for non-essential cookies is needed for a given request.
        options.CheckConsentNeeded = context => true;
        options.MinimumSameSitePolicy = SameSiteMode.None;
    });
    services.AddSession();
    services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2);

    var containerBuilder = new ContainerBuilder();

    containerBuilder.RegisterModule<AutofacInitModule>();

    // Populate 方法是最重要的，若是没有调用这个方法，则没法将注入到 IServiceCollection的内置对象填充到autofac中,像控制器注入，Log注入等，程序会报错。
    containerBuilder.Populate(services);

    var container = containerBuilder.Build();
    return new AutofacServiceProvider(container);
}

　　AutofacInitModule类是继承了Autofac.Module类的子类，咱们能够重写Load方法进行Autofac的初始化注入，固然也能够直接写在Startup文件的ConfigureServices方法中，单独抽出来会显得不那么臃肿，优雅一些。blog

using Autofac;

namespace WebApplication2
{
    internal class AutofacInitModule : Module
    {
        protected override void Load(ContainerBuilder builder)
        {
            builder.RegisterType<TestServiceA>().As<ITestServiceA>();
            builder.RegisterType<TestServiceB>().As<ITestServiceB>();

            // builder.RegisterType<TestServiceA>().As<ITestServiceA>().SingleInstance(); //单例
        }
    }
}

　　如今咱们就能够在Controller中使用了

public class HomeController : Controller
{
    private readonly ILogger<HomeController> _logger;
    private readonly ITestServiceA _serviceA;
    private readonly ITestServiceB _serviceB;


    public HomeController(ILogger<HomeController> logger, ITestServiceA serviceA, ITestServiceB serviceB)
    {
        this._logger = logger;
        this._serviceA = serviceA;
        this._serviceB = serviceB;
    }

    public IActionResult Index()
    {
        this._serviceA.Show();
        this._serviceB.Show();
        this._logger.LogWarning("this is logger....");
        return View();
    } 
}

　　运行程序，能够看到_logger、_serviceA、_serviceB都成功的被建立了。

　　那么上述是使用的autofac的构造函数注入，虽然是最被推荐的也是最经常使用的注入方式，可是autofac也提供了属性注入的方式，下面咱们也了解一下。

　　修改Startup.cs的ConfigureServices方法和AutofaceInitModule类

// This method gets called by the runtime. Use this method to add services to the container.
public IServiceProvider ConfigureServices(IServiceCollection services)
{
    services.Configure<CookiePolicyOptions>(options =>
    {
        // This lambda determines whether user consent for non-essential cookies is needed for a given request.
        options.CheckConsentNeeded = context => true;
        options.MinimumSameSitePolicy = SameSiteMode.None;
    });
    services.AddSession();
    services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2).AddControllersAsServices();

    var containerBuilder = new ContainerBuilder();

    // Populate 方法是最重要的，若是没有调用这个方法，则没法将注入到 IServiceCollection的内置对象填充到autofac中,像控制器注入，Log注入等，程序会报错。
    containerBuilder.Populate(services);

    containerBuilder.RegisterModule<AutofacInitModule>();

    var container = containerBuilder.Build();
    return new AutofacServiceProvider(container);
}
using Autofac;
using Microsoft.AspNetCore.Mvc;
using System.Linq;

namespace WebApplication2
{
    internal class AutofacInitModule : Module
    {
        protected override void Load(ContainerBuilder builder)
        {
            //注册服务
            builder.RegisterType<TestServiceA>().As<ITestServiceA>().PropertiesAutowired();
            builder.RegisterType<TestServiceB>().As<ITestServiceB>().PropertiesAutowired();

            //注册全部控制器
            var controllersTypesInAssembly = typeof(Startup).Assembly.GetExportedTypes()
            .Where(type => typeof(ControllerBase).IsAssignableFrom(type)).ToArray();

            builder.RegisterTypes(controllersTypesInAssembly).PropertiesAutowired();

            // builder.RegisterType<TestServiceA>().As<ITestServiceA>().SingleInstance(); //单例
        }
    }
}

须要注意的是 services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2).AddControllersAsServices();和

containerBuilder.Populate(services);须要写在注入服务以前，属性注入才能成功。

    public class HomeController : Controller
    {
        //private readonly ILogger<HomeController> _logger;
        //private readonly ITestServiceA _serviceA;
        //private readonly ITestServiceB _serviceB;

        public ILogger<HomeController> Logger { get; set; }
        public ITestServiceA ServiceA { get; set; }
        public ITestServiceB ServiceB { get; set; }

        //public HomeController(ILogger<HomeController> logger, ITestServiceA serviceA, ITestServiceB serviceB)
        //{
        //    this._logger = logger;
        //    this._serviceA = serviceA;
        //    this._serviceB = serviceB;
        //}

        public IActionResult Index()
        {
            //this._serviceA.Show();
            //this._serviceB.Show();
            //this._logger.LogWarning("this is logger....");

            Logger.LogWarning(ServiceA.Show());
            Logger.LogWarning(ServiceB.Show());

            return View();
        } 
    }

　　运行能够看到成功的结果

　　最后，在一开始以前，咱们提到Asp.Net Core自带的依赖注入容器在实现AOP的功能很麻烦，在工做中经常会替换成第三方的依赖注入容器，那么如今咱们再来看一下autofac怎么实现AOP。

　　Autofac实现AOP须要引入Autofac.Extras.DynamicProxy库，经过Nuget添加该库

Install-Package Autofac.Extras.DynamicProxy -Version 4.5.0

　　接着为了实现AOP，咱们定义以下类和接口

using Autofac.Extras.DynamicProxy;
using Castle.DynamicProxy;
using Microsoft.Extensions.Logging;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;

namespace WebApplication2
{
    public class AutofacTestAop : IInterceptor
    {
        public void Intercept(IInvocation invocation)
        {
            Console.WriteLine($"invocation.Methond={invocation.Method}, invocation.Arguments={string.Join(",", invocation.Arguments)}");

            invocation.Proceed(); //继续执行TestAop.Show

            Console.WriteLine($"Method {invocation.Method} Excuted");
        }
    }

    public interface ITestAop
    {
        void Show();
    }

    [Intercept(typeof(AutofacTestAop))]
    public class TestAop : ITestAop
    {
        private ILogger<TestAop> _logger;

        public TestAop(ILogger<TestAop> logger)
        {
            this._logger = logger;
        }

        public void Show()
        {
            this._logger.LogWarning("this is TestAop .....");
        }
    }
}

　　AutofacTestAop为实现了IInterceptor的类，它的Intercept方法就是用来作AOP的调用的。除了实现这个方法外，在须要添加AOP功能的类上须要添加特性 [Intercept(typeof(AutofacTestAop))] 。最后须要在AutofacInitModule中配置一下启用 EnableInterfaceInterceptors。

using Autofac;
using Autofac.Extras.DynamicProxy;
using Microsoft.AspNetCore.Mvc;
using System.Linq;

namespace WebApplication2
{
    internal class AutofacInitModule : Module
    {
        protected override void Load(ContainerBuilder builder)
        {
            //注册服务
            builder.RegisterType<TestServiceA>().As<ITestServiceA>();
            builder.RegisterType<TestServiceB>().As<ITestServiceB>();

            builder.Register(c => new AutofacTestAop());
            builder.RegisterType<TestAop>().As<ITestAop>().EnableInterfaceInterceptors();

            // builder.RegisterType<TestServiceA>().As<ITestServiceA>().SingleInstance(); //单例
        }
    }
}

　　最后在HomeController中调用ITestAop的Show方法就会先执行AutofacTestAop里的Intercept方法了。

相关文章
相关标签/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公众号
   欢迎关注本站公众号,获取更多信息
联系我们 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程