.NET CORE 依赖注入 实践总结

本文涉及的产品
云解析 DNS,旗舰版 1个月
全局流量管理 GTM,标准版 1个月
公共DNS(含HTTPDNS解析),每月1000万次HTTP解析
简介:

.NET CORE 依赖注入 实践总结

知识点回顾
依赖包。 Microsoft.Extensions.DependencyInjection.Abstractions
核心对象和方法。
IServiceCollection。注入对象的容器。注意它只存储对象的元数据,并不保存实例对象。
IServiceProvider。注入对象的提供者。它负责提供具体的对象实例。在架构中,IServiceProvider有2种身份,一种是Root ServiceProvider,由service.BuildServiceProvider()创建,生命周期贯穿整个应用程序,AddSingleton对象保存在这里。另外一种则是普通IServiceProvider,由IServiceScope创建,生命周期即为AddScoped的生命周期。AddScope 的对象保存在这里。普通ServiceProvider由Root ServiceProvider创建的IServiceScope创建。
IServiceScope。表某一个生命周期范围。由ServiceProvider.CreateScope()创建。
注入方式,知识点一。
注入功能默认在Startup类中的ConfigureServices方法中。
注入方式,知识点二。支持以下三种方式
AddScoped。生命周期为Scoped类型。例如在web框架中,即表示一次Request请求范围内。
AddSingleton。单例,应用程序全局使用同一个实例。
AddTransient。即时的,即对象每次使用都会重新实例化。
注入方式,知识点三。提供多种注入技巧,以Transient为例
实例注入。AddTransient(this IServiceCollection services)。
泛型注入。AddTransient(this IServiceCollection services)。
工厂注入。AddTransient(this IServiceCollection services, Func implementationFactory)。
TryAddXXX。仅当XXX尚未注册实现时,注册该服务。此方法用来避免在容器中注册一个实例的两个副本。
获取实例的方法 GetService和GetRequiredService的区别,前置如果service不存在会返回NULL,后者会直接抛出异常。根据需要选择GetRequiredService,可能会让你的代码变得简洁一点。
WHY 依赖注入
这里只谈益处。

使用接口或基类抽象化依赖关系实现,明确各个类之间的依赖关系。
生命周期的统一管理,尤其对于某些类被多处依赖,关系会变得分散难以管理,依赖注入容器可以解决这点。
非常利于单元测试。
最佳实践
部分来自官方文档的一些建议

对于需要注入为单例的实例,不要依赖Scoped实例。会触发 .NET CORE作用域验证失败。
不要从Root IServiceProvider解析有作用域的实例,这样会导致该作用域的实例变成单一实例。同样会触发作用域验证失败。
对于Asp.Net Core,尽量通过构造函数而不是HttpContext.RequestServices获取实例,这样更易于单元测试。
需要对某个组件服务或是一些服务集合(包括其依赖注入时),使用约定的 Add{SERVICE_NAME} 扩展方法来注册该服务所需的所有服务。
若必须要从IServiceProvider中解析实例(如在单元测试中),请通过using (var scope = ServiceProvider.CreateScope()){ }方式创建作用域来获取实例。
代码中避免设计有状态的、静态类和成员。可以考虑设计注入为单一实例。
代码中避免在服务中直接实例化以来类。尽量采用依赖注入的方式
注意以下两种方式注入的区别,后者的实例化不是服务容器创建的,所有容器不会处理实例的Dispose !!

public class Service1 : IDisposable {}
public class Service2 : IDisposable {}

//方式一
public void ConfigureServices(IServiceCollection services)
{

services.AddSingleton<Service1>();
services.AddSingleton<IService2>(sp => new Service2());

}

//方式二
public void ConfigureServices(IServiceCollection services)
{

services.AddSingleton<Service1>(new Service1());
services.AddSingleton(new Service2());

}

延伸上一点,对于复杂对象的创建,尽量采用提供的工厂注入方式。注意工厂注入的参数是IServiceProvider,可以通过它获取你需要的实例对象。
继续延伸上一点,不要在ConfigureServices方法中 通过collection.BuildServiceProvider()来获取IServiceProvider。这个创建的是一个Root IServiceProvider。单例会实例化一次,然后ConfigureServices方法结束后框架会再次调用collection.BuildServiceProvider(),单例又会重新实例化一次。
不支持基于async/await和Task的服务解析。C# 不支持异步构造函数;因此建议模式是在同步解析服务后使用异步方法
避免在容器中直接存储数据和配置。配置应使用NET CORE的选项模型。
避免使用服务定位器模式。例如直接注入IServiceProvider来获取多个需要的服务。PS,如果你的服务依赖项过多,应该考虑分割成几个小功能服务了。
引入第三方IOC框架
.NET CORE 3.x版本后,引入第三方IOC框架的方式变更了,这里不再贴出2.x的方式。以Autofac框架为例。

Program.cs

    public static IHostBuilder CreateHostBuilder(string[] args) =>
        Host.CreateDefaultBuilder(args)
            .UseServiceProviderFactory(new AutofacServiceProviderFactory())
            .ConfigureWebHostDefaults(webBuilder =>
            {
                webBuilder.UseStartup<Startup>()
                        .ConfigureLogging((hostingContext, logging) =>
                        {
                            logging.ClearProviders();
                            logging.AddConsole();
                            logging.AddNLog();
                        });
            });

