依赖注入在 dotnet core 中实现与使用:1 基本概念

关于 Microsoft Extension: DependencyInjection 的介绍已经很多,但是多数偏重于实现原理和一些特定的实现场景。作为 dotnet core 的核心基石,这里准备全面介绍它的概念、原理和使用。

这里首先介绍概念部分。

1. 概念

该项目在 GitHub 的地址:https://github.com/aspnet/Extensions/tree/master/src/DependencyInjection

Microsoft.Extensions.DependencyInjection 是微软对依赖倒置原则的实现。作为 ASP.NET Core 的基石,DependencyInjection 贯穿了整个项目的方方面面,掌握它的使用方式和原理,不仅对理解 ASP.NET Core 有重要意义,也有助于将它运用到其它项目的开发中,帮助提供项目开发的效率和质量。

1.1 问题的场景

在软件开发中,项目通常有多个不同的模块组成,模块之间存在依赖关系。例如,我们考虑一个简化的场景,我们有 3 个关于用户的类:

  1. AccountController,提供用户交互界面
  2. UserService,提供用户管理的业务逻辑
  3. UserRepository,提供用户管理的数据访问

AccountController 内部需要使用 UserService 的实例 来管理用户,而 UserService 内部则需要基于 UserRepository 来提供数据访问。我们称它们之间存在依赖关系。或者表达为,AccountController 依赖于 UserService ,而 UserService 依赖于 UserRepository 。而依赖注入就是用来帮助我们实现依赖管理的有力工具。

1.2 依赖倒置原则 DIP

依赖倒置原则是广为人知的设计原则之一,该原则是实现软件项目中模块的解耦的理论基石。

原则的定义如下:

High level modules should not depend upon low level modules,Both should depend upon abstractions.Abstractions should not depend upon details.Details should depend upon abstracts.

翻译过来为:

  • 高层模块不应该依赖低层模块,两者都应该依赖抽象
  • 抽象不应该依赖细节
  • 细节应该依赖抽象

在没有实现依赖倒置原则的时候,我们通过在 AccountController 类中自己通过 new 关键字来创建其依赖的 UserService 对象实例,

public class AccountController {
?
    private readonly UserService _userService;
    public AccountController() {
        this._userService = new UserService();
    }
}

这导致了两个类之间的紧耦合,AccountControllerUserService 被绑定到一起, 在每次创建 AccountController 的时候,一定会创建一个 UserService 的对象实例,而如果我们需要测试 AccountController 的时候,也就不得不考虑 UserService,这样一级一级的依赖下来,UserService 又会依赖 UserRepository,就会发现项目中的类都被绑定在一起, 紧密耦合,难以分拆。

基于依赖倒置的原则,通常会考虑通过接口进行隔离。例如,我们可能会定义一个用户服务的接口:

public interface IUserService
{
}

而用户服务则会实现该接口

public class UserService : IUserService {
}

AccountController 类中,则改变成了基于接口来使用 UserService

public class AccountController {
?
    private readonly IUserService _userService;
    public AccountController() {
        this._userService = new UserService();
    }
}

虽然在 HomeController 内部,我们可以基于接口编程了,但是这样的作法并没有解决自己通过 new 来获取 UserService 对象实例的问题。

1.3 控制反转 IoC

IoC是一种著名的实现 DIP 的设计模式。

它的核心思想是:在需要对象实例的时候,不要总考虑自己通过 new 来创建对象,放下依赖对象的创建过程,而是把创建对象的工作交给别人来负责,这个别人我们通常称为 容器 (Container) 或者 服务提供者 (ServiceProvider), 我们后面使用这个 ServiceProvider 来指代它,

在需要对象实例的时候,从这个 ServiceProvider 中获取。

下面是一个广泛使用的示意图。拿总是要拿的,但是从 自己穿上 变成了 给你穿上

在控制反转中,引入了一个 ServiceProvider 来帮助我们获得对象实例。

1.4 依赖注入 DI (DependencyInjection)

DI 是 IoC 模式的一种实现。

《Expert one on one J2EE Development without EJB》第 6 章

IoC 的主要实现方式有两种:依赖查找,依赖注入 (p128)

依赖注入是一种更可取的方式。(p130)

Martin Fowler 的原文:

As a result I think we need a more specific name for this pattern. Inversion of Control is too generic a term, and thus people find it confusing. As a result with a lot of discussion with various IoC advocates we settled on the name Dependency Injection.

大意是:

已经存在某种模式,该模式被称为 IoC,但 IoC 太过广义,任何框架都 IoC,为了让表意更明确,决定采用 DI 来精确指称它。

DI 的实现有多种,我们这里介绍的是微软官方在 Microsoft Extension 中内置提供的 DependencyInjection。它是 IoC 中一种实现,ASP.NET Core 的整个核心基于它来实现。同时,我们也可以在其它项目中使用,以实现对依赖倒置原则的支持。

2. DependencyInjection 中的基本概念

