Windows フォームアプリで .NET 汎用ホストを使用する

.NET 汎用ホストは、依存関係の挿入 (DI)、構成、およびログ記録の組み込みサポートを使用してアプリケーションを構成および実行するための標準化された方法を提供します。 Windows フォームアプリには、既定では汎用ホスト統合は含まれませんが、追加することはできます。この記事では、Windows フォームアプリで汎用ホストを設定して、フォームにサービスを挿入する方法について説明します。

前提条件

Microsoft.Extensions.Hosting NuGet パッケージ。

汎用ホストを設定する

セットアップは、C# と Visual Basic の間で若干異なります。 C# で、 Program.csでホストを直接構成します。 Visual Basic では、 ApplicationEvents.vbで Application Framework のスタートアップイベントとシャットダウンイベントを使用します。

C#
Visual Basic

Program.csと共にApplicationConfiguration.Initialize()でホストを構成します。

ApplicationConfiguration.Initialize()を呼び出して、ビジュアルスタイル、高 DPI モード、既定のフォントなど、WinForms の既定値を構成します。
CreateApplicationBuilderを使用してホストをビルドし、サービスを登録します。
ホストを起動し、DI からメインフォームを解決します。
フォームを Runに渡します。
フォームが閉じた後、ホストを停止して破棄します。

次のコードは、完全な Program.csを示しています。

using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;

namespace HostBuilderApp;

static class Program
{
    [STAThread]
    static void Main()
    {
        ApplicationConfiguration.Initialize();

        var builder = Host.CreateApplicationBuilder();

        builder.Services.AddHostedService<SampleLifecycleService>();
        builder.Services.AddTransient<Form1>();
        builder.Services.AddSingleton<IGreetingService, GreetingService>();

        IHost host = builder.Build();

        host.Start();

        Form1 mainForm = host.Services.GetRequiredService<Form1>();
        Application.Run(mainForm);

        host.StopAsync().GetAwaiter().GetResult();
        host.Dispose();
    }
}

Application Framework の Startup および Shutdown イベントを通じて ApplicationEvents.vb でホストを構成します。

Application Framework プロジェクトのプロパティから スタートアップフォーム 設定を削除します。

<MainForm>設定は、Application.myapp ファイルにあります。

注

この設定を削除すると、デザイナーは DI をバイパスする OnCreateMainForm オーバーライドを生成できなくなります。
Startup イベントを処理して、ホストをビルドして起動します。
ホストを停止して破棄する Shutdown イベントを処理します。
OnCreateMainFormをオーバーライドして、DI コンテナーからメインフォームを解決します。
フォームがサービスを解決できるように、共有プロパティを介してホストを公開します。

次のコードは、完全な ApplicationEvents.vbを示しています。

Imports Microsoft.Extensions.DependencyInjection
Imports Microsoft.Extensions.Hosting

Namespace My

    Partial Friend Class MyApplication

        Private Shared _host As IHost

        ' Build and start the host when the application starts.
        Private Sub MyApplication_Startup(sender As Object, e As Microsoft.VisualBasic.ApplicationServices.StartupEventArgs) Handles Me.Startup
            Dim builder = Host.CreateApplicationBuilder()

            builder.Services.AddHostedService(Of SampleLifecycleService)()
            builder.Services.AddTransient(Of Form1)()
            builder.Services.AddSingleton(Of IGreetingService, GreetingService)()

            _host = builder.Build()

            _host.Start()
        End Sub

        ' Stop and dispose of the host when the application shuts down.
        Private Sub MyApplication_Shutdown(sender As Object, e As EventArgs) Handles Me.Shutdown
            _host.StopAsync().GetAwaiter().GetResult()
            _host.Dispose()
        End Sub

        ' Resolve the main form from DI instead of using the default form instance.
        Protected Overrides Sub OnCreateMainForm()
            Me.MainForm = _host.Services.GetRequiredService(Of Form1)()
        End Sub

        ' Expose the host so forms can resolve services via HostInstance.Services.
        Friend Shared ReadOnly Property HostInstance As IHost
            Get
                Return _host
            End Get
        End Property

    End Class

End Namespace

Application Framework を使用しない Visual Basic

Application Framework を使用していない場合は、スタートアップクラスの Main メソッドでホストを直接構成します。

Private _host As IHost

<STAThread()>
Friend Sub Main(args As String())
    ' Configure the host with services
    Dim builder = Host.CreateApplicationBuilder(args)

    builder.Services.AddHostedService(Of SampleLifecycleService)()
    builder.Services.AddTransient(Of Form1)()
    builder.Services.AddSingleton(Of IGreetingService, GreetingService)()

    _host = builder.Build()
    _host.Start()

    ' Run the application with the main form resolved from the host
    Application.SetHighDpiMode(HighDpiMode.SystemAware)
    Application.EnableVisualStyles()
    Application.SetCompatibleTextRenderingDefault(False)
    Application.Run(_host.Services.GetRequiredService(Of Form1)())

    ' Stop the host when the application exits
    _host.StopAsync().GetAwaiter().GetResult()
    _host.Dispose()
End Sub

Friend ReadOnly Property HostInstance As IHost
    Get
        Return _host
    End Get
End Property

サービスの登録と使用

ホストを構成したら、カスタムサービスを登録し、フォームに挿入します。サービスを作成して登録するには:

サービスインターフェイスを定義します。

public interface IGreetingService
{
    string GetGreeting();
}

