IHostedService と BackgroundService クラスを使ってマイクロサービスのバックグラウンドタスクを実装する

[アーティクル]
03/29/2023

ヒント

このコンテンツは eBook の「コンテナー化された .NET アプリケーションの .NET マイクロサービスアーキテクチャ」からの抜粋です。.NET Docs で閲覧できるほか、PDF として無料ダウンロードすると、オンラインで閲覧できます。

PDF のダウンロード

バックグラウンドタスクとスケジュールされたジョブは、マイクロサービスアーキテクチャのパターンに従っているかどうかにかかわらず、すべてのアプリケーションで使用する必要があります。マイクロサービスアーキテクチャを使用する場合との違いは、自分のニーズに応じてスケールアップおよびスケールダウンできるように、バックグラウンドタスクをホスト用の別のプロセスまたはコンテナーに実装することです。

これらの種類のタスクは、ホスト、アプリケーション、マイクロサービス内でホストするサービス、ロジックであるため、全体的な観点から、.NET では "ホステッドサービス" と呼びます。このケースでは、ホステッドサービスは、単にバックグラウンドタスクロジックを持つクラスを意味していることに注意してください。

.NET Core 2.0 以降では、ホステッドサービスを簡単に実装できるようにする IHostedService という名前の新しいインターフェイスが、フレームワークによって提供されています。基本的な考え方は、図 6-26 に示すように、ご利用の Web ホストまたはホストが実行されているときに、バックグラウンドで実行される複数のバックグラウンドタスク (ホステッドサービス) を登録できることです。

Diagram comparing ASP.NET Core IWebHost and .NET Core IHost.

図 6-26。 WebHost と Host で IHostedService を使用した場合の比較

ASP.NET Core 1.x および 2.x では、Web アプリのバックグラウンドプロセスの IWebHost がサポートされています。 .NET Core 2.1 以降のバージョンでは、プレーンなコンソールアプリを使用したバックグラウンドプロセス用の IHost がサポートされています。 WebHost と Host の違いに注目してください。

ASP.NET Core 2.0 の WebHost (IWebHost を実装する基底クラス) は、MVC Web アプリや Web API サービスを実装する場合など、HTTP サーバー機能をプロセスに提供するために使用されるインフラストラクチャ成果物です。 ASP.NET Core の新しいインフラストラクチャのすべての長所を提供することで、依存関係の挿入の使用や、要求パイプラインへのミドルウェアの挿入などを実行できます。 WebHost では、これらが、バックグラウンドタスク用の IHostedServices を同じように使用されます。

Host (IHost を実装する基底クラス) は .NET Core 2.1 で実装されました。基本的に、Host を使用すると、WebHost を使用した場合と同様のインフラストラクチャ (依存関係の挿入、ホステッドサービスなど) ができますが、このケースでは、ホストとしてシンプルでより軽量なプロセスが必要なだけで、MVC、Web API または HTTP サーバー機能は関係ありません。

そのため、IHost を使用して特殊化されたホストプロセスを作成してホステッドサービス以外 (IHostedServices をホスティングするためだけに作成されたマイクロサービスなど) は処理しないことを選択するか、代わりに既存の ASP.NET Core WebHost (既存の ASP.NET Core Web API または MVC アプリ) を拡張することを選択できます。

ビジネスと拡張性のニーズに応じて、いずれの方法にも長所と短所があります。つまり、基本的には、バックグラウンドタスクが HTTP (IWebHost) と関係ない場合は、IHost を使用する必要があります。

WebHost または Host でホステッドサービスを登録する

IHostedService インターフェイスの使用は、WebHost と Hostで非常に似ているので、詳しく見てみましょう。

SignalR はホステッドサービスを使用している成果物の一例ですが、次のようなより単純なことにも使用することができます。

変更を検索するデータベースをポーリングするバックグラウンドタスク。
いくつかのキャッシュを定期的に更新するスケジュールされたタスク。
タスクをバックグラウンドスレッドで実行することを可能にする QueueBackgroundWorkItem の実装。
ILogger などの共通サービスを共有しながら、Web アプリのバックグラウンドでメッセージキューからのメッセージの処理。
Task.Run() で開始されるバックグラウンドタスク。

基本的に、IHostedService を実装するバックグラウンドタスクにこれらのアクションのいずれかをオフロードできます。

1 つまたは複数の IHostedServices を WebHost または Host に追加するには、ASP.NET Core WebHost (または .NET Core 2.1 以降の Host) の AddHostedService 拡張メソッドでそれらを登録します。基本的には、アプリケーションの起動中に Program.cs にホステッドサービスを登録する必要があります。

//Other DI registrations;

// Register Hosted Services
builder.Services.AddHostedService<GracePeriodManagerService>();
builder.Services.AddHostedService<MyHostedServiceB>();
builder.Services.AddHostedService<MyHostedServiceC>();
//...

