キューサービスを作成する

キューサービスは、実行時間の長いサービスの優れた例です。作業項目は、前の作業項目が完了したら順番にキューに入れ、処理できます。 Worker Service テンプレートを使用して、 BackgroundServiceの上に新しい機能を構築します。

このチュートリアルでは、以下の内容を学習します。

キューサービスを作成します。
作業をタスクキューに委任します。
IHostApplicationLifetimeイベントからコンソールキーリスナーを登録します。

ヒント

すべての ".NET のワーカー" サンプルソースコードは、 サンプルブラウザー でダウンロードできます。詳細については、「コードサンプルを閲覧: .NET のワーカー」を参照してください。

[前提条件]

.NET 8.0 SDK 以降
.NET 統合開発環境 (IDE)
- Visual Studio を自由に使用できます

新しいプロジェクトを作成する

Visual Studio で新しい Worker Service プロジェクトを作成するには、 ファイル>New>Project...を選択します。[ 新しいプロジェクトの作成 ] ダイアログで"Worker Service" を検索し、Worker Service テンプレートを選択します。 .NET CLI を使用する場合は、作業ディレクトリでお気に入りのターミナルを開きます。 dotnet new コマンドを実行し、<Project.Name>を目的のプロジェクト名に置き換えます。

dotnet new worker --name <Project.Name>

.NET CLI の新しい worker サービスプロジェクトコマンドの詳細については、「 dotnet new worker」を参照してください。

ヒント

Visual Studio Code を使用している場合は、統合ターミナルから .NET CLI コマンドを実行できます。詳細については、「 Visual Studio Code: 統合ターミナル」を参照してください。

キューイングサービスを作成する

QueueBackgroundWorkItem(Func<CancellationToken,Task>)名前空間のSystem.Web.Hosting機能に慣れているかもしれません。

ヒント

System.Web名前空間の機能は意図的に .NET に移植されず、.NET Framework に限定されたままです。詳細については、「ASP.NET から ASP.NET Core への増分移行の始め方」を参照してください。

.NET では、 QueueBackgroundWorkItem 機能に触発されたサービスをモデル化するには、まず、 IBackgroundTaskQueue インターフェイスをプロジェクトに追加します。

namespace App.QueueService;

public interface IBackgroundTaskQueue
{
    ValueTask QueueBackgroundWorkItemAsync(
        Func<CancellationToken, ValueTask> workItem);

    ValueTask<Func<CancellationToken, ValueTask>> DequeueAsync(
        CancellationToken cancellationToken);
}

キュー機能を公開する方法と、キューに登録された作業項目をデキューする方法の 2 つがあります。 作業項目はFunc<CancellationToken, ValueTask>です。次に、既定の実装をプロジェクトに追加します。

using System.Threading.Channels;

namespace App.QueueService;

public sealed class DefaultBackgroundTaskQueue : IBackgroundTaskQueue
{
    private readonly Channel<Func<CancellationToken, ValueTask>> _queue;

    public DefaultBackgroundTaskQueue(int capacity)
    {
        BoundedChannelOptions options = new(capacity)
        {
            FullMode = BoundedChannelFullMode.Wait
        };
        _queue = Channel.CreateBounded<Func<CancellationToken, ValueTask>>(options);
    }

    public async ValueTask QueueBackgroundWorkItemAsync(
        Func<CancellationToken, ValueTask> workItem)
    {
        ArgumentNullException.ThrowIfNull(workItem);

        await _queue.Writer.WriteAsync(workItem);
    }

    public async ValueTask<Func<CancellationToken, ValueTask>> DequeueAsync(
        CancellationToken cancellationToken)
    {
        Func<CancellationToken, ValueTask>? workItem =
            await _queue.Reader.ReadAsync(cancellationToken);

        return workItem;
    }
}

