ASP.NET Core技术研究-探秘依赖注入框架

原文:ASP.NET Core技术研究-探秘依赖注入框架

ASP.NET Core在底层内置了一个依赖注入框架，通过依赖注入的方式注册服务、提供服务。依赖注入不仅服务于ASP.NET Core自身，同时也是应用程序的服务提供者。

毫不夸张的说，ASP.NET Core通过依赖注入实现了各种服务对象的注册和创建，同时也实现了面向抽象的编程模式和编程体验，提升了应用程序的扩展性。

今天，我们普及一下ASP.NET Core中依赖注入的一些基本知识。

一、服务的注册

我们通过创建一个ASP.NET Core的项目，可以发现在Startup.cs 类中，有一个方法ConfigureServices，这个方法的注释是这样的：

     This method gets called by the runtime. Use this method to add services to the container.

在ConfigureServices方法中我们可以将通过ASP.NET Core内置的依赖注入框架实现服务的的注册。

这个方法有个参数：IServiceCollection，见名知意，服务集合。

ASP.NET Core内置的依赖注入框架将服务注册信息存储到一个实现了IServiceCollection接口的对象中。默认情况下这个接口的实现类是ServiceCollection，以下是这个类的说明：

https://docs.microsoft.com/en-us/dotnet/api/microsoft.extensions.dependencyinjection.servicecollection?view=dotnet-plat-ext-3.1

通过这个接口和类实现，我们可以发现，注册服务其实就是将一个服务的ServiceDescriptor对象添加到ServiceCollection集合中。

例如：

?


1

2

3

4

5

public void ConfigureServices(IServiceCollection services)

{

    services.Add(new ServiceDescriptor(typeof(IUserRepository), new UserRepository()));

    services.AddControllers();

}

ServiceDescriptor可以理解为对某个服务注册项的描述。ASP.NET Core的依赖注入容器IServiceProvider通过ServiceDescriptor的信息，动态创建服务的实例Instance.

我们看一下这个ServiceDescriptor类：

有几个关键的属性：

1. ServiceType：服务的类型，例如服务接口的类型信息

2. ImplementationType：服务的实现类型，例如服务接口实现类的类型信息

3. ImplementationInstance：实现服务的实例，一般是服务单例模式场景下使用。 https://docs.microsoft.com/en-us/dotnet/api/microsoft.extensions.dependencyinjection.servicedescriptor.-ctor?view=dotnet-plat-ext-3.1#Microsoft_Extensions_DependencyInjection_ServiceDescriptor__ctor_System_Type_System_Object_

4. Lifetime：服务生命周期：Scoped（同一个请求中同一个IServiceProvider提供的对象是同一个）、Singleton（单例）、Transient（每次从服务容器进行请求时创建）

5. ImplementationFactory 服务实例创建工厂，自定义的IServiceProvider服务提供容器

服务注册提供了一系列重载的方法，大家可以根据需要进行选择：

服务注册的过程中，涉及到了服务的生命周期的概念，接下来我们详细看一下。

二、服务生命周期

服务的生命周期设置，决定了服务提供容器IServiceProvider使用什么样的方式提供服务实例对象。正如上面第一章节所说的，

ASP.NET Core服务依赖注入框架，支持三种类型的服务生命周期：

  •    Singleton
  •    Scoped
  •    Transient

其中：

Transient：暂时的，每次从服务容器进行请求时创建。 这种生存期适合轻量级、 无状态的服务。

Singleton：单一实例，在第一次请求时（或者在运行 Startup.ConfigureServices 并且使用服务注册指定实例时）创建的。每个后续请求都使用相同的实例。

Scoped：范围内的，作用域生存期服务，以每个客户端请求（连接）一次的方式创建。可以这么理解：同一个请求中同一个IServiceProvider提供的对象是同一个。

微软给了个例子不错：先注册服务，三种类型

?


1

2

3

4

5

6

7

8

9

10

public void ConfigureServices(IServiceCollection services)

{    <br>    services.AddRazorPages(); <br>    services.AddScoped<IMyDependency, MyDependency>();

    services.AddTransient<IOperationTransient, Operation>();

    services.AddScoped<IOperationScoped, Operation>();

    services.AddSingleton<IOperationSingleton, Operation>();

    services.AddSingleton<IOperationSingletonInstance>(new Operation(Guid.Empty));

    //OperationService depends on each of the other Operation types.

    services.AddTransient<OperationService, OperationService>();

}

　　第一个请求：

?


1

2

3

4

5

6

7

8

9

10

11

控制器操作：

