Правильный способ регистрации HostedService в ASP.NET Core. AddHostedService против AddSingleton

Обновлять

Somewhere between .Net Core 2.2 and 3.1 the behavior has changed, AddHostedService is now adding a Singleton instead of the previous Transient service. Credit - LeonG

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<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicConstructors)] THostedService>(this IServiceCollection services)
        where THostedService : class, IHostedService
    {
        services.TryAddEnumerable(ServiceDescriptor.Singleton<IHostedService, THostedService>());

        return services;
    }

    /// <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>
    /// <param name = "implementationFactory">A factory to create new instances of the service implementation.</param>
    /// <returns>The original <see cref = "IServiceCollection"/>.</returns>
    public static IServiceCollection AddHostedService<THostedService>(this IServiceCollection services, Func<IServiceProvider, THostedService> implementationFactory)
        where THostedService : class, IHostedService
    {
        services.TryAddEnumerable(ServiceDescriptor.Singleton<IHostedService>(implementationFactory));

        return services;
    }
}

Ссылка ServiceCollectionHostedServiceExtensions

Оригинальный ответ

Они похожи, но не полностью

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>();

Обновлять

В прошлом HostedService был долговременным переходным процессом, эффективно действующим как одноэлементный объект. Начиная с .NET Core 3.1 это настоящий синглтон.

Используйте AddHostedService

Размещенная служба - это больше, чем просто одноэлементная служба. Среда выполнения «знает» об этом, может сказать ей начать, вызвав StartAsync, или остановиться, вызвав StopAsync(), когда, например, пул приложений перезапускается. Среда выполнения может дождаться завершения работы размещенной службы до завершения работы самого веб-приложения.

Как документация объясняет, служба может с заданной областью может использоваться путем создания области внутри рабочего метода размещенной службы. То же самое и с временными услугами.

Для этого IServicesProvider или IServiceScopeFactory необходимо внедрить в конструктор размещенной службы и использовать для создания области.

Заимствуя из документации, конструктор службы и рабочий метод могут выглядеть следующим образом:

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>();
            …
        }
    }
    …
}