De .NET Generic Host gebruiken in een Windows Forms-app

De .NET Generic Host biedt een gestandaardiseerde manier om toepassingen te configureren en uit te voeren met ingebouwde ondersteuning voor afhankelijkheidsinjectie (DI), configuratie en logboekregistratie. Windows Forms-apps bevatten standaard geen algemene hostintegratie, maar u kunt deze wel toevoegen. In dit artikel wordt beschreven hoe u de algemene host instelt in een Windows Forms-app om services in uw formulieren te injecteren.

Vereiste voorwaarden

Het Microsoft.Extensions.Hosting NuGet-pakket.

De algemene host instellen

De installatie verschilt enigszins tussen C# en Visual Basic. Configureer in C# de host rechtstreeks in Program.cs. Gebruik in Visual Basic de opstart- en afsluit-gebeurtenissen van Application Framework in ApplicationEvents.vb.

C#
Visual Basic-

Configureer de host in Program.cs naast ApplicationConfiguration.Initialize().

Aanroep ApplicationConfiguration.Initialize() om standaardinstellingen voor WinForms te configureren, waaronder visuele stijlen, hoge DPI-modus en standaardlettertypen.
Bouw de host met CreateApplicationBuilder en registreer services.
Start de host en los het hoofdformulier op vanuit DI.
Geef het formulier door aan Run.
Stop en verwijder de host nadat het formulier is gesloten.

De volgende code toont het volledige 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();
    }
}

Configureer de host via de gebeurtenissen van het Application Framework met Startup en Shutdown in ApplicationEvents.vb:

Verwijder de instelling Opstartformulier uit de eigenschappen van het Application Framework-project.

De <MainForm> instelling bevindt zich in het Application.myapp bestand.

Opmerking

Als u deze instelling verwijdert, voorkomt u dat de ontwerper een OnCreateMainForm overschrijving genereert waarmee DI wordt omzeild.
Behandel de Startup gebeurtenis om de host te bouwen en te starten.
Het Shutdown-evenement afhandelen om de host te stoppen en af te voeren.
Overschrijven OnCreateMainForm om het hoofdformulier uit de DI-container op te lossen.
De host beschikbaar maken via een gedeelde eigenschap, zodat formulieren services kunnen oplossen.

De volgende code toont het volledige 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

Visual Basic zonder application framework

Als u het Application Framework niet gebruikt, configureert u de host rechtstreeks in de Main methode van uw opstartklasse:

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

Services registreren en gebruiken

Configureer de host, registreer aangepaste services en injecteer deze in uw formulieren. Een service maken en registreren:

Een service-interface definiëren:

public interface IGreetingService
{
    string GetGreeting();
}

Public Interface IGreetingService
    Function GetGreeting() As String
End Interface

Maak een klasse waarmee de interface wordt geïmplementeerd. De GreetingService klasse injecteert IConfiguration die het begroetingsbericht leest van 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

Registreer de interface en implementatie op de Services-eigenschap van de builder, zoals weergegeven in de sectie De generieke host configureren.

Een gehoste service uitvoeren

De algemene host kan ook achtergrondservices uitvoeren die deelnemen aan de levenscyclus van de toepassing. Implementeer IHostedService voor het ontvangen van callbacks wanneer de host wordt gestart en gestopt. Een gehoste service toevoegen:

Maak een klasse die IHostedService implementeert. De volgende klasse schrijft naar de foutopsporingsuitvoer wanneer de host wordt gestart en stopt:

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

Registreer de service met AddHostedService op de eigenschap van de builder van Services, zoals wordt weergegeven in de sectie Set up the Generic Host.

De host roept StartAsync aan bij het opstarten en StopAsync bij het afsluiten, zodat de foutopsporingsuitvoer in het Uitvoer-venster in Visual Studio wordt weergegeven.

Services in een formulier gebruiken

Omdat Form1 wordt opgelost vanuit de DI-container, werkt constructor-injectie rechtstreeks:

Voeg constructorparameters toe voor elke service die het formulier nodig heeft.
Sla de geïnjecteerde services op in privévelden.
Gebruik de diensten in gebeurtenishandlers of andere methoden.

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

Configuratie toevoegen

CreateApplicationBuilder laadt appsettings.json automatisch vanuit de uitvoermap. Ga als volgende te werk om een configuratiebestand toe te voegen:

Maak een appsettings.json bestand in de hoofdmap van het project met uw configuratiewaarden:
```
{
  "GreetingMessage": "Hello from the Generic Host!"
}
```

Stel CopyToOutputDirectory in op PreserveNewest in het projectbestand, zodat appsettings.json naar de uitvoermap wordt gekopieerd.

<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>

Feedback

Is deze pagina nuttig?

Last updated on 2026-04-03