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

Обновлять

Где-то между .Net Core 2.2 и 3.1 поведение изменилось, AddHostedService теперь добавляет Singleton вместо предыдущей службы Transient. Кредит - 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 в _5 _ класс

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

Внутри фреймворк добавляет все размещенные службы в другую службу (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 это настоящий синглтон.

Используйте 1_

Размещенная служба - это больше, чем просто одноэлементная служба. Среда выполнения знает об этом, может сказать ей начать ее вызовом 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>();
            …
        }
    }
    …
}