2.1 服务描述集合 ServiceCollection

在微软的 DI 实现中,所有的服务需要首先注册到一个公共的服务描述集合中,该集合对于整个 DI 来说,只需要一个,服务只需要在此集合中注册一次,即可在以后通过 DI 提供给使用者。

该集合的接口定义为 IServiceCollection,可以看出来,它其实就是一个用来保存服务注册的集合。

public interface IServiceCollection : IList<ServiceDescriptor>, ICollection<ServiceDescriptor>, IEnumerable<ServiceDescriptor>, IEnumerable
{
}

系统默认已经实现了一个对 IServiceCollection 的实现,名为 ServiceCollection。在 ASP.NET Core 中,内部会创建该对象的实例,我们也可以在其它项目中,自己来创建它,很简单,直接 new 出来就可以使用了。

IServiceCollection services = new ServiceCollection ();

2.2 服务 Service

在 DI 语境中,服务特指通过 DI 容器管理的对象实例。这个服务并不一定被称为 **Service,而是可以是任何由 DI 所管理的对象,只是在 DI 这个语境下,我们将其统称为服务。

服务是我们自己定义的,例如前面提到的 AccountControllerUserService 等等。

我们通过 DI 来获得服务对象实例,管理服务对象的生命周期,对于存在复杂依赖关系的对象, DI 还负责管理这些实例之间的依赖关系。

服务必须首先注册在 DI 中才能使用,但是,注册前需要首先考虑和决定服务的生命周期。

2.3 服务的生命周期

服务对象实例有着不同类型的生命周期。有些对象的生命周期与应用程序相同,在应用程序启动时创建,在应用程序退出时才需要释放。例如我们的数据访问对象实例。有些对象仅仅在当前方法中使用,在方法调用结束之后就应该销毁。服务的生命周期管理用来管理这些需求。

DI 支持三种类型的生命周期:

  1. Singleton,单例,在当前应用程序环境下只有一个实例。例如数据访问服务对象实例。
  2. Scoped,限定范围,一旦退出此范围,在此范围内的服务对象都需要销毁。例如 Web 开发中的请求对象实例。
  3. Transient,瞬态,一次性使用,每次从 DI 中获取,都返回一个新的实例。

Microsoft.Extensions.DependencyInjection.ServiceLifetime

public enum ServiceLifetime
{
    Singleton,
    Scoped,
    Transient
}

服务的生命周期在注册服务的时候确定。在使用的时候,直接获取实例,不再指定服务的生命周期。微软提供了多种扩展方法来便于在注册服务时指定服务的生命周期。例如下面是通过泛型方式来指定单例模式的生命周期。

// 基于接口的注册
services.AddSingleton<IUserService, UserService>();

2.4 服务提供者 ServiceProvider

在需要使用服务对象实例的时候,不是从注册服务的集合中获取,而是需要通过服务提供者来获取,这个服务提供者显然需要来自注册服务的集合。服务提供者的接口定义为 IServiceProvider,它是 .net 的基础定义之一,不是在该 DI 框架中定义的。

public interface IServiceProvider
{
    object GetService(Type serviceType);
}

DI 中的 ServiceCollectionContainerBuilderExtensions 扩展了 IServiceCollection,提供了获得这个服务提供者 ServiceProvider 的支持。

public static ServiceProvider BuildServiceProvider(this IServiceCollection services)
{
    return BuildServiceProvider(services, ServiceProviderOptions.Default);
}

所以,我们通常使用该方法来获取并使用它。

// 创建注册服务的容器
IServiceCollection services = new ServiceCollection ();
// 注册服务,这里指定了单例
services.AddSingleton<IUserService, UserService>();
// 通过容器获得服务提供者
IServiceProvider provider = services.BuildServiceProvider ();

2.5 获取服务对象实例

通过服务提供者来手动获取服务对象实例。通过注册的服务类型,直接调用 GetService 方法即可。

例如,前面我们注册了服务类型 IUserService 的实现类型是 UserService ,那么,可以通过此类型来获取实际实现该接口的对象实例。

// 创建注册服务的容器
IServiceCollection services = new ServiceCollection ();
// 注册服务,这里指定了单例
services.AddSingleton<IUserService, UserService>();
// 通过容器获得服务提供者
IServiceProvider provider = services.BuildServiceProvider ();
// 通过接口获取服务对象实例
IUserService instance = provider.GetService<IUserService> ();

看起来,更加复杂了。在实际使用中,我们很少使用这样的方式来使用 DI,后面我们再深入讨论具体的使用过程。

原文地址:https://www.cnblogs.com/haogj/p/11370314.html

时间: 2024-08-30 11:25:49

依赖注入在 dotnet core 中实现与使用:1 基本概念的相关文章

依赖注入在 dotnet core 中实现与使用:3 使用 Lazy&lt;T&gt; 延迟实例化

