Microsoft.Extensions.Hostingってなんですか先輩？

ChatGPTにHostについて聞いてみました。

タイトル、文章、イラスト: ChatGPT

登場人物

• ミナト（左）: C#歴1年。Web APIやWinFormsは少しかじったが、最近の.NET開発の流儀はまだ勉強中。
• ハルカ（右）: C#歴10年。API・バッチ・クラウド問わず手がける先輩エンジニア。

1. 昼休みの会話から

ミナト「先輩、レビューでMicrosoft.Extensions.Hostingって出てきたんですけど、それって何するやつなんですか？」

ハルカ「あー、それはね。Hostっていう.NETの土台を作るためのライブラリ。最近の.NETではもう必須の基礎構造って言っていいくらい使われてるよ」

ミナト「なるほど、でも……実際に使う場面ってどういうときなんですか？」

ハルカ「それはね、ちょっと具体的に見ていこう！」

2. Hostって何者？

ハルカ「まずね、Hostってのは、アプリケーション全体を支える足場や裏方のスタッフみたいなものなんだ。アプリを作るときに必要な環境設定や、依存性の注入、ログ管理、サービスの起動・停止など、いろんな処理をHostがまとめてやってくれるんだよ」

ミナト「なるほど、つまりアプリを運用するための土台部分って感じですね」

ハルカ「その通り！　じゃあ具体的に、Hostが何をしてくれるのかを見てみようか？」

3. Hostがやってくれること

ミナト「お願いします、先輩！」

ハルカ「よし、まずはHostがやってくれることを5つ紹介するよ！」

(1) 設定（Configuration）の一元管理

ハルカ「最初に説明するのは設定の一元管理だね。appsettings.jsonを使って、アプリの設定を管理できるんだ」

C#:

// appsettings.json
{
  "MySetting": "Hello, Host!"
}

ミナト「設定ファイルで管理できるんですね。これって環境ごとに設定を切り替えることもできるんですか？」

ハルカ「うん、まさにそう！　開発環境や本番環境で設定を分けて、IConfigurationを通してアクセスできるんだ」

C#:

var mySetting = context.Configuration["MySetting"];
Console.WriteLine(mySetting); // "Hello, Host!" が出力される

ミナト「このようにして、設定が簡単に管理できるんですね」

ハルカ「その通り！　これで設定ファイルをコードから直接読み込んだり、環境変数を使ったりできるよ」

(2) DI（依存性注入）の準備と管理

ミナト「次はDIですね、先輩。具体的にはどんな風に使うんですか？」

ハルカ「DIは、サービスをアプリケーションの外部から注入して使えるようにする仕組みだね。Hostは、必要なサービスを簡単に注入してくれるんだ」

C#:

public interface IMyService
{
    void DoWork();
}
 
public class MyService : IMyService
{
    public void DoWork()
    {
        Console.WriteLine("Service is doing work!");
    }
}
 
public class Program
{
    public static void Main(string[] args)
    {
        var host = Host.CreateDefaultBuilder(args)
            .ConfigureServices((context, services) =>
            {
                services.AddSingleton<IMyService, MyService>(); // DI登録
            })
            .Build();
 
        var myService = host.Services.GetRequiredService<IMyService>(); // サービスを取り出して使用
        myService.DoWork(); // "Service is doing work!" と出力
        host.Run();
    }
}

ミナト「これで、MyServiceを簡単に使えるようになったんですね！」

ハルカ「その通り！　これを使えば、クラス間の依存関係がシンプルに管理できるよ」

(3) ログ（Logging）の仕組みも標準搭載

ミナト「次はログですね。これも標準でサポートされてるんですか？」

ハルカ「うん、ILoggerを使えば、ログが自動で管理できるよ。これを使うと、開発中のエラーログや運用中の情報ログもすぐに出力できるんだ」

C#:

var logger = host.Services.GetRequiredService<ILogger<Program>>();
logger.LogInformation("This is an info log.");

ミナト「これでログも簡単に出せるんですね！」

ハルカ「そう、しかもログの出力先も簡単に設定できる。例えばファイルに出力したり、クラウドに送信したりもできるんだよ」

(4) アプリの起動と終了管理

ミナト「Hostはアプリケーションの起動と終了も管理してくれるんですね？」

ハルカ「その通り！　IHostedServiceを使って、アプリのライフサイクルを簡単に管理できるんだ」

C#:

public class MyService : IHostedService
{
    public Task StartAsync(CancellationToken cancellationToken) =>
        Task.CompletedTask; // アプリ起動時の処理
 
    public Task StopAsync(CancellationToken cancellationToken) =>
        Task.CompletedTask; // アプリ終了時の処理
}

ミナト「StartAsyncとStopAsyncで、アプリの開始と終了を管理しているんですね」

ハルカ「その通り！　これで、アプリが立ち上がる前や終了する前に必要な処理を挟むことができるんだ」

(5) バックグラウンド常駐処理（Worker）

ミナト「最後に、バックグラウンドで処理を続けるWorkerってどういうものですか？」

ハルカ「Workerは、アプリケーションが動いている間ずっとバックグラウンドで何かをしてくれるサービスだよ。例えば定期的なバッチ処理や、メッセージキューを監視する処理とかね」

C#:

public class MyWorker : BackgroundService
{
    protected override async Task ExecuteAsync(CancellationToken stoppingToken)
    {
        while (!stoppingToken.IsCancellationRequested)
        {
            await Task.Delay(1000, stoppingToken); // 1秒ごとに動作
        }
    }
}

ミナト「これをホストに登録することで、ずっと動き続けてくれるんですね」

ハルカ「そう！　バックグラウンドで処理を続けさせたいときに便利なんだ」

4. 実務でどう役立つの？

ミナト「なるほど、Hostを使うことでアプリケーションの設計がきれいに保たれますね」

ハルカ「その通り！　実際にはこういうシーンで大いに役立つよ」

• 設定管理: 開発・本番環境での設定切り替えが簡単
• DI: テストしやすく、柔軟な設計が可能
• ログ管理: トラブルシュートが早くなる
• アプリライフサイクル: アプリの起動・終了処理を簡単に管理
• バックグラウンド処理: バッチ処理や非同期タスクを簡単に管理

ミナト「なるほど、これだけできると本当に便利ですね！」

ハルカ「うん、アプリが複雑になればなるほど、Hostを使うメリットが大きくなるんだ」

5. まとめ: Hostは「アプリの裏方スタッフ」

ミナト「Hostを使うことで、コードがスッキリ整理されて、設計が安定するんですね！」

ハルカ「その通り！　Hostはアプリ全体をサポートする裏方スタッフ。あなたがメインの仕事に集中できるようにしてくれるんだ」

参照

• https://learn.microsoft.com/ja-jp/dotnet/core/extensions/generic-host