.NET Core依赖注入与Autofac注入介绍
0 前言
本文主要介绍了ASP.NET Core自带的依赖注入框架的用法,然后针对原生框架的不足,介绍了更加完备的autofac框架的集成和使用。
1 .NET Core原生DI框架
.Net Core自带一个依赖注入的框架,使用起来很是方便,不多说,先从简单示例做起。
1.1 简单示例
以ASP.NET Core web的API项目为例:
首先,定义接口IPay和实现类WxPay:
public interface IPay
{
void Pay();
}
public void Pay()
{
Console.WriteLine("wxpay");
}
然后在Startup类中的ConfigureService方法中进行注册:
services.AddScoped<IPay, WxPay>();
接着,就可以在Contoller中使用构造函数注入:
[ApiController]
[Route("[controller]")]
public class WeatherForecastController : ControllerBase
{
private readonly IPay pay;
public WeatherForecastController(IPay pay)
{
this.pay = pay;
}
[HttpGet]
public string Get()
{
return pay.Pay();
}
}
最后,启动程序,看到输出:
wxpay
1.2 生存周期
* Singleton: 单例模式,即在整个应用程序生存期内只会有一个实例
* Scoped:作用域对象在一个客户端请求中是相同的,但在多个客户端请求中是不同的
* Transient:暂时性对象始终不同,无论是不是同一个请求(同一个请求里的不同服务)同一个客户端,每次都是创建新的实例
对Transient的模式,我个人还没怎么理解,暂时先放在这里。
按我个人的想法,正常情况下使用Scoped模式,保证在当前请求内保证一致即可。而Transient模式的场景感觉就是在同一个请求中,获取服务后进行业务操作时,获取相关服务的数据状态发生了变更,因此在再次使用时,需要重新获取服务状态,因此使用暂时模式。
这个可以参见一下几个理解:
另外,看官方文档上的示例:MSDN
1.3 同一接口多个实现
对于IPay接口来说,除了WxPay我们还有AliPay的支付方式,
public string Pay()
{
return "AliPay";
}
此时在DI注入时就需要将两个都注入:
services.AddScoped<IPay, WxPay>();
services.AddScoped<IPay, AliPay>();
然后我们再运行代码,会发现页面此时的输入变成了:AliPay。 说明这种情况下注入的是最后一次的接口实现。
那么如何获取到其他的实现呢?
我们可以通过注入IEnumerable<IPay>来实现。
[ApiController]
[Route("[controller]")]
public class WeatherForecastController : ControllerBase
{
private readonly IPay pay;
private readonly IEnumerable<IPay> payList;
public WeatherForecastController(IPay pay, IEnumerable<IPay> payList)
{
this.pay = pay;
this.payList = payList;
}
[HttpGet]
public string Get()
{
var sb = new StringBuilder();
foreach (var pay in payList)
{
sb.AppendLine(pay.Pay());
}
return sb.ToString();
}
}
此时,运行后得到的输出是:
wxpay
AliPay
这样根据注入payList的类型就能得到所对应的服务实现。当然也可以使用一个工厂类将所有实现注入,然后通过服务类型的方式进行获取。
不过,更推荐使用下面要介绍的Autofac来命名实现。
2 Autofac
Autofac是.net语言的老牌依赖注入框架了,详细的见其官网,我们只管拿来用就完事了。
2.1 简单配置
- 安装autofac
这个不多说了,在Nuget Packge管理界面查找安装即可。
- Program.cs启动配置
需要在CreateHostBuilder中对autofac进行配置,使用UseServiceProviderFactory(new AutofacServiceProviderFactory()), 将服务提供程序注入到.net core中:
public static IHostBuilder CreateHostBuilder(string[] args) =>
Host.CreateDefaultBuilder(args)
.UseServiceProviderFactory(new AutofacServiceProviderFactory())
.ConfigureWebHostDefaults(webBuilder =>
{
webBuilder.UseStartup<Startup>();
});
- 在Startup类中进行接口注入
为了代码结构的阅读方便,我们使用一个单独的注入类DependencyRegister,在类中实现对接口的注入:
public static class DependencyRegister
{
public static ContainerBuilder Register(ContainerBuilder builder)
{
builder.RegisterType<MyService>().As<IMyInterface>();
return builder;
}
}
注入容器我们需要添加ConfigureContainer方法,然后在Startup.cs中添加:
public void ConfigureContainer(ContainerBuilder builder)
{
DependencyRegister.Register(builder);
}
至此,MyService作为IMyInterface的实现就在容器中,在controller类中通过像.net core中一样的构造注入方式就能得到对应的实例。
2.2 命名:同一接口多个实现
还是以上面的IPay为例,我们在DependencyRegister的Register()中添加:
builder.RegisterType<WxPay>().Named<IPay>(typeof(WxPay).Name);
builder.RegisterType<AliPay>().Named<IPay>(typeof(AliPay).Name);
上面表示往容器中分别注册了两个名为"WxPay","AliPay"的IPay接口实现。
autofac可以通过注入IComponentContext来获取上下文,然后从上下文中通过名称来获取对应的接口实现。
如我们新增一个homeController,代码如下:
[ApiController]
[Route("home")]
public class HomeController : ControllerBase
{
private readonly IPay wxPay;
private readonly IPay aliPay;
public HomeController(IComponentContext componentContext)
{
builder.RegisterType<WxPay>().Named<IPay>(typeof(WxPay).Name);
builder.RegisterType<AliPay>().Named<IPay>(typeof(AliPay).Name);
}
[Route("test")]
[HttpGet]
public string Test()
{
var str = new StringBuilder();
str.AppendLine(wxPay.Pay());
str.AppendLine(aliPay.Pay());
return str.ToString();
}
}
运行代码,访问/home/test,同样能见到两个接口的输出。
2.3 按条件批量注入
日常开发中,新增接口和实现是很多的,如果每次新增都需要手动添加的话是比较繁琐的。于是我们可以用通过通配符的方式来实现自动批量注入,如下面查询以Pay为结尾的类:
var assembly1 = Assembly.GetExecutingAssembly();
builder.RegisterAssemblyTypes(assembly1)
.PublicOnly()
.Where(r => r.Name.EndsWith("Pay"))
.AsImplementedInterfaces();
实际上,我们将所有接口的实现类都约定以Service结尾即可,后续新增均无需修改此类。