ASP .NET Core 3.1 - Host Genérico

Neste artigo vou apresentar o Host Genérico usado nas aplicações ASP .NET Core a partir da versão 3.0.

Os templates da ASP .NET Core criam um Host Genérico HostBuilder que é um utilizado para inicialização do programa.

O host é um objeto que encapsula os recursos de um aplicativo, como:

Injeção de dependência (DI)
Logging
Configuração
Implementações de IHostedService

A definição do host esta presente na classe Program que configura a infraestrutura do aplicativo como host da Web, log, contêiner de injeção de dependência, integração com o IIS etc.

O host é configurado, criado e executado na classe Program no método Main() onde é chamado o método CreateHostBuilder para criar e configurar um objeto do construtor que chama os métodos Build e Run:

public class Program
    {
        public static void Main(string[] args)
        {
            CreateHostBuilder(args).Build().Run();
        }

        public static IHostBuilder CreateHostBuilder(string[] args) =>
            Host.CreateDefaultBuilder(args)
                .ConfigureWebHostDefaults(webBuilder =>
                {
                    webBuilder.UseStartup<Startup>();
                });
    }

Obs: Se sua aplicação for usar o Entity Framework Core, não altere o nome ou a assinatura do método CreateHostBuilder pois as ferramentas do Entity Framework Core esperam encontrar um método CreateHostBuilder que configure o host sem executar o aplicativo.

Quando um host é iniciado, ele chama o método IHostedService.StartAsync em cada implementação de IHostedService que encontra no contêiner de DI. Em uma aplicação Web, uma das implementações de IHostedService é um serviço Web que inicia uma implementação de servidor HTTP.

A execução do método CreateHostBuilder aciona o método CreateDefaultBuilder que realiza as seguintes tarefas:

define o content root para caminho retornado por GetCurrentDirectory;
Carrega a configuração do host das variáveis de ambiente ou dos argumentos da linha de comando;
Carrega a configuração da aplicação do arquivo appsettings.json,appsettings.{Environment}.json, das variáveis de ambiente ou argumentos da linha de comando;
Adiciona os seguintes provedores de logging: Console, Debug, EventSource, EventLog
Habilita a validação do escopo e da dependência para o ambiente de desenvolvimento;

E o método ConfigureWebHostDefaults faz o seguinte:

Carrega a configuração do host de variáveis de ambiente prefixadas com ASPNETCORE_.
Define o servidor Kestrel como servidor da Web e configura-o usando os provedores de configuração de hospedagem do aplicativo.
Adiciona o middleware de filtragem de host;
Adiciona o middleware de Forwarded Headers se ASPNETCORE_FORWARDEDHEADERS_ENABLED for igual a true;
Habilita a integração do IIS;

Na inicalização os seguintes serviços são registrados de forma automática:

IHostApplicationLifetime - Injeta o serviço IHostApplicationLifetime em qualquer classe para manipular tarefas pós-inicialização e de desligamento normal;
IHostifetime - Controla quando o host é iniciado e quando é interrompido. A última implementação registrada é usada;
IHostEnvironment/ IWebHostEnvironment - Injeta o serviço IHostEnvironment em uma classe para obter informações sobre as configurações: ApplicationName, EnvironmentName, ContentRootPath.
As aplicações Web implementam a interface IWebHostEnvironment, que herda de IHostEnvironment e adiciona o WebRootPath;

Assim, o host é criado e configurado, mas antes de criar e executar, precisamos configurar ainda mais com o aplicativo e fazemos isso na classe Startup. Nós informamos ao construtor o local da classe de inicialização usando o método : webBuilder.UseStartup<Startup>();

A classe Startup contém dois métodos :

ConfigureServices (que é opcional) - onde configuramos os serviços que criamos no aplicativo e os adicionamos ao DI Container;
Configure - Onde criamos o pipeline de solicitação adicionando os middlewares;

Dessa forma o método Main da classe Program é o ponto de entrada do nosso aplicativo. Ele configura e constrói o host da Web que é responsável por executar nosso aplicativo.

A maior parte do pipeline necessário para configurar o host já foi feita para nós no método CreateDefaultBuilder, que é chamado no método Main.

A partir dai podemos adicionar uma configuração personalizada na classe Startup que vai depender do projeto usado.

E estamos conversados...

"Foge também das paixões da mocidade; e segue a justiça, a fé, o amor, e a paz com os que, com um coração puro, invocam o Senhor."
2 Timóteo 2:22

Referências:

José Carlos Macoratti