Uso del host genérico de .NET en una aplicación de Windows Forms

El host genérico de .NET proporciona una manera estandarizada de configurar y ejecutar aplicaciones con compatibilidad integrada con inserción de dependencias (DI), configuración y registro. Las aplicaciones de Windows Forms no incluyen la integración de host genérico de forma predeterminada, pero puede agregarla. En este artículo se muestra cómo configurar el host genérico en una aplicación de Windows Forms para insertar servicios en los formularios.

Prerrequisitos

Paquete Microsoft.Extensions.Hosting NuGet.

Configuración del host genérico

La configuración difiere ligeramente entre C# y Visual Basic. En C#, configure el host directamente en Program.cs. En Visual Basic, utiliza los eventos de inicio y apagado del Application Framework en ApplicationEvents.vb.

C#
Visual Basic

Configure el host junto Program.cs con ApplicationConfiguration.Initialize():

Llame ApplicationConfiguration.Initialize() para configurar los valores predeterminados de WinForms, incluidos los estilos visuales, el modo de alta DPI y las fuentes por defecto.
Compile el host con CreateApplicationBuilder y registre los servicios.
Inicie el host y resuelva el formulario principal desde la inserción de dependencias.
Pase el formulario a Run.
Detenga el proceso y elimine el host después de cerrar el formulario.

En el siguiente código se muestra el completo: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();
    }
}

Configure el host a través de los eventos Startup y Shutdown del marco de aplicaciones en ApplicationEvents.vb:

Quite la configuración del formulario de inicio de las propiedades del proyecto de Application Framework.

La configuración <MainForm> está en el archivo Application.myapp.

Nota:

Quitar esta configuración impide que el diseñador genere una OnCreateMainForm sobrescritura que omita la DI.
Controle el evento Startup para construir e iniciar el host.
Controle el Shutdown evento para detener y eliminar el host.
Sobrescriba OnCreateMainForm para resolver el formulario principal del contenedor de inyección de dependencias.
Exponga el host a través de una propiedad compartida para que los formularios puedan resolver los servicios.

El siguiente código muestra el código completo 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 sin el Framework de Aplicación

Si no usa Application Framework, configure el host directamente en el método de la Main clase de inicio:

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

Registro y consumo de servicios

Con el host configurado, registre servicios personalizados e inyecte en los formularios. Para crear y registrar un servicio:

Definir una interfaz de servicio:

public interface IGreetingService
{
    string GetGreeting();
}

Public Interface IGreetingService
    Function GetGreeting() As String
End Interface

Cree una clase que implemente la interfaz . La GreetingService clase inserta IConfiguration para leer el mensaje de saludo de 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

Registre la interfaz y la implementación en la propiedad Services del generador, como se muestra en la sección Configurar el host genérico.

Ejecución de un servicio hospedado

El host genérico también puede ejecutar servicios en segundo plano que participan en el ciclo de vida de la aplicación. Implemente IHostedService para recibir callbacks cuando se inicie y detenga el host. Para agregar un servicio hospedado:

Cree una clase que implemente IHostedService. La siguiente clase escribe en la salida de depuración cuando el host se inicia y detiene:

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

Registre el servicio con AddHostedService en la propiedad del Services constructor, como se muestra en la sección Configurar el Host Genérico.

El host llama StartAsync al arrancar y StopAsync al cerrar, para que la salida de depuración aparezca en la ventana Salida de Visual Studio.

Utilización de servicios a través de un formulario

Dado que Form1 se resuelve desde el contenedor de inserción de dependencias, la inserción de constructores funciona directamente:

Agregue parámetros de constructor para cada servicio que necesite el formulario.
Almacene los servicios inyectados en campos privados.
Use los servicios en controladores de eventos u otros métodos.

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

Agregar configuración

CreateApplicationBuilder carga appsettings.json automáticamente desde el directorio de salida. Para agregar un archivo de configuración:

Cree un appsettings.json archivo en la raíz del proyecto con los valores de configuración:
```
{
  "GreetingMessage": "Hello from the Generic Host!"
}
```

CopyToOutputDirectory Establezca PreserveNewest en el archivo del proyecto de modo que appsettings.json sea copiado en el directorio de salida:

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

Comentarios

¿Le ha resultado útil esta página?

Last updated on 2026-04-03