App opstarten in ASP.NET Core

Door Rick Anderson

ASP.NET Core-apps die zijn gemaakt met de websjablonen, bevatten de opstartcode van de toepassing in het Program.cs-bestand.

Voor richtlijnen met betrekking tot Blazor-opstart, die de richtlijnen in dit artikel aanvullen of vervangen, zie ASP.NET Core Blazor-opstart-.

De volgende opstartcode voor apps ondersteunt verschillende app-typen:

• Blazor Web Apps
• Razor pagina's
• MVC-controllers met weergaven
• web-API met controllers
• Minimal APIs

C#

using WebAll.Components;

var builder = WebApplication.CreateBuilder(args);

// Add services to the container.
builder.Services.AddRazorComponents()
    .AddInteractiveServerComponents();
builder.Services.AddRazorPages();
builder.Services.AddControllersWithViews();

var app = builder.Build();

// Configure the HTTP request pipeline.
if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler("/Error");
    app.UseHsts();
}

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

app.UseAuthorization();

app.MapGet("/hi", () => "Hello!");

app.MapDefaultControllerRoute();
app.MapRazorPages();

app.MapRazorComponents<App>()
    .AddInteractiveServerRenderMode();

app.UseAntiforgery();

app.Run();

Apps die gebruikmaken van EventSource kunnen de opstarttijd meten om de opstartprestaties te begrijpen en te optimaliseren. De gebeurtenis ServerReady in Microsoft.AspNetCore.Hosting vertegenwoordigt het punt waarop de server gereed is om te reageren op aanvragen.

Startup uitbreiden met opstartfilters

Gebruik IStartupFilter:

• Middleware configureren aan het begin of aan het eind van de middlewareketen van een app zonder expliciete aanroep van Use{Middleware}. Gebruik IStartupFilter om standaardinstellingen toe te voegen aan het begin van de pijplijn zonder expliciet de standaard-middleware te registreren. IStartupFilter kan een ander onderdeel namens de auteur van de app Use{Middleware} aanroepen.
• Een pijplijn van Configure methoden maken. IStartupFilter.Configure kan een middleware instellen die moet worden uitgevoerd voor of na middleware die door bibliotheken is toegevoegd.

Een IStartupFilter-implementatie implementeert Configure, die een Action<IApplicationBuilder>ontvangt en retourneert. Een IApplicationBuilder definieert een klasse voor het configureren van de aanvraagpijplijn van een app. Zie Een middleware-pijplijn maken met IApplicationBuildervoor meer informatie.

Elke IStartupFilter implementatie kan een of meer middlewares toevoegen in de aanvraagpijplijn. De filters worden aangeroepen in de volgorde waarin ze zijn toegevoegd aan de servicecontainer. Filters kunnen middleware toevoegen voor of na het doorgeven van de controle aan het volgende filter, waardoor ze aan het begin of het einde van de apppijplijn worden toegevoegd.

In het volgende voorbeeld ziet u hoe u een middleware registreert bij IStartupFilter. De RequestSetOptionsMiddleware middleware stelt een waarde voor opties in op basis van een querytekenreeksparameter:

C#

public class RequestSetOptionsMiddleware
{
    private readonly RequestDelegate _next;

    public RequestSetOptionsMiddleware(RequestDelegate next)
    {
        _next = next;
    }

    // Test with https://localhost:5001/Privacy/?option=Hello
    public async Task Invoke(HttpContext httpContext)
    {
        var option = httpContext.Request.Query["option"];

        if (!string.IsNullOrWhiteSpace(option))
        {
            httpContext.Items["option"] = WebUtility.HtmlEncode(option);
        }

        await _next(httpContext);
    }
}

De RequestSetOptionsMiddleware is geconfigureerd in de klasse RequestSetOptionsStartupFilter:

C#

public class RequestSetOptionsStartupFilter : IStartupFilter
{
    public Action<IApplicationBuilder> Configure(Action<IApplicationBuilder> next)
    {
        return builder =>
        {
            builder.UseMiddleware<RequestSetOptionsMiddleware>();
            next(builder);
        };
    }
}

De IStartupFilter-implementatie is geregistreerd in Program.cs:

C#

using WebStartup.Middleware;

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddRazorPages();
builder.Services.AddTransient<IStartupFilter,
                      RequestSetOptionsStartupFilter>();

var app = builder.Build();

if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler("/Error");
    app.UseHsts();
}

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

app.UseRouting();

app.UseAuthorization();

app.MapRazorPages();

app.Run();

Wanneer een queryreeksparameter voor option wordt opgegeven, verwerkt de middleware de waardetoewijzing voordat de ASP.NET Core-middleware het antwoord weergeeft:

CSHTML

@page
@model PrivacyModel
@{
    ViewData["Title"] = "Privacy Policy";
}
<h1>@ViewData["Title"]</h1>

<p> Append query string ?option=hello</p>
Option String: @HttpContext.Items["option"];

De uitvoeringsvolgorde van middleware wordt ingesteld op basis van de volgorde van IStartupFilter registraties:

• Meerdere IStartupFilter-implementaties kunnen met dezelfde objecten communiceren. Als bestellen belangrijk is, bestelt u de IStartupFilter serviceregistraties zodat deze overeenkomen met de volgorde die hun middlewares moeten uitvoeren.

• Bibliotheken kunnen middleware toevoegen met een of meer IStartupFilter implementaties die vóór of na andere app-middleware worden uitgevoerd die zijn geregistreerd bij IStartupFilter. Een IStartupFilter middleware aanroepen voordat een middleware wordt toegevoegd door de IStartupFiltervan een bibliotheek:

  • Plaats de serviceregistratie voordat de bibliotheek wordt toegevoegd aan de servicecontainer.
  • Als u deze later wilt aanroepen, plaatst u de serviceregistratie nadat de bibliotheek is toegevoegd.

U kunt de ASP.NET Core-app niet uitbreiden wanneer u Configureoverschrijft. Zie dit GitHub-probleemvoor meer informatie.

Configuratie toevoegen bij het opstarten vanuit een externe assembly

Met een IHostingStartup-implementatie kunt u verbeteringen aan een app toevoegen bij het opstarten vanuit een externe assembly buiten het Program.cs-bestand van de app. Zie Hosting-opstartassembly's gebruiken in ASP.NET Corevoor meer informatie.

Opstarten, ConfigureServices en Configureren

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

• Starten met het minimale hostingmodel gebruiken
• De ASP.NET Core 5.0-versie van dit artikel:
  • de methode ConfigureServices
  • De Methode Configureren