Public Interface IGreetingService
    Function GetGreeting() As String
End Interface

インターフェイスを実装するクラスを作成します。 GreetingService クラスは、IConfigurationからあいさつメッセージを読み取るappsettings.jsonを挿入します。

public class GreetingService : IGreetingService
{
    private readonly IConfiguration _configuration;

    public GreetingService(IConfiguration configuration)
    {
        _configuration = configuration;
    }

    public string GetGreeting()
    {
        return _configuration.GetValue<string>("GreetingMessage")
            ?? "Hello, World!";
    }
}

Public Class GreetingService
    Implements IGreetingService

    Private ReadOnly _configuration As IConfiguration

    Public Sub New(configuration As IConfiguration)
        _configuration = configuration
    End Sub

    Public Function GetGreeting() As String Implements IGreetingService.GetGreeting
        Dim message As String = _configuration.GetValue(Of String)("GreetingMessage")

        If message Is Nothing Then
            Return "Hello, World!"
        End If

        Return message
    End Function

End Class

「Services」セクションに示すように、ビルダーのプロパティにインターフェイスと実装を登録します。

ホステッドサービスを実行する

汎用ホストでは、アプリケーションのライフサイクルに参加するバックグラウンドサービスを実行することもできます。ホストの開始時と停止時にコールバックを受信する IHostedService を実装します。ホステッドサービスを追加するには:

IHostedService を実装するクラスを作成します。次のクラスは、ホストの起動時と停止時にデバッグ出力に書き込みます。

public class SampleLifecycleService : IHostedService
{
    public Task StartAsync(CancellationToken cancellationToken)
    {
        System.Diagnostics.Debug.WriteLine("SampleLifecycleService: Started.");
        return Task.CompletedTask;
    }

    public Task StopAsync(CancellationToken cancellationToken)
    {
        System.Diagnostics.Debug.WriteLine("SampleLifecycleService: Stopped.");
        return Task.CompletedTask;
    }
}

Public Class SampleLifecycleService
    Implements IHostedService

    Public Function StartAsync(cancellationToken As CancellationToken) As Task Implements IHostedService.StartAsync
        System.Diagnostics.Debug.WriteLine("SampleLifecycleService: Started.")
        Return Task.CompletedTask
    End Function

    Public Function StopAsync(cancellationToken As CancellationToken) As Task Implements IHostedService.StopAsync
        System.Diagnostics.Debug.WriteLine("SampleLifecycleService: Stopped.")
        Return Task.CompletedTask
    End Function

End Class

「AddHostedService」セクションに示すように、ビルダーの Services プロパティのにサービスを登録します。

ホストは起動時に StartAsync を呼び出し、シャットダウン時に StopAsync するため、デバッグ出力は Visual Studio の [出力 ] ウィンドウに表示されます。

フォームでサービスを使用する

Form1は DI コンテナーから解決されるため、コンストラクターの挿入は直接機能します。

フォームに必要な各サービスのコンストラクターパラメーターを追加します。
挿入されたサービスをプライベートフィールドに格納します。
イベントハンドラーまたはその他のメソッドでサービスを使用します。

public partial class Form1 : Form
{
    private readonly ILogger<Form1> _logger;
    private readonly IGreetingService _greetingService;

    public Form1(ILogger<Form1> logger, IGreetingService greetingService)
    {
        InitializeComponent();

        _logger = logger;
        _greetingService = greetingService;
    }

    private void ButtonGreet_Click(object sender, EventArgs e)
    {
        string greeting = _greetingService.GetGreeting();
        lblGreeting.Text = greeting;
        _logger.LogInformation("Greeting displayed: {Greeting}", greeting);
    }
}

Public Class Form1

    Private _logger As ILogger(Of Form1)
    Private _greetingService As IGreetingService

    Sub New(ILogger As ILogger(Of Form1), greetingService As IGreetingService)
        InitializeComponent()
        _logger = ILogger
        _greetingService = greetingService
    End Sub

    Private Sub ButtonGreet_Click(sender As Object, e As EventArgs) Handles btnGreet.Click
        Dim greeting As String = _greetingService.GetGreeting()
        lblGreeting.Text = greeting
        _logger.LogInformation("Greeting displayed: {Greeting}", greeting)
    End Sub

End Class

構成を追加する

CreateApplicationBuilder appsettings.jsonを出力ディレクトリから自動的に読み込みます。構成ファイルを追加するには:

構成値を使用して、プロジェクトルートに appsettings.json ファイルを作成します。
```
{
  "GreetingMessage": "Hello from the Generic Host!"
}
```

CopyToOutputDirectoryが出力ディレクトリにコピーされるように、PreserveNewestをプロジェクトファイルでappsettings.jsonに設定します。

<Project Sdk="Microsoft.NET.Sdk">

  <PropertyGroup>
    <OutputType>WinExe</OutputType>
    <TargetFramework>net10.0-windows</TargetFramework>
    <Nullable>enable</Nullable>
    <ImplicitUsings>enable</ImplicitUsings>
    <UseWindowsForms>true</UseWindowsForms>
  </PropertyGroup>

  <ItemGroup>
    <None Update="appsettings.json">
      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
    </None>
  </ItemGroup>

  <ItemGroup>
    <PackageReference Include="Microsoft.Extensions.Hosting" Version="10.0.*" />
  </ItemGroup>

</Project>

フィードバック

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

Last updated on 2026-04-03

Windows フォーム アプリで .NET 汎用ホストを使用する