(2)Asp.Net Core 依赖关系注入(服务)
1.前言
面向对象设计(ood)里有一个重要的思想就是依赖倒置原则(dip),并由该原则牵引出依赖注入(di)、控制反转(ioc)及其容器等老生常谈的概念,初学者很容易被这些概念搞晕(包括我在内),在学习core依赖注入服务之前,下面让我们先了解下依赖倒置原则(dip)、依赖注入(di)、控制反转(ioc)等概念,然后再深入学习core依赖注入服务。
2.依赖倒置原则(dip)
高层模块不依赖于低层模块的实现,而低层模块依赖于高层模块定义的接口。通俗来讲,就是高层模块定义接口,低层模块负责实现。
2.依赖注入(di)
2.1依赖(d)
当一个类需要另一个类协作来完成工作的时候就产生了依赖。
示例1:
public class mydependency { public mydependency() { } public task writemessage(string message) { console.writeline($"mydependency.writemessage called. message: {message}"); return task.fromresult(0); } } public class indexmodel : pagemodel { mydependency _dependency = new mydependency(); public void onget() { _dependency.writemessage("indexmodel.onget created this message."); } }
由上述代码可以看到indexmodel 模块输出消息必须要实例化mydependency模块,也就是说indexmodel 模块业务的实现必须依赖于mydependency模块,这就是依赖。
2.2 注入(i)
根据dip设计原则:高层模块不依赖于低层模块的实现,而低层模块依赖于高层模块定义的接口,所以我们在这里定义一个接口供高层模块调用,底层模块负责实现。
示例2:
public interface imydependency { task writemessage(string message); } public class mydependency: imydependency { public mydependency() { } public task writemessage(string message) { console.writeline($"mydependency.writemessage called. message: {message}"); return task.fromresult(0); } } public class indexmodel : pagemodel { imydependency _dependency = new mydependency(); public void onget() { _dependency.writemessage("indexmodel.onget created this message."); } }
从上述代码可以看到当我们调用indexmodel 模块ongetasync方法的时候,是通过imydependency接口实例化mydependency类去实现其方法内容的,这叫控制正转。但是master说,我们不应该创建mydependency类,而是让调用者给你传递,于是你通过构造函数让外界把这两个依赖给你。
示例3:
public interface imydependency { task writemessage(string message); } public class mydependency : imydependency { private readonly ilogger<mydependency> _logger; public mydependency(ilogger<mydependency> logger) { _logger = logger; } public task writemessage(string message) { _logger.loginformation( "mydependency.writemessage called. message: {message}", message); return task.fromresult(0); } } public class indexmodel : pagemodel { private readonly imydependency _dependency; public indexmodel(imydependency dependency) { _dependency = dependency; } public void onget() { _dependency.writemessage("indexmodel.onget created this message."); } }
从上述代码可以看到把依赖的创建丢给第三方系统(例:autofac,unity容器),也叫控制反转(ioc)容器。自己只负责使用,其它人丢给你依赖的这个过程理解为注入。也叫控制反转(ioc)。注意,框架内部ilogger接口已注入,无需手动再重新注入。
2.3 ioc容器
ioc容器可以看作是负责统一管理依赖关系的地方。常见有autofac,unity。
容器只要负责两件事情:
●绑定服务与实例之间的关系
●获取实例,并对实例进行管理(创建与销毁)
3.依赖倒置原则(dip)与控制反转(ioc)的区别
dip是一种软件设计原则,它仅仅告诉你高低层模块之间应该如何依赖,但是它并没有告诉我们如何解除相互依赖模块的耦合。而ioc则是一种软件设计模式,它告诉我们该如何解除模块的耦合,它为相互依赖的组件提供抽象,将依赖(低层模块)对象的获得交给第三方系统(例:autofac,unity容器)来控制,即依赖对象不在被依赖模块的类中直接通过new来获取。
4.net core依赖注入(di)服务
经过上面描述,大家应该应该对依赖倒置原则(dip)、依赖注入(di)、控制反转(ioc)这几个概念有一定了解对吧。在.net core中di的核心分为两个组件:iservicecollection和 iserviceprovider。
●iservicecollection负责注册
●iserviceprovider负责提供实例
下面让我们来学习下net core是怎么依赖注入(di)服务。
第一步:使用接口来实现依赖反转。定义 imydependency 服务。
public interface imydependency { task writemessage(string message); }
第二步:定义imydependency 服务的实现类mydependency。
public class mydependency : imydependency { private readonly ilogger<mydependency> _logger; public mydependency(ilogger<mydependency> logger) { _logger = logger; } public task writemessage(string message) { _logger.loginformation( "mydependency.writemessage called. message: {message}", message); return task.fromresult(0); } }
第三步:把imydependency 服务注册到服务容器中。
public void configureservices(iservicecollection services) { //注册将服务生命期的范围限定为单个请求的生命期,下节再来聊服务生命期 services.addscoped<imydependency, mydependency>(); }
第四步:把服务注入到使用它的类的构造函数中。在homecontroller里面调用indexmodel.onget方法输出writemessage消息。
public class indexmodel : pagemodel { private readonly imydependency _dependency; public indexmodel(imydependency dependency) { _dependency = dependency; } public void onget() { _dependency.writemessage("indexmodel.onget created this message."); } } private readonly imydependency _imydependency; public homecontroller(imydependency imydependency) { _imydependency = imydependency; } public iactionresult index() { indexmodel _indexmodel = new indexmodel(_imydependency); _indexmodel.onget(); return view(); }
writemessage日志消息如下:
5.默认服务容器替换
下面我们将来演示内置容器怎么替换为其他容器示例,比如替换第三方 autofac容器,我们需要在startup.configureservices方法里面注册autofac容器,具体代码如下:
public iserviceprovider configureservices(iservicecollection services) { // add autofac var containerbuilder = new containerbuilder(); containerbuilder.registermodule<defaultmodule>(); containerbuilder.populate(services); var container = containerbuilder.build(); return new autofacserviceprovider(container); }
这里需要注意的是如果需要使用第三方容器,startup.configureservices 必须返回 iserviceprovider。然后自定义一个模块类配置依赖关系,具体代码如下:
public class defaultmodule : module { protected override void load(containerbuilder builder) { builder.registertype<characterrepository>().as<icharacterrepository>(); } }
应用程序在运行时,使用 autofac 来解析类型,并注入依赖关系。
参考文献:
在asp.net core依赖注入
推荐阅读
-
.NET Core ASP.NET Core Basic 1-2 控制反转与依赖注入
-
详解ASP.NET Core 在 JSON 文件中配置依赖注入
-
ASP.NET Core依赖注入系列教程之服务的注册与提供
-
ASP.NET Core 2.2 WebApi 系列【三】AutoFac 仓储接口的依赖注入
-
ASP.NET Core笔记(2) - 依赖注入
-
ASP.NET CORE 使用Consul实现服务治理与健康检查(2)——源码篇
-
ASP.NET Core - 在ActionFilter中使用依赖注入
-
asp.net core 依赖注入实现全过程粗略剖析(2)
-
asp.net core 系列 3 依赖注入
-
asp.net core 依赖注入实现全过程粗略剖析(1)