Implementowanie interfejsu IHostedService

  • Artykuł

Jeśli potrzebujesz kontroli skończonej poza podanym BackgroundServiceelementem , możesz zaimplementować własny IHostedServiceelement . Interfejs IHostedService jest podstawą dla wszystkich długotrwałych usług na platformie .NET. Implementacje niestandardowe są rejestrowane za pomocą AddHostedService<THostedService>(IServiceCollection) metody rozszerzenia.

Z tego samouczka dowiesz się, jak wykonywać następujące czynności:

  • Zaimplementuj IHostedServiceinterfejsy i IAsyncDisposable .
  • Utwórz usługę opartą na czasomierzu.
  • Zarejestruj implementację niestandardową za pomocą wstrzykiwania zależności i rejestrowania.

Napiwek

Cały przykładowy kod źródłowy "Pracownicy na platformie .NET" jest dostępny w przeglądarce Samples Browser do pobrania. Aby uzyskać więcej informacji, zobacz Przeglądanie przykładów kodu: Procesy robocze na platformie .NET.

Wymagania wstępne

Tworzenie nowego projektu

Aby utworzyć nowy projekt usługi roboczej za pomocą programu Visual Studio, wybierz pozycję Plik>nowy>projekt....W oknie dialogowym Tworzenie nowego projektu wyszukaj frazę "Usługa procesu roboczego" i wybierz szablon Usługa procesu roboczego. Jeśli wolisz użyć interfejsu wiersza polecenia platformy .NET, otwórz swój ulubiony terminal w katalogu roboczym. dotnet new Uruchom polecenie i zastąp element <Project.Name> odpowiednią nazwą projektu.

dotnet new worker --name <Project.Name>

Aby uzyskać więcej informacji na temat polecenia nowego projektu usługi roboczej interfejsu wiersza polecenia platformy .NET, zobacz dotnet new worker (dotnet new worker).

Napiwek

Jeśli używasz programu Visual Studio Code, możesz uruchomić polecenia interfejsu wiersza polecenia platformy .NET z poziomu zintegrowanego terminalu. Aby uzyskać więcej informacji, zobacz Visual Studio Code: Zintegrowany terminal.

Tworzenie usługi czasomierza

Usługa w tle oparta na czasomierzu korzysta z System.Threading.Timer klasy . Czasomierz wyzwala metodę DoWork . Czasomierz jest wyłączony IHostLifetime.StopAsync(CancellationToken) i usuwany po usunięciu kontenera usługi w systemie IAsyncDisposable.DisposeAsync():

Zastąp zawartość Worker pliku z szablonu następującym kodem języka C#, a następnie zmień nazwę pliku na TimerService.cs:

namespace App.TimerHostedService;

public sealed class TimerService(ILogger<TimerService> logger) : IHostedService, IAsyncDisposable
{
    private readonly Task _completedTask = Task.CompletedTask;
    private int _executionCount = 0;
    private Timer? _timer;

    public Task StartAsync(CancellationToken stoppingToken)
    {
        logger.LogInformation("{Service} is running.", nameof(TimerHostedService));
        _timer = new Timer(DoWork, null, TimeSpan.Zero, TimeSpan.FromSeconds(5));

        return _completedTask;
    }

    private void DoWork(object? state)
    {
        int count = Interlocked.Increment(ref _executionCount);

        logger.LogInformation(
            "{Service} is working, execution count: {Count:#,0}",
            nameof(TimerHostedService),
            count);
    }

    public Task StopAsync(CancellationToken stoppingToken)
    {
        logger.LogInformation(
            "{Service} is stopping.", nameof(TimerHostedService));

        _timer?.Change(Timeout.Infinite, 0);

        return _completedTask;
    }

    public async ValueTask DisposeAsync()
    {
        if (_timer is IAsyncDisposable timer)
        {
            await timer.DisposeAsync();
        }

        _timer = null;
    }
}

Ważne

Był Worker podklasą .BackgroundService Teraz implementuje TimerService zarówno IHostedServiceinterfejsy , jak i IAsyncDisposable .

Parametr TimerService to sealed, i kaskadowo wywołuje wywołanie DisposeAsync z jego _timer wystąpienia. Aby uzyskać więcej informacji na temat "kaskadowego wzorca usuwania", zobacz Implementowanie DisposeAsync metody.

Po StartAsync wywołaniu czasomierz jest tworzone wystąpienie, co powoduje uruchomienie czasomierza.

Napiwek

Element Timer nie czeka na ukończenie poprzednich DoWork wykonań, więc pokazane podejście może nie być odpowiednie dla każdego scenariusza. Interlocked.Increment Służy do przyrostowania licznika wykonywania jako operacji niepodzielnej, co gwarantuje, że wiele wątków nie jest aktualizowanych _executionCount jednocześnie.

Zastąp istniejącą Program zawartość następującym kodem języka C#:

using App.TimerHostedService;

HostApplicationBuilder builder = Host.CreateApplicationBuilder(args);
builder.Services.AddHostedService<TimerService>();

IHost host = builder.Build();
host.Run();

Usługa jest zarejestrowana w pliku (Program.cs) za AddHostedService pomocą metody rozszerzenia. Jest to ta sama metoda rozszerzenia używana podczas rejestrowania BackgroundService podklas, ponieważ oba te metody implementują IHostedService interfejs.

Aby uzyskać więcej informacji na temat rejestrowania usług, zobacz Wstrzykiwanie zależności na platformie .NET.

Weryfikowanie funkcjonalności usługi

Aby uruchomić aplikację z poziomu programu Visual Studio, wybierz pozycję F5 lub wybierz opcję menu Debuguj>rozpocznij debugowanie. Jeśli używasz interfejsu wiersza polecenia platformy .NET, uruchom dotnet run polecenie z katalogu roboczego:

dotnet run

Aby uzyskać więcej informacji na temat polecenia uruchamiania interfejsu wiersza polecenia platformy .NET, zobacz dotnet run.

Pozwól aplikacji na nieco wygenerować kilka przyrostów liczby wykonań. Zostaną wyświetlone dane wyjściowe podobne do następujących:

info: App.TimerHostedService.TimerService[0]
      TimerHostedService is running.
info: Microsoft.Hosting.Lifetime[0]
      Application started. Press Ctrl+C to shut down.
info: Microsoft.Hosting.Lifetime[0]
      Hosting environment: Development
info: Microsoft.Hosting.Lifetime[0]
      Content root path: .\timer-service
info: App.TimerHostedService.TimerService[0]
      TimerHostedService is working, execution count: 1
info: App.TimerHostedService.TimerService[0]
      TimerHostedService is working, execution count: 2
info: App.TimerHostedService.TimerService[0]
      TimerHostedService is working, execution count: 3
info: App.TimerHostedService.TimerService[0]
      TimerHostedService is working, execution count: 4
info: Microsoft.Hosting.Lifetime[0]
      Application is shutting down...
info: App.TimerHostedService.TimerService[0]
      TimerHostedService is stopping.

W przypadku uruchamiania aplikacji z poziomu programu Visual Studio wybierz pozycję Debuguj zatrzymaj>debugowanie.... Alternatywnie wybierz klawisze Ctrl + C z okna konsoli, aby zasygnalizować anulowanie.

Zobacz też

Istnieje kilka powiązanych samouczków, które należy wziąć pod uwagę: