App opstarten in ASP.NET Core

Het Program bestand

ASP.NET Core-apps initialiseren en configureren het opstartproces in het bestand Program van de app (Program.cs).

Het eerste deel van het Program bestand richt zich op het bouwen van de app. Deze fase maakt gebruik WebApplication.CreateBuilder van het initialiseren van een nieuw exemplaar van de WebApplicationBuilder klasse met vooraf geconfigureerde standaardwaarden voordat de app wordt gestart. De ASP.NET Core projectsjablonen wijzen de webtoepassingsbouwer toe aan een variabele met de naambuilder:

var builder = WebApplication.CreateBuilder(args);

Eigenschappen van de webtoepassingsbouwer zijn onder andere:

• builder.Configuration is een IConfigurationBuilder en IConfigurationRoot voor het beheren van configuratiebronnen en providers. Zie Configuratie in ASP.NET Core voor meer informatie.
• builder.Environment is een IWebHostEnvironment die informatie geeft over de webhostingomgeving van de app. Zie ASP.NET Core runtime-omgevingen voor meer informatie.
• builder.Host is een IHostBuilder voor het configureren van hostspecifieke eigenschappen. Zie .NET Generic Host in ASP.NET Core voor meer informatie.
• builder.Logging is een ILoggingBuilder met extensiemethoden waarmee logboekproviders worden toegevoegd en beheerd. Zie Logboekregistratie in .NET en ASP.NET Core voor meer informatie.
• builder.Metrics(.NET 8 of hoger) staat het inschakelen van metrische gegevens en het doorsturen van de uitvoer toe. Zie ASP.NET Core-metrische gegevensvoor meer informatie.
• builder.Servicesis een verzameling afhankelijkheidsinjectieservices (IServiceCollectionDI) die de app kan samenstellen voor Inversion of Control (IoC). Zie Afhankelijkheidsinjectie in ASP.NET Corevoor meer informatie.
• builder.WebHost is een IWebHostBuilder voor het configureren van serverspecifieke eigenschappen.

De app wordt gebouwd door WebApplicationBuilder.Build aan te roepen, die de gebouwde WebApplication retourneert. De ASP.NET Core projectsjablonen wijzen de ingebouwde webtoepassing toe aan een variabele met de naamapp:

var app = builder.Build();

Het volgende deel van het Program bestand is gericht op het tot stand brengen van de pijplijn voor het verwerken van HTTP-aanvragen als een reeks middlewareonderdelen. Elke middleware voert bewerkingen uit op een HttpContext en roept de volgende middleware in de pijplijn aan of beëindigt de aanvraag. Volgens de conventie worden middleware-onderdelen aan de pijplijn toegevoegd door een extensiemethode aan te roepen die begint met 'Use. Zie ASP.NET Core middleware voor meer informatie.

De Run methode start de app en blokkeert de aanroepende thread totdat de host wordt afgesloten:

app.Run();

Wanneer Run wordt uitgevoerd, gaat de app over naar een actief, draaiend proces:

1. Gehoste services worden gestart.

   De host doorloopt alle geregistreerde gehoste services (IHostedService-instanties) en roept hun StartAsync-methoden aan. Tenzij de app zich aanmeldt voor gelijktijdig opstarten van gehoste services (.NET 8 of hoger), worden gehoste services opeenvolgend gestart in de volgorde van hun DI-containerregistraties. Zie Achtergrondtaken met gehoste services in ASP.NET Core voor meer informatie.

2. De middleware-pijplijn is gebouwd.

   Wanneer builder.Build wordt aangeroepen, worden afhankelijkheden opgelost, maar de werkelijke verwerkingspijplijn is niet volledig ingesteld. Wanneer app.Run wordt uitgevoerd, finaliseert het framework de HTTP-middlewarepipeline. De gedefinieerde middleware-methoden en endpointtoewijzingen worden gecompileerd tot één uiterst efficiënte reeks uitvoeringsdelegaten. Zie ASP.NET Core middleware voor meer informatie.