そのコードで、GracePeriodManagerService ホステッドサービスは eShopOnContainers の Ordering business microservice からの実際のコードですが、他の 2 つは単に追加の 2 つのサンプルです。

IHostedService バックグラウンドタスクの実行は、アプリケーション (さらに言えば、ホストまたはマイクロサービス) の有効期間に合わせて調整されます。アプリケーションの起動時にタスクを登録して、いくつかの正常なアクションを行うか、アプリケーションのシャットダウン時にクリーンアップすることができます。

IHostedService を使用しない場合は、いつでもバックグラウンドスレッドを開始して任意のタスクを実行することができます。正常なクリーンアップアクションを実行する機会がないままスレッドが単に強制終了される場合、差はちょうどアプリのシャットダウン時間になります。

IHostedService インターフェイス

IHostedService を登録すると、アプリケーションの起動時と停止時にそれぞれ、.NET によって IHostedService 型の StartAsync() および StopAsync() メソッドが呼び出されます。詳細については、「IHostedService インターフェイス」を参照してください。

ご想像のとおり、以前に示したように、IHostedService の複数の実装を作成し、これらをそれぞれ Program.cs に登録することができます。これらすべてのホステッドサービスが、アプリケーション/マイクロサービスと共に開始および停止されます。

開発者は、StopAsync() メソッドがホストによってトリガーされるときに、サービスの停止アクションを処理する必要があります。

BackgroundService 基底クラスから派生したカスタムのホステッドサービスクラスを使用して IHostedService を実装する

続行して、ホステッドサービスのカスタムクラスをゼロから作成し、IHostedService を実装します。これは .NET Core 2.0 以降を使用する場合に行う必要があります。

ただし、ほとんどのバックグラウンドタスクでは、キャンセルトークンの管理およびその他の一般的な操作で同様のニーズがあるため、派生元として使用できる非常に便利な BackgroundService という名前の抽象基底クラスがあります (.NET Core 2.1 以降で利用できます)。

そのクラスは、バックグラウンドタスクを設定するために必要な主要な作業を提供します。

次のコードは、.NET に実装されている BackgroundService 抽象基底クラスです。

// Copyright (c) .NET Foundation. Licensed under the Apache License, Version 2.0.
/// <summary>
/// Base class for implementing a long running <see cref="IHostedService"/>.
/// </summary>
public abstract class BackgroundService : IHostedService, IDisposable
{
    private Task _executingTask;
    private readonly CancellationTokenSource _stoppingCts =
                                                   new CancellationTokenSource();

    protected abstract Task ExecuteAsync(CancellationToken stoppingToken);

    public virtual Task StartAsync(CancellationToken cancellationToken)
    {
        // Store the task we're executing
        _executingTask = ExecuteAsync(_stoppingCts.Token);

        // If the task is completed then return it,
        // this will bubble cancellation and failure to the caller
        if (_executingTask.IsCompleted)
        {
            return _executingTask;
        }

        // Otherwise it's running
        return Task.CompletedTask;
    }

    public virtual async Task StopAsync(CancellationToken cancellationToken)
    {
        // Stop called without start
        if (_executingTask == null)
        {
            return;
        }

        try
        {
            // Signal cancellation to the executing method
            _stoppingCts.Cancel();
        }
        finally
        {
            // Wait until the task completes or the stop token triggers
            await Task.WhenAny(_executingTask, Task.Delay(Timeout.Infinite,
                                                          cancellationToken));
        }

    }

    public virtual void Dispose()
    {
        _stoppingCts.Cancel();
    }
}

前の抽象基底クラスから派生する場合、データベースをポーリングして、必要に応じてイベントバスに統合イベントをパブリッシュする eShopOnContainers からの簡素化された次のコードのように、継承された実装により、独自のカスタムのホステッドサービスクラスで ExecuteAsync() メソッドを実装するだけで済みます。

public class GracePeriodManagerService : BackgroundService
{
    private readonly ILogger<GracePeriodManagerService> _logger;
    private readonly OrderingBackgroundSettings _settings;

    private readonly IEventBus _eventBus;

    public GracePeriodManagerService(IOptions<OrderingBackgroundSettings> settings,
                                     IEventBus eventBus,
                                     ILogger<GracePeriodManagerService> logger)
    {
        // Constructor's parameters validations...
    }

    protected override async Task ExecuteAsync(CancellationToken stoppingToken)
    {
        _logger.LogDebug($"GracePeriodManagerService is starting.");

        stoppingToken.Register(() =>
            _logger.LogDebug($" GracePeriod background task is stopping."));

        while (!stoppingToken.IsCancellationRequested)
        {
            _logger.LogDebug($"GracePeriod task doing background work.");

            // This eShopOnContainers method is querying a database table
            // and publishing events into the Event Bus (RabbitMQ / ServiceBus)
            CheckConfirmedGracePeriodOrders();

            try {
                    await Task.Delay(_settings.CheckUpdateTime, stoppingToken);
                }
            catch (TaskCanceledException exception) {
                    _logger.LogCritical(exception, "TaskCanceledException Error", exception.Message);
                }
        }

        _logger.LogDebug($"GracePeriod background task is stopping.");
    }