Startup.cs

    
     //原来的 ConfigureServices保留,也可以使用原来的框架继续注入

    public void ConfigureServices(IServiceCollection services)
    {
        services.AddControllers();
        services.AddMemoryCache();
        services.Configure<List<string>>(Configuration.GetSection("BlackPhoneList"));
        services.Configure<Dictionary<string, string>>(Configuration.GetSection("BusinessMessages"));
    }
    //增加ConfigureContainer(ContainerBuilder builder) 方式,使用Autofac框架注入
    public void ConfigureContainer(ContainerBuilder builder)
    {
        builder.RegisterType<PhoneBlackListValidator>().Named<IPhoneValidator>("PHONE_BLACKLIST").SingleInstance();
        builder.RegisterType<PhonePerDayCountValidator>().Named<IPhoneValidator>("PHONE_PERDAYCOUNT").SingleInstance();
        builder.RegisterType<UniqueIdPerDayCountValidator>().Named<IUniqueIdValidator>("UNIQUEID_PERDAYCOUNT").SingleInstance();

        //可遍历类型注入,注意 只支持IEnumerable\IList\ICollection 类型
        builder.RegisterType<MessageSendValidator>().As<IMessageSendValidator>().SingleInstance();
    }

3.x 主要是在IServiceCollection和IServiceProvider之间增加了一个 ContainerBuilder 容器适配,使得第三方IOC框架引入更加合理了。具体实现原理可以网上源码查找。

特别关注-线程安全
创建线程安全的单一实例服务。 如果单例服务依赖于一个Transient服务,那么Transient服务可能也需要线程安全,具体取决于单例使用它的方式。
工厂注入方式的Func不需要是线程安全的,框架保证它由单个线程调用一次。
原文地址https://www.cnblogs.com/gt1987/p/12973001.html

相关文章
|
10天前
|
开发框架 .NET 开发者
简化 ASP.NET Core 依赖注入(DI)注册-Scrutor
Scrutor 是一个简化 ASP.NET Core 应用程序中依赖注入(DI)注册过程的开源库,支持自动扫描和注册服务。通过简单的配置,开发者可以轻松地从指定程序集中筛选、注册服务,并设置其生命周期,同时支持服务装饰等高级功能。适用于大型项目,提高代码的可维护性和简洁性。仓库地址:&lt;https://github.com/khellang/Scrutor&gt;
32 5
|
2月前
|
存储 开发框架 JSON
ASP.NET Core OData 9 正式发布
【10月更文挑战第8天】Microsoft 在 2024 年 8 月 30 日宣布推出 ASP.NET Core OData 9,此版本与 .NET 8 的 OData 库保持一致,改进了数据编码以符合 OData 规范,并放弃了对旧版 .NET Framework 的支持,仅支持 .NET 8 及更高版本。新版本引入了更快的 JSON 编写器 `System.Text.UTF8JsonWriter`,优化了内存使用和序列化速度。
|
23天前
|
开发框架 .NET 程序员
驾驭Autofac,ASP.NET WebApi实现依赖注入详细步骤总结
Autofac 是一个轻量级的依赖注入框架,专门为 .NET 应用程序量身定做,它就像是你代码中的 "魔法师",用它来管理对象的生命周期,让你的代码更加模块化、易于测试和维护
驾驭Autofac,ASP.NET WebApi实现依赖注入详细步骤总结
|
28天前
|
开发框架 .NET C#
在 ASP.NET Core 中创建 gRPC 客户端和服务器
本文介绍了如何使用 gRPC 框架搭建一个简单的“Hello World”示例。首先创建了一个名为 GrpcDemo 的解决方案,其中包含一个 gRPC 服务端项目 GrpcServer 和一个客户端项目 GrpcClient。服务端通过定义 `greeter.proto` 文件中的服务和消息类型,实现了一个简单的问候服务 `GreeterService`。客户端则通过 gRPC 客户端库连接到服务端并调用其 `SayHello` 方法,展示了 gRPC 在 C# 中的基本使用方法。
38 5
在 ASP.NET Core 中创建 gRPC 客户端和服务器
|
18天前
|
开发框架 缓存 .NET
GraphQL 与 ASP.NET Core 集成:从入门到精通
本文详细介绍了如何在ASP.NET Core中集成GraphQL,包括安装必要的NuGet包、创建GraphQL Schema、配置GraphQL服务等步骤。同时,文章还探讨了常见问题及其解决方法,如处理复杂查询、错误处理、性能优化和实现认证授权等,旨在帮助开发者构建灵活且高效的API。
24 3
|
3月前
|
开发框架 监控 前端开发
在 ASP.NET Core Web API 中使用操作筛选器统一处理通用操作
【9月更文挑战第27天】操作筛选器是ASP.NET Core MVC和Web API中的一种过滤器,可在操作方法执行前后运行代码,适用于日志记录、性能监控和验证等场景。通过实现`IActionFilter`接口的`OnActionExecuting`和`OnActionExecuted`方法,可以统一处理日志、验证及异常。创建并注册自定义筛选器类,能提升代码的可维护性和复用性。
|
2月前
|
开发框架 JavaScript 前端开发
一个适用于 ASP.NET Core 的轻量级插件框架
一个适用于 ASP.NET Core 的轻量级插件框架
|
2月前
|
开发框架 缓存 算法
开源且实用的C#/.NET编程技巧练习宝库(学习,工作,实践干货)
开源且实用的C#/.NET编程技巧练习宝库(学习,工作,实践干货)
|
2月前
|
Cloud Native API C#
.NET云原生应用实践(一):从搭建项目框架结构开始
.NET云原生应用实践(一):从搭建项目框架结构开始
|
开发框架 前端开发 .NET
ASP.NET Core 核心特性学习笔记「下」
ASP.NET Core 核心特性学习笔记「下」