3. De webserver (Kestrel standaard) wordt gestart.

   De host kijkt in de afhankelijkheidscontainer, zoekt de implementatie van de geregistreerde server (meestal Kestrel) en activeert de opstartcyclus. Kestrel dan:

   • Zoekt de gedefinieerde hosting-URL's en poorten op uit configuratie, omgevingsvariabelen of opdrachtregelargumenten.
   • Opent fysieke netwerksockets en wijst deze toe.
   • Koppelt poorten en begint te luisteren naar binnenkomend verkeer.

   Zie .NET Generic Host in ASP.NET Core, webserver-implementaties in ASP.NET Core en Kestrel webserver in ASP.NET Core voor meer informatie.

4. Levenscyclusgebeurtenissen bij het starten van de toepassing worden geactiveerd.

   De IHostApplicationLifetime service activeert het ApplicationStarted token, dat callbacks aanroept die zijn geregistreerd op het token. Alle callbacks, database seeders en andere aangepaste gebeurtenislisteners die zijn ingesteld om te wachten tot het token wordt geactiveerd, worden vervolgens geactiveerd om de verwerking te starten.

5. De belangrijkste uitvoeringsthread wordt geblokkeerd terwijl de app wordt uitgevoerd.

   Run (app.Run()) wacht synchroon tot het afsluiten.

6. De app is klaar om aanvragen te verwerken.

   Op dit punt registreert de opdrachtshell hostingdiagnostiek:

   info: Microsoft.Hosting.Lifetime[14]
         Now listening on: https://localhost:7123
   info: Microsoft.Hosting.Lifetime[14]
         Now listening on: http://localhost:5123
   info: Microsoft.Hosting.Lifetime[0]
         Application started. Press Ctrl+C to shut down.
   

De app blijft in deze status voor onbepaalde tijd, waarbij binnenkomend webverkeer via de middleware-pijplijn wordt doorgegeven en antwoorden worden verzonden.

Wanneer een afsluitsignaal wordt ontvangen, bijvoorbeeld wanneer Ctrl+c wordt gedetecteerd in de opdrachtsregelinterface waarin de app wordt uitgevoerd of een containerorkestratietool een SIGTERM-signaal verzendt, Run wordt gedeblokkeerd en vinden de volgende acties plaats:

1. ApplicationStopping tokens worden geactiveerd, waardoor de app logica kan uitvoeren voordat het afsluitproces begint.

2. De Kestrel server wordt afgesloten, waardoor nieuwe verbindingen worden uitgeschakeld. De server wacht tot verzoeken op bestaande verbindingen zijn afgerond, voor zover de time-out voor afsluiten dat toelaat. De server verzendt de header voor het sluiten van de verbinding voor verdere aanvragen voor bestaande verbindingen.

3. De host sluit geregistreerde gehoste services af. Tenzij de app ervoor kiest om gehoste services gelijktijdig te stoppen (.NET 8 of hoger), stoppen gehoste services opeenvolgend in de omgekeerde volgorde van hun DI-containerregistraties. Zie Achtergrondtaken met gehoste services in ASP.NET Core voor meer informatie.

4. ApplicationStopped gebeurtenis-handlers worden geactiveerd, waardoor de app logica kan uitvoeren nadat de app is afgesloten.

5. De uitvoering in de console wordt netjes beëindigd met afsluitcode 0.

De Startup-klasse configureert services en de aanvraagpijplijn van de app.

De Startup klasse

ASP.NET Core apps een opstartklasse gebruiken, die wordt genoemd Startup volgens conventie. De klasse Startup:

• U kunt desgewenst een ConfigureServices methode gebruiken om de -services van de app te configureren. Een service is een herbruikbaar onderdeel dat app-functionaliteit biedt. Services worden geregistreerd in ConfigureServices en binnen de app gebruikt via afhankelijkheidsinjectie (DI) of ApplicationServices.
• Bevat een Configure methode voor het maken van de aanvraagverwerkingspijplijn van de app.