    .../...
}

eShopOnContainers のこの特定のケースでは、特定の状態を持つ注文を検索するデータベーステーブルに対してクエリを実行するアプリケーションメソッドを実行し、変更を適用するときに、イベントバスを介して統合イベントをパブリッシュします (その下で RabbitMQ または Azure Service Bus を使用できます)。

もちろん、代わりに他の任意のビジネスバックグラウンドタスクを実行することもできます。

既定では、キャンセルトークンには 5 秒のタイムアウトが設定されていますが、この値は、IWebHostBuilder の UseShutdownTimeout 拡張機能を使用し、お使いの WebHost をビルドする際に変更することができます。これは、サービスが 5 秒以内にキャンセルされることが想定されていて、そうでない場合は突然強制終了される可能性が高くなることを意味します。

次のコードでは、その時間を 10 秒に変更します。

WebHost.CreateDefaultBuilder(args)
    .UseShutdownTimeout(TimeSpan.FromSeconds(10))
    ...

クラス図の概要

次の図は、IHostedServices を実装する場合のクラスとインターフェイスの概要を視覚的に示しています。

Diagram showing that IWebHost and IHost can host many services.

図 6-27。 IHostedService に関連する複数のクラスとインターフェイスを示すクラス図

クラスダイアグラム:IWebHost と IHost は、BackgroundService から継承され、IHostedService を実装する多くのサービスをホストできます。

展開に関する注意事項と習得事項

ASP.NET Core WebHost または .NETHost を展開する方法が最終的なソリューションに影響を与える可能性があることに注意することが重要です。たとえば、WebHost を IIS または正規の Azure App Service に展開する場合、アプリプールのリサイクルが原因でホストがシャットダウンされる場合があります。ただし、ホストをコンテナーとして Kubernetes などのオーケストレーターに展開する場合は、ご利用のホストのライブインスタンスの確実な数を制御することができます。さらに、Azure Functions のように、これらのシナリオ用に特別に作成されたクラウド内で、他の方法を検討することができます。最後になりますが、サービスを常時実行する必要があるとき、および Windows Server にデプロイする場合、Windows Service を使用できることがあります。

ただし、アプリプールに展開された WebHost に対しても、適用可能なアプリケーションのメモリ内キャッシュの再作成またはフラッシュのようなシナリオがあります。

IHostedService インターフェイスには、(.NET Core 2.0 以降のバージョンの) ASP.NET Core Web アプリケーションで、または (IHost を使用して .NET Core 2.1 で開始する) 任意のプロセス/ホストでバックグラウンドタスクを開始する便利な方法が用意されています。その主な利点は、ホスト自体がシャットダウンされるときに、正常なキャンセルの機会が得られ、お使いのバックグラウンドタスクのコードがクリーンアップされることです。

その他の技術情報

ASP.NET Core/Standard 2.0 でスケジュールされたタスクをビルドする
https://blog.maartenballiauw.be/post/2017/08/01/building-a-scheduled-cache-updater-in-aspnet-core-2.html
ASP.NET Core 2.0 で IHostedService を実装する
https://www.stevejgordon.co.uk/asp-net-core-2-ihostedservice
ASP.NET Core 2.1 を使用した GenericHost サンプル
https://github.com/aspnet/Hosting/tree/release/2.1/samples/GenericHostSample

前へ次へ

次の方法で共有

IHostedService と BackgroundService クラスを使ってマイクロサービスのバックグラウンドタスクを実装する

WebHost または Host でホステッドサービスを登録する

IHostedService インターフェイス

BackgroundService 基底クラスから派生したカスタムのホステッドサービスクラスを使用して IHostedService を実装する

クラス図の概要

展開に関する注意事項と習得事項

その他の技術情報

その他のリソース

次の方法で共有

IHostedService と BackgroundService クラスを使ってマイクロサービスのバックグラウンド タスクを実装する

WebHost または Host でホステッド サービスを登録する

IHostedService インターフェイス

BackgroundService 基底クラスから派生したカスタムのホステッド サービス クラスを使用して IHostedService を実装する

クラス図の概要

展開に関する注意事項と習得事項

その他の技術情報

その他のリソース

IHostedService と BackgroundService クラスを使ってマイクロサービスのバックグラウンドタスクを実装する

WebHost または Host でホステッドサービスを登録する

BackgroundService 基底クラスから派生したカスタムのホステッドサービスクラスを使用して IHostedService を実装する