暂时性：d233e165-f417-469b-a866-1cf1935d2518

作用域：5d997e2d-55f5-4a64-8388-51c4e3a1ad19

单一实例：01271bc1-9e31-48e7-8f7c-7261b040ded9

实例：00000000-0000-0000-0000-000000000000

OperationService 操作：

暂时性：c6b049eb-1318-4e31-90f1-eb2dd849ff64

作用域：5d997e2d-55f5-4a64-8388-51c4e3a1ad19

单一实例：01271bc1-9e31-48e7-8f7c-7261b040ded9

实例：00000000-0000-0000-0000-000000000000

　　第二个请求：

?


1

2

3

4

5

6

7

8

9

10

11

12

第二个请求：

控制器操作：

暂时性：b63bd538-0a37-4ff1-90ba-081c5138dda0

作用域：31e820c5-4834-4d22-83fc-a60118acb9f4

单一实例：01271bc1-9e31-48e7-8f7c-7261b040ded9

实例：00000000-0000-0000-0000-000000000000

OperationService 操作：

暂时性：c4cbacb8-36a2-436d-81c8-8c1b78808aaf

作用域：31e820c5-4834-4d22-83fc-a60118acb9f4

单一实例：01271bc1-9e31-48e7-8f7c-7261b040ded9

实例：00000000-0000-0000-0000-000000000000

大家可以根据实际的需要选择服务的生命周期，创建不同类型的服务。

三、服务的消费

前面，我们将服务注册到IServiceCollection，ASP.NET Core服务提供容器IServiceProvider就可以根据IServiceCollection 创建具体类型的服务对象了。

我们先看一下IServiceProvider接口，可以发现：只有一个GetService方法。

我们可以通过以下代码使用：

?


1

2

3

4

5

6

7

8

9

10

public static void Main(string[] args)

{

     var builder = CreateHostBuilder(args);           

     var host = builder.Build();

     var userRepo = host.Services.GetService(typeof(IUserRepository)) as IUserRepository;

     userRepo.AddUser("user");

     host.Run();

}

同时，我们更多常用的是：

将服务通过ASP.NET Core依赖注入框架注入到控制器中

ASP.NET Core MVC 控制器通过构造函数显式请求依赖关系。即：通过构造函数注入服务的实现。

前面，我们通过ConfigureServices注册了服务IUserRepository，在Controller这一层如何消费使用这个服务呢？答案就是在Controller构造函数中注入。

看一段示例代码：（HomeController的构造函数中，增加了一个参数IUserRepository）

?


1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

public class HomeController : Controller

  {

      private readonly ILogger<HomeController> _logger;    

      private IUserRepository _userRepository;

      public HomeController(ILogger<HomeController> logger, IUserRepository userRepository)

      {

          _logger = logger;

          _userRepository = userRepository;

      }

      public IActionResult Index()

      {

          _userRepository.AddUser(new User() {  });

          return View();

      }

      public IActionResult Privacy()

      {

          return View();

      }

      [ResponseCache(Duration = 0, Location = ResponseCacheLocation.None, NoStore = true)]

      public IActionResult Error()

      {

          return View(new ErrorViewModel { RequestId = Activity.Current?.Id ?? HttpContext.TraceIdentifier });

      }

  }

　　同时，ASP.NET Core MVC 控制器支持通过注解FromServicesAttribute， 将服务直接注入到Action方法中，而无需使用构造函数注入：

?


1

2

3

4

5

6

public IActionResult Index([FromServices] IUserRepository userRepository)

{

     userRepository.AddUser(new User() {  });

     return View();

}

　 ASP.NET Core除了支持将服务注入到控制器，同时还支持将服务依赖注入到视图，可以参考以下链接：

https://docs.microsoft.com/zh-cn/aspnet/core/mvc/views/dependency-injection?view=aspnetcore-3.0

以上是对ASP.NET Core依赖注入框架的研究，分享给大家。

周国庆

2020/4/12

原文地址：https://www.cnblogs.com/lonelyxmas/p/12688639.html

时间： 2024-10-12 04:16:50

ASP.NET Core技术研究-探秘依赖注入框架的相关文章

ASP.NET Core技术研究-探秘Host主机启动过程

原文:ASP.NET Core技术研究-探秘Host主机启动过程 当我们将原有ASP.NET 应用程序升级迁移到ASP.NET Core之后,我们发现代码工程中多了两个类Program类和Startup类. 接下来我们详细探秘一下通用主机Host的启动过程. 一.Program类的Main函数入口 Program类最重要的功能就是启动主机,这里有一个主机的概念,是ASP.NET Core全新引入的. 主机负责应用程序启动和生存期管理. 同时,主机也是封装应用程序资源的对象: 依赖注入 (DI)

