揭秘 .Net Core 中的 IServiceProvider

科技   2024-12-07 06:34   上海  


在本文中,我们将全面了解IServiceProvider

.NET Core中的IServiceProvider接口是依赖注入(DI)系统的核心部分。它定义了一种检索服务对象的机制,这些服务对象是由依赖注入容器管理的类型的实例。理解IServiceProvider的工作原理以及如何有效地使用它,对于构建模块化且易于维护的应用程序至关重要。

关键概念

  • 服务提供程序IServiceProvider接口提供了一种从依赖注入容器中获取服务实例的方式。它有一个名为GetService的方法,该方法用于检索指定类型的服务对象。

  • 服务生命周期:服务的生命周期决定了服务实例可被重复使用的时长。常见的生命周期如下:

    • 瞬态(Transient):每次请求服务时都会提供一个新的实例。

    • 作用域(Scoped):在一个作用域内提供单个实例。在Web应用程序中,一个作用域通常对应单个HTTP请求。

    • 单例(Singleton):在应用程序的整个生命周期内只提供一个实例。

  • 服务注册:服务是在Startup类的ConfigureServices方法中向依赖注入容器进行注册的。注册时需指定服务类型、实现类型以及服务生命周期。

基本用法

  • 服务注册: 在Startup类中,你可以在ConfigureServices方法里注册服务,如下所示:

public class Startup
{
public void ConfigureServices(IServiceCollection services)
{
services.AddTransient<IMyTransientService, MyTransientService>();
services.AddScoped<IMyScopedService, MyScopedService>();
services.AddSingleton<IMySingletonService, MySingletonService>();
}

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
// 配置逻辑...
}
}
  • 服务使用: 服务可以通过构造函数注入的方式注入到各类类中,比如控制器,示例如下:

public class MyController : Controller
{
private readonly IMyTransientService _transientService;
private readonly IMyScopedService _scopedService;
private readonly IMySingletonService _singletonService;

public MyController(IMyTransientService transientService, IMyScopedService scopedService, IMySingletonService singletonService)
{
_transientService = transientService;
_scopedService = scopedService;
_singletonService = singletonService;
}

public IActionResult Index()
{
// 使用服务...
return View();
}
}

高级用法

  • 直接使用IServiceProvider: 虽然构造函数注入是首选的方式,但在某些情况下,你可能需要手动解析服务。可以通过注入IServiceProvider来实现,示例如下:

public class MyService
{
private readonly IServiceProvider _serviceProvider;

public MyService(IServiceProvider serviceProvider)
{
_serviceProvider = serviceProvider;
}

public void DoSomething()
{
var transientService = _serviceProvider.GetService<IMyTransientService>();
transientService.PerformTask();
}
}
  • 创建作用域: 在某些情况下,你可能需要手动创建一个作用域。这在后台服务或其他非Web环境中很常见,示例如下:

public class MyBackgroundService : BackgroundService
{
private readonly IServiceProvider _serviceProvider;

public MyBackgroundService(IServiceProvider serviceProvider)
{
_serviceProvider = serviceProvider;
}

protected override async Task ExecuteAsync(CancellationToken stoppingToken)
{
using (var scope = _serviceProvider.CreateScope())
{
var scopedService = scope.ServiceProvider.GetService<IMyScopedService>();
await scopedService.DoWork(stoppingToken);
}
}
}
  • 使用IServiceScopeFactory: 当当前上下文没有提供作用域时,IServiceScopeFactory可用于手动创建作用域,示例如下:

public class MyService
{
private readonly IServiceScopeFactory _scopeFactory;

public MyService(IServiceScopeFactory scopeFactory)
{
_scopeFactory = scopeFactory;
}

public void DoSomething()
{
using (var scope = _scopeFactory.CreateScope())
{
var scopedService = scope.ServiceProvider.GetService<IMyScopedService>();
scopedService.PerformTask();
}
}
}
  • 有条件地注册服务: 有时,你可能需要根据特定条件来注册服务,示例如下:

public class Startup
{
public void ConfigureServices(IServiceCollection services)
{
if (someCondition)
{
services.AddScoped<IMyService, MyServiceImplementation1>();
}
else
{
services.AddScoped<IMyService, MyServiceImplementation2>();
}
}
}

理解服务生命周期

  • 瞬态(Transient): 每次请求服务时都会创建一个新的实例。 适用于轻量级、无状态的服务。 示例:

services.AddTransient<IMyService, MyService>();
  • 作用域(Scoped): 每个请求或作用域内会创建一个新的实例。 适用于在单个请求范围内维护状态,但超出该范围则无需维护状态的服务。 示例:

services.AddScoped<IMyService, MyService>();
  • 单例(Singleton): 创建一个单一实例,并在应用程序的整个生命周期内共享该实例。 适用于在全局范围内维护状态或者创建成本较高的服务。 示例:

services.AddSingleton<IMyService, MyService>();

最佳实践

  • 优先使用构造函数注入:这有助于实现不可变特性,并确保在类实例化时依赖项可用。

  • 避免服务定位器模式:虽然IServiceProvider允许手动解析服务,但过度使用它可能会导致一种称为“服务定位器”的反模式,这种模式会隐藏依赖关系,使代码更难维护。

  • 恰当地使用作用域:确保在作用域内解析作用域服务。避免直接从单例服务中解析作用域服务。

  • 避免依赖项捕获问题:当生命周期较短的服务(例如瞬态或作用域服务)被注入到生命周期较长的服务(例如单例服务)中时,就会出现依赖项捕获问题。这可能会导致意外行为和资源泄漏。

通过理解并遵循这些概念和实践,你可以在.NET Core应用程序中使用IServiceProvider有效地管理依赖关系和服务生命周期。

如果你喜欢我的文章,请给我一个赞!谢谢

架构师老卢
资深软件架构师, 分享编程、软件设计经验, 教授前沿技术, 分享技术资源(每天发布电子书),每天进步一点点...
 最新文章