上記の実装は、キューとして Channel<T> に依存しています。 BoundedChannelOptions(Int32)は、明示的な容量で呼び出されます。容量は、予想されるアプリケーションの負荷と、キューにアクセスする同時実行スレッドの数に基づいて設定する必要があります。 BoundedChannelFullMode.Wait により ChannelWriter<T>.WriteAsync の呼び出しはタスクを返し、このタスクは空き領域が使用可能になったときにのみ完了します。これは、パブリッシャーや呼び出しが過剰に蓄積し始めた場合に生じるバックプレッシャーにつながります。

Worker クラスを書き換える

次の QueueHostedService の例では以下のようになります。

ProcessTaskQueueAsync メソッドは、TaskでExecuteAsyncを返します。
ProcessTaskQueueAsync で、キュー内のバックグラウンドタスクがデキューされ、実行されます。
作業項目が待機されてから、StopAsync でサービスが停止します。

既存の Worker クラスを次の C# コードに置き換え、ファイルの名前を QueueHostedService.cs に変更します。

namespace App.QueueService;

public sealed class QueuedHostedService(
        IBackgroundTaskQueue taskQueue,
        ILogger<QueuedHostedService> logger) : BackgroundService
{
    protected override Task ExecuteAsync(CancellationToken stoppingToken)
    {
        logger.LogInformation("""
            {Name} is running.
            Tap W to add a work item to the 
            background queue.
            """,
            nameof(QueuedHostedService));

        return ProcessTaskQueueAsync(stoppingToken);
    }

    private async Task ProcessTaskQueueAsync(CancellationToken stoppingToken)
    {
        while (!stoppingToken.IsCancellationRequested)
        {
            try
            {
                Func<CancellationToken, ValueTask>? workItem =
                    await taskQueue.DequeueAsync(stoppingToken);

                await workItem(stoppingToken);
            }
            catch (OperationCanceledException)
            {
                // Prevent throwing if stoppingToken was signaled
            }
            catch (Exception ex)
            {
                logger.LogError(ex, "Error occurred executing task work item.");
            }
        }
    }

    public override async Task StopAsync(CancellationToken stoppingToken)
    {
        logger.LogInformation(
            $"{nameof(QueuedHostedService)} is stopping.");

        await base.StopAsync(stoppingToken);
    }
}

MonitorLoop サービスは、w キーが入力デバイスで選択されると常に、ホステッドサービスのためにタスクのエンキューを処理します。

IBackgroundTaskQueue が MonitorLoop サービスに挿入されます。
IBackgroundTaskQueue.QueueBackgroundWorkItemAsync が呼び出され、作業項目がエンキューされます。
作業項目により、実行時間の長いバックグラウンドタスクがシミュレートされます。
- 5 秒の遅延が 3 回Delay実行されます。
- try-catch ステートメントは、タスクが取り消された場合にOperationCanceledExceptionをトラップします。

namespace App.QueueService;

public sealed class MonitorLoop(
    IBackgroundTaskQueue taskQueue,
    ILogger<MonitorLoop> logger,
    IHostApplicationLifetime applicationLifetime)
{
    private readonly CancellationToken _cancellationToken = applicationLifetime.ApplicationStopping;

    public void StartMonitorLoop()
    {
        logger.LogInformation($"{nameof(MonitorAsync)} loop is starting.");

        // Run a console user input loop in a background thread
        Task.Run(async () => await MonitorAsync());
    }

    private async ValueTask MonitorAsync()
    {
        while (!_cancellationToken.IsCancellationRequested)
        {
            var keyStroke = Console.ReadKey();
            if (keyStroke.Key == ConsoleKey.W)
            {
                // Enqueue a background work item
                await taskQueue.QueueBackgroundWorkItemAsync(BuildWorkItemAsync);
            }
        }
    }

    private async ValueTask BuildWorkItemAsync(CancellationToken token)
    {
        // Simulate three 5-second tasks to complete
        // for each enqueued work item

        int delayLoop = 0;
        var guid = Guid.NewGuid();

        logger.LogInformation("Queued work item {Guid} is starting.", guid);

        while (!token.IsCancellationRequested && delayLoop < 3)
        {
            try
            {
                await Task.Delay(TimeSpan.FromSeconds(5), token);
            }
            catch (OperationCanceledException)
            {
                // Prevent throwing if the Delay is cancelled
            }

            ++ delayLoop;

            logger.LogInformation("Queued work item {Guid} is running. {DelayLoop}/3", guid, delayLoop);
        }

        if (delayLoop is 3)
        {
            logger.LogInformation("Queued Background Task {Guid} is complete.", guid);
        }
        else
        {
            logger.LogInformation("Queued Background Task {Guid} was cancelled.", guid);
        }
    }
}