ASP.NET Core中如影随形的&rdquo;依赖注入&rdquo;[下]: 历数依赖注入的N种玩法

在对ASP.NET Core管道中关于依赖注入的两个核心对象(ServiceCollection和ServiceProvider)有了足够的认识之后,我们将关注的目光转移到编程层面.在ASP.NET Core应用中基于依赖注入的编程主要涉及到两个方面,它们分别是将服务注册到ServiceCollection中,和采用注入的方式利用ServiceProvider提供我们所需的服务.我们先来讨论ASP.NET Core应用中如何进行服务注册.[本文已经同步到<ASP.NET Core框架揭秘>之中

ASP.NET Core 基础知识(一) 依赖注入

依赖: 类A用到了类B,我们就说类A依赖类B.如果一个类没有任何地方使用到,那这个类基本上可以删掉了. public class Test { private MyDependency md = new MyDependency(); public void Print() { md.Print(); } } public class MyDependency { public void Print() { Console.WriteLine("this is mydependency"

Asp.Net Core 3.0的依赖注入改变

Asp.Net Core 3.0出来很久了,预览版的时候就被我偶像Lemon大人,带着尝试摸索了一下这个 那么Asp.Net Core 3.0和Asp.Net Core 2.X到底有哪些区别呢? Asp.Net Core 2.X是如何替换依赖注入容器的 三方替换DI容器是在Startup类的ConfigureServices方法上修改 public void ConfigureServices(IServiceCollection services) { //... } 改为 public IS

Asp.Net.Core 系列-中间件和依赖注入进阶篇

上一节讲了中间件和依赖注入的基础,紧接着: 中间件是怎么使用的?使用步骤是什么? 只要把中间件注册到管道中就行了,可以借助Startup对象(DelegateStartup或者ConventionBasedStartup)来完成之外,也可以利用另一个叫做StartupFilter的对象来实现.所谓的StartupFilter是对所有实现了IStartupFilter接口的类型及其对象的统称.IStartupFilter接口定义了如下一个唯一的方法Configure,该方法的参数next返回的Ac

ASP.NET Core 过滤器中使用依赖注入

如何给过滤器ActionFilterAttribute也用上构造函数注入呢? 一般自定义的过滤器直接用特性方式标识就能使用 [ContentFilter] 因为构造函数在使用的时候要求传参,然后我们可以使用这个 ServiceFilter 在ASP.NET Core里,我们可以使用ServiceFilter来完成这个需求. ServiceFilter允许我们解析一个已经添加IoC容器的服务,因此我们需要把ContentFilter注册一下. services.AddScoped<ContentF

[ASP.NET Core 3框架揭秘] 依赖注入：一个Mini版的依赖注入框架

在前面的章节中,我们从纯理论的角度对依赖注入进行了深入论述,我们接下来会对.NET Core依赖注入框架进行单独介绍.为了让读者朋友能够更好地理解.NET Core依赖注入框架的设计与实现,我们按照类似的原理创建了一个简易版本的依赖注入框架,也就是我们在前面多次提及的Cat. 源代码下载 普通服务的注册与消费泛型服务的注册与消费多服务实例的提供服务实例的生命周期 一.编程体验 虽然我们对这个名为Cat的依赖注入框架进行了最大限度的简化,但是与.NET Core框架内部使用的真实依赖注入框架相比,

.NET Core技术研究-HttpContext访问的正确姿势

将ASP.NET升级到ASP.NET Core之后,相信大家都会遇到HttpContext.Current无法使用的问题.这也是我们迁移ASP.NET Core必须解决的问题. 本文我们详细讨论一下,使用HttpContext的正确姿势. 先列一下使用HttpContext的具体场景: 1. 在Controller层访问HttpContext 2. 在中间件中使用HttpContext 3. 在数据访问层使用HttpContext 4. 在后台线程中访问HttpContext 5. 在Razor

[转].NET Core技术研究-HttpContext访问的正确姿势

将ASP.NET升级到ASP.NET Core之后,相信大家都会遇到HttpContext.Current无法使用的问题.这也是我们迁移ASP.NET Core必须解决的问题. 本文我们详细讨论一下,使用HttpContext的正确姿势. 先列一下使用HttpContext的具体场景: 1. 在Controller层访问HttpContext 2. 在中间件中使用HttpContext 3. 在数据访问层使用HttpContext 4. 在后台线程中访问HttpContext 5. 在Razor