有些对象我们并不想一开始就实例化,由于性能或者功能的考虑,希望等到使用的时候再实例化.考虑存在一个类 A, 它使用了依赖的类 B,在 A 中,只有某些不常用到的方法会涉及调用 B 中的方法,多数情况下,并不使用这个 B 的实例. using System; public class A { private B _b; public A (B b) { _b = b; Console.WriteLine("construct class A..."); } public void Met

spring的依赖注入【NC产品中也用到spring的依赖注入】

下面设计到的类有EditPsndocAction跟RefreshPsndocAction这个两个类, 而我想要的最终效果是: 下面解释一下流程“ 如下图所示:因为NC产品中使用了spring的的依赖注入.所以我这里可以这样子调用.直接调用定刷新按钮的bean . 在EditPsndocAction这个类中,用spring的依赖注入的一个方式.给对象赋值 注意一点就是:RefreshPsndocAction 是刷新按钮对应的ben的名称.也就是 最后在EdictPsndocAction这个类的do

dotnet core 中数值溢出

.net core中使用C#的int类型,存在数值上下限范围,如下: int max = int.MaxValue; int min = int.MinValue; Console.WriteLine($"The range of integers is {min} to {max}"); 运行得到结果 The range of integers is -2147483648 to 2147483647 此时如果执行以下代码 int what = max + 3; Console.Wr

ASP.NET Core依赖注入——依赖注入最佳实践

在这篇文章中,我们将深入研究.NET Core和ASP.NET Core MVC中的依赖注入,将介绍几乎所有可能的选项,依赖注入是ASP.Net Core的核心,我将分享在ASP.Net Core应用中使用依赖注入的一些经验和建议,并且将会讨论这些原则背后的动机是什么: (1)有效地设计服务及其依赖关系. (2)防止多线程问题. (3)防止内存泄漏. (4)防止潜在的错误. 在讨论该话题之前,了解什么是服务是生命周期至关重要,当组件通过依赖注入请求另一个组件时,它接收的实例是否对该组件实例是唯一

ASP.NET Core中使用GraphQL - 第六章 使用EF Core作为持久化仓储

ASP.NET Core中使用GraphQL ASP.NET Core中使用GraphQL - 第一章 Hello World ASP.NET Core中使用GraphQL - 第二章 中间件 ASP.NET Core中使用GraphQL - 第三章 依赖注入 ASP.NET Core中使用GraphQL - 第四章 GrahpiQL ASP.NET Core中使用GraphQL - 第五章 字段, 参数, 变量 本篇中我将演示如何配置持久化仓储,这里原文中是使用的Postgres, 这里我改用

ASP.NET Core中使用GraphQL - 第八章 在GraphQL中处理一对多关系

ASP.NET Core中使用GraphQL - 目录 ASP.NET Core中使用GraphQL - 第一章 Hello World ASP.NET Core中使用GraphQL - 第二章 中间件 ASP.NET Core中使用GraphQL - 第三章 依赖注入 ASP.NET Core中使用GraphQL - 第四章 GrahpiQL ASP.NET Core中使用GraphQL - 第五章 字段, 参数, 变量 ASP.NET Core中使用GraphQL - 第六章 使用EF Co

ASP.NET Core中使用GraphQL - 第五章 字段, 参数, 变量

ASP.NET Core中使用GraphQL ASP.NET Core中使用GraphQL - 第一章 Hello World ASP.NET Core中使用GraphQL - 第二章 中间件 ASP.NET Core中使用GraphQL - 第三章 依赖注入 ASP.NET Core中使用GraphQL - 第四章 GrahpiQL 字段# 我们已经很好的理解了GraphQL中的字段.在之前HelloWorldQuery的例子中,我们添加了2个字段hello和howdy. 它们都是标量字段.正

ASP.NET Core 依赖注入基本用法

ASP.NET Core 依赖注入 ASP.NET Core从框架层对依赖注入提供支持.也就是说,如果你不了解依赖注入,将很难适应 ASP.NET Core的开发模式.本文将介绍依赖注入的基本概念,并结合代码演示如何在 ASP.NET Core中使用依赖注入. 什么是依赖注入? 百度百科对于依赖注入的介绍: 控制反转(Inversion of Control,缩写为IoC),是面向对象编程中的一种设计原则,可以用来减低计算机代码之间的耦合度.其中最常见的方式叫做依赖注入(Dependency I

NET Core,你必须了解无处不在的“依赖注入”

NET Core,你必须了解无处不在的“依赖注入” ASP.NET Core的核心是通过一个Server和若干注册的Middleware构成的管道,不论是管道自身的构建,还是Server和Middleware自身的实现,以及构建在这个管道的应用,都需要相应的服务提供支持,ASP.NET Core自身提供了一个DI容器来实现针对服务的注册和消费.换句话说,不只是ASP.NET Core底层框架使用的服务是由这个DI容器来注册和提供,应用级别的服务的注册和提供也需要以来这个DI容器,所以正如本文标题