既存の Program の内容を次の C# コードに置き換えます。

using App.QueueService;

HostApplicationBuilder builder = Host.CreateApplicationBuilder(args);
builder.Services.AddSingleton<MonitorLoop>();
builder.Services.AddHostedService<QueuedHostedService>();
builder.Services.AddSingleton<IBackgroundTaskQueue>(_ => 
{
    if (!int.TryParse(builder.Configuration["QueueCapacity"], out var queueCapacity))
    {
        queueCapacity = 100;
    }

    return new DefaultBackgroundTaskQueue(queueCapacity);
});

IHost host = builder.Build();

MonitorLoop monitorLoop = host.Services.GetRequiredService<MonitorLoop>()!;
monitorLoop.StartMonitorLoop();

host.Run();

サービスは (Program.cs) に登録されます。ホステッドサービスは、 AddHostedService 拡張メソッドに登録されます。 MonitorLoop は、トップレベルステートメント Program.cs で開始されます。

MonitorLoop monitorLoop = host.Services.GetRequiredService<MonitorLoop>()!;
monitorLoop.StartMonitorLoop();

サービスの登録の詳細については、「 .NET での依存関係の挿入」を参照してください。

サービス機能を確認する

Visual Studio からアプリケーションを実行するには、 F5 キーを押すか、[ デバッグ>デバッグの開始 ] メニューオプションを選択します。 .NET CLI を使用している場合は、作業ディレクトリから dotnet run コマンドを実行します。

dotnet run

.NET CLI 実行コマンドの詳細については、「 dotnet run」を参照してください。

プロンプトが表示されたら、 w (または W) を少なくとも 1 回入力して、エミュレートされた作業項目をキューに入れます(出力例を参照)。

info: App.QueueService.MonitorLoop[0]
      MonitorAsync loop is starting.
info: App.QueueService.QueuedHostedService[0]
      QueuedHostedService is running.

      Tap W to add a work item to the background queue.

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: .\queue-service
winfo: App.QueueService.MonitorLoop[0]
      Queued work item 8453f845-ea4a-4bcb-b26e-c76c0d89303e is starting.
info: App.QueueService.MonitorLoop[0]
      Queued work item 8453f845-ea4a-4bcb-b26e-c76c0d89303e is running. 1/3
info: App.QueueService.MonitorLoop[0]
      Queued work item 8453f845-ea4a-4bcb-b26e-c76c0d89303e is running. 2/3
info: App.QueueService.MonitorLoop[0]
      Queued work item 8453f845-ea4a-4bcb-b26e-c76c0d89303e is running. 3/3
info: App.QueueService.MonitorLoop[0]
      Queued Background Task 8453f845-ea4a-4bcb-b26e-c76c0d89303e is complete.
info: Microsoft.Hosting.Lifetime[0]
      Application is shutting down...
info: App.QueueService.QueuedHostedService[0]
      QueuedHostedService is stopping.

Visual Studio 内からアプリケーションを実行する場合は、[ デバッグ>ストップデバッグ...] を選択します。または、コンソールウィンドウから Ctrl + C を選択してキャンセルを通知します。

こちらも参照ください

フィードバック

このページはお役に立ちましたか?

Last updated on 2026-01-24