在ASP.NET Core中注册HostedService的正确方法.AddHostedService vs AddSingleton

Question

在ASP.NET Core 2.1中注册自定义托管服务的正确方法是什么？例如,我已经定制托管源自服务BackgroundService命名MyHostedService.我该如何注册？

public IServiceProvider ConfigureServices(IServiceCollection services)
{           
    //...
    services.AddSingleton<IHostedService, MyHostedService>();
}

要么

public IServiceProvider ConfigureServices(IServiceCollection services)
{           
    //...
    services.AddHostedService<MyHostedService>();
}

？

在这里我们可以看到第一种情况,但这里有第二种情况.

这些方法是否相同？

Answer 1

使用 AddHostedService

托管服务不仅仅是单一服务.运行时"知道"它,可以告诉它通过调用启动StartAsync或通过调用,StopAsync()例如应用程序池被回收.运行时可以等待托管服务在Web应用程序本身终止之前完成.

正如文档所解释的那样,可以通过在托管服务的worker方法中创建作用域来使用作用域服务.对于瞬态服务也是如此.

为此,必须在托管服务的构造函数中注入IServicesProvider或IServiceScopeFactory,并用于创建范围.

从文档中借用,服务的构造函数和worker方法可以如下所示:

public IServiceProvider Services { get; }

public ConsumeScopedServiceHostedService(IServiceProvider services, 
    ILogger<ConsumeScopedServiceHostedService> logger)
{
    Services = services;
    _logger = logger;
}


private void DoWork()
{
    using (var scope = Services.CreateScope())
    {
        var scopedProcessingService = 
            scope.ServiceProvider
                .GetRequiredService<IScopedProcessingService>();

        scopedProcessingService.DoWork();
    }
}

此相关问题显示如何在托管服务中使用瞬态DbContext:

public class MyHostedService : IHostedService
{
    private readonly IServiceScopeFactory scopeFactory;

    public MyHostedService(IServiceScopeFactory scopeFactory)
    {
        this.scopeFactory = scopeFactory;
    }

    public void DoWork()
    {
        using (var scope = scopeFactory.CreateScope())
        {
            var dbContext = scope.ServiceProvider.GetRequiredService<MyDbContext>();
            …
        }
    }
    …
}

Answer 2

一个巨大的区别是AddSingleton()懒惰和AddHostedService()渴望。

添加的服务AddSingleton()将在第一次注入类构造函数时被实例化。这对于大多数服务来说都很好，但如果它确实是您想要的后台服务，您可能希望它立即启动。

添加的服务AddHostedService()将立即实例化，即使没有其他类希望将其注入到其构造函数中。这是一直运行的后台服务的典型情况。

另外，似乎您无法将添加的服务注入AddHostedService()到另一个类中。

Answer 3

它们相似但不完全

AddHostedService是的一部分Microsoft.Extensions.Hosting.Abstractions.

它属于 Microsoft.Extensions.Hosting.Abstractions在ServiceCollectionHostedServiceExtensions类

using Microsoft.Extensions.Hosting;

namespace Microsoft.Extensions.DependencyInjection
{
    public static class ServiceCollectionHostedServiceExtensions
    {
        /// <summary>
        /// Add an <see cref="IHostedService"/> registration for the given type.
        /// </summary>
        /// <typeparam name="THostedService">An <see cref="IHostedService"/> to register.</typeparam>
        /// <param name="services">The <see cref="IServiceCollection"/> to register with.</param>
        /// <returns>The original <see cref="IServiceCollection"/>.</returns>
        public static IServiceCollection AddHostedService<THostedService>(this IServiceCollection services)
            where THostedService : class, IHostedService
            => services.AddTransient<IHostedService, THostedService>();
    }
}

请注意,它使用的是Transient生命时间范围而不是Singleton

在框架内部,所有托管服务都添加到另一个服务(HostedServiceExecutor)

public HostedServiceExecutor(ILogger<HostedServiceExecutor> logger, 
    IEnumerable<IHostedService> services) //<<-- note services collection
{
    _logger = logger;
    _services = services;
}

在启动时,它是通过WebHost构造函数的单例.

_applicationServiceCollection.AddSingleton<HostedServiceExecutor>();