ConfigureServices en Configure worden aangeroepen door de ASP.NET Core-runtime wanneer de app wordt gestart:

public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
        ...
    }

    public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
    {
        ...
    }
}

De Startup-klasse wordt opgegeven wanneer de host van de app is gebouwd. De Startup klasse wordt doorgaans opgegeven door de hostbouwer aan te roepen WebHostBuilderExtensions.UseStartup :

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>();
            });
}

De host biedt services die beschikbaar zijn voor de Startup klasseconstructor. De app voegt extra services toe via ConfigureServices. Zowel de host- als app-services zijn beschikbaar in Configure en in de hele app.

Alleen de volgende servicetypen kunnen worden geïnjecteerd in de Startup constructor bij gebruik van de Generic Host (IHostBuilder):

• IWebHostEnvironment
• IHostEnvironment
• IConfiguration

public class Startup
{
    private readonly IWebHostEnvironment _env;

    public Startup(IConfiguration configuration, IWebHostEnvironment env)
    {
        Configuration = configuration;
        _env = env;
    }

    public IConfiguration Configuration { get; }

    public void ConfigureServices(IServiceCollection services)
    {
        if (_env.IsDevelopment())
        {
        }
        else
        {
        }
    }
}

De meeste services zijn pas beschikbaar als de Configure methode wordt aangeroepen.

Meerdere Startup klassen

Wanneer de app afzonderlijke Startup klassen definieert voor verschillende omgevingen (bijvoorbeeld StartupDevelopment), wordt de juiste Startup klasse geselecteerd tijdens runtime. De klasse waarvan het achtervoegsel de naam overeenkomt met de huidige omgeving, krijgt prioriteit. Als de app wordt uitgevoerd in de Development omgeving en zowel een Startup klasse als een StartupDevelopment klasse bevat, wordt de StartupDevelopment klasse gebruikt. Zie Meerdere omgevingen gebruikenvoor meer informatie.

De methode ConfigureServices

De optionele ConfigureServices methode is:

• Aangeroepen door de host vóór de Configure methode om de services van de app te configureren.
• Waar configuratieopties volgens conventie worden ingesteld.

De host kan bepaalde services configureren voordat Startup methoden worden aangeroepen. Zie ASP.NET Overzicht van basisbeginselen van Core voor meer informatie.

Voor functies waarvoor een aanzienlijke installatie is vereist, zijn er uitbreidingsmethoden beschikbaar Add{Service}IServiceCollection, zoals:

• AddDbContext
• AddDefaultIdentity
• AddEntityFrameworkStores
• AddRazorPages

public class Startup
{
    public Startup(IConfiguration configuration)
    {
        Configuration = configuration;
    }

    public IConfiguration Configuration { get; }

    public void ConfigureServices(IServiceCollection services)
    {

        services.AddDbContext<ApplicationDbContext>(options =>
            options.UseSqlServer(
                Configuration.GetConnectionString("DefaultConnection")));
        services.AddDefaultIdentity<IdentityUser>(
            options => options.SignIn.RequireConfirmedAccount = true)
            .AddEntityFrameworkStores<ApplicationDbContext>();

        services.AddRazorPages();
    }
}

Als u services toevoegt aan de servicecontainer, worden deze beschikbaar in de app en in de Configure methode. De services worden opgelost via afhankelijkheidsinjectie of van ApplicationServices.

De methode Configure

De methode Configure wordt gebruikt om op te geven hoe de app reageert op HTTP-aanvragen. De aanvraagpijplijn wordt geconfigureerd door middleware- onderdelen toe te voegen aan een IApplicationBuilder exemplaar. IApplicationBuilder is beschikbaar voor de methode Configure, maar deze is niet geregistreerd in de servicecontainer. Hosting maakt een IApplicationBuilder en geeft deze rechtstreeks door aan Configure.

De ASP.NET Core-sjablonen de pijplijn configureren met ondersteuning voor:

• uitzonderingspagina voor ontwikkelaars
• Uitzonderingsafhandelaar
• HTTP Strict Transport Security (HSTS)
• HTTPS-omleiding
• Statische bestanden
• ASP.NET Core MVC en Razor Pagina's

In het volgende voorbeeld ziet u middleware voor een typische Razor Pages-app:

public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
        services.AddRazorPages();
    }

    public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
    {
        if (env.IsDevelopment())
        {
            app.UseDeveloperExceptionPage();
        }
        else
        {
            app.UseExceptionHandler("/Error");
            app.UseHsts();
        }

        app.UseHttpsRedirection();
        app.UseStaticFiles();
        app.UseRouting();

        app.UseEndpoints(endpoints =>
        {
            endpoints.MapRazorPages();
        });
    }
}

Het voorgaande voorbeeld is bedoeld voor Razor Pagina's; de MVC-versie is vergelijkbaar.

Elke Use extensiemethode voegt een of meer middlewareonderdelen toe aan de aanvraagpijplijn. UseStaticFiles configureert bijvoorbeeld middleware om statische bestandenaan te bieden.

Elk middlewareonderdeel in de aanvraagpijplijn is verantwoordelijk voor het aanroepen van het volgende onderdeel in de pijplijn of het kortsluiten van de keten, indien van toepassing.

Aanvullende services, zoals IWebHostEnvironment, ILoggerFactoryof iets dat is gedefinieerd in ConfigureServices, kunnen worden opgegeven in de Configure methodehandtekening. Deze services worden geïnjecteerd als ze beschikbaar zijn.

Zie IApplicationBuilder voor meer informatie over het gebruik en de volgorde van middlewareverwerking.

Services configureren zonder klasse Startup

Als u services en de aanvraagverwerkingspijplijn wilt configureren zonder een Startup-klasse te gebruiken, roept u ConfigureServices aan en Configure gemaksmethoden op de hostbouwer. Meerdere oproepen naar ConfigureServices worden aan elkaar gekoppeld. Als er meerdere Configure methode-aanroepen bestaan, wordt de laatste Configure aanroep gebruikt.

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

    public static IHostBuilder CreateHostBuilder(string[] args) =>
        Host.CreateDefaultBuilder(args)
            .ConfigureAppConfiguration((hostingContext, config) =>
            {
            })
            .ConfigureWebHostDefaults(webBuilder =>
            {
                webBuilder.ConfigureServices(services =>
                {
                    ...
                })
                .Configure(app =>
                {
                    ...
                });
        });
}

De implementatie van het opstartfilter is geregistreerd in het Program bestand:

builder.Services.AddTransient<IStartupFilter, CustomResponseHeaderFilter>();

De implementatie van het opstartfilter is geregistreerd in Startup.ConfigureServices:

services.AddTransient<IStartupFilter, CustomResponseHeaderFilter>();

De Startup klasse (ConfigureServices en Configure methoden)

Hoewel een Startup-klasse wordt ondersteund in ASP.NET Core-apps die gericht zijn op .NET 6 of hoger, wordt het gebruik ervan niet aanbevolen. Zie Migreren van ASP.NET Core in .NET 5 naar .NET 6 voor meer informatie.

Zie het volgende voor informatie over het gebruik van de ConfigureServices en Configure methoden met het minimale hostingmodel:

• Startup Een klasse gebruiken met het minimale hostingmodel
• De Startup klasse (.NET 5 versie van dit artikel)

Opstartprestaties meten

De ASP.NET Core hosting EventSource verzendt de ServerReady gebeurtenis, die het punt aangeeft waarop de server gereed is om te reageren op aanvragen en kan worden gebruikt om de opstarttijd te meten. Zie Logboekregistratie in .NET en ASP.NET Core voor meer informatie.