Anwendungsstart in ASP.NET Core

Von Rick Anderson

ASP.NET Core-Apps, die mit den Webvorlagen erstellt wurden, enthalten den Anwendungsstartcode in der Datei Program.cs.

Der nachstehende App-Startcode unterstützt Folgendes:

• Razor Pages
• MVC-Controller mit Ansichten
• Web-APIs mit Controllern
• Minimal-APIs

var builder = WebApplication.CreateBuilder(args);

// Add services to the container.
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.Run();

Apps, die EventSource verwenden, können die Startzeit messen, um die Startleistung zu verstehen und zu optimieren. Das ServerReady Ereignis in Microsoft.AspNetCore.Hosting stellt den Punkt dar, an dem der Server bereit ist, auf Anforderungen zu reagieren.

Weitere Informationen zum Anwendungsstart finden Sie unter ASP.NET Core – Überblick über die Grundlagen.

Erweitern Sie den Start mit Startfiltern

Verwenden Sie IStartupFilter:

• Um Middleware am Anfang und Ende der Middlewarepipeline einer App zu konfigurieren, ohne Use{Middleware} explizit aufzurufen. Verwenden Sie IStartupFilter, um Standardwerte am Anfang der Pipeline hinzuzufügen, ohne die Standardmiddleware explizit zu registrieren. IStartupFilter ermöglicht einer anderen Komponente den Aufruf von Use{Middleware} im Auftrag des App-Autors.
• Um eine Pipeline aus Configure-Methoden zu erstellen. IStartupFilter.Configure kann festlegen, dass eine Middleware vor oder nach dem Hinzufügen von Middleware durch Bibliotheken ausgeführt wird.

IStartupFilter implementiert Configure. Das Element empfängt einen Action<IApplicationBuilder> und gibt diesen zurück. Eine IApplicationBuilder-Schnittstelle definiert Klassen, um die Anforderungspipeline einer App zu konfigurieren. Weitere Informationen finden Sie unter Erstellen einer Middlewarepipeline mit IApplicationBuilder.

Jeder IStartupFilter kann mindestens eine Middlewarekomponente in der Anforderungspipeline hinzufügen. Die Filter werden in der Reihenfolge aufgerufen, in der sie zum Dienstcontainer hinzugefügt wurden. Über Filter kann Middleware hinzugefügt werden, bevor oder nachdem dem nächsten Filter die Kontrolle erteilt wird. D.h., sie wird am Anfang oder am Ende einer App-Pipeline hinzugefügt.

Im folgenden Beispiel wird veranschaulicht, wie Middleware bei IStartupFilter registriert wird. Die RequestSetOptionsMiddleware-Middleware legt einen Optionswert über einen Parameter der Abfragezeichenfolge fest:

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

Die RequestSetOptionsMiddleware-Klasse wird in der RequestSetOptionsStartupFilter-Klasse konfiguriert:

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

IStartupFilter ist in Program.cs registriert:

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

Wenn für option ein Parameter der Abfragezeichenfolge bereitgestellt wird, verarbeitet die Middleware die Wertzuweisung, bevor die ASP.NET Core-Middleware die Antwort rendert:

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

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

Die Reihenfolge der Ausführung der Middleware ist von der Reihenfolge der IStartupFilter-Registrierungen abhängig:

• Es kann sein, dass mehrere Implementierungen von IStartupFilter mit denselben Objekten interagieren. Wenn die Reihenfolge für Sie wichtig ist, sollten Sie die IStartupFilter-Dienstregistrierungen der Implementierungen in der Reihenfolge anordnen, in der die Middleware ausgeführt werden soll.

• Bibliotheken fügen möglicherweise Middleware mit mindestens einer IStartupFilter-Implementierung hinzu, die vor oder nach anderer App-Middleware ausgeführt wird, die über IStartupFilter registriert wurde. So rufen Sie IStartupFilter-Middleware auf, bevor eine Middleware durch den IStartupFilter von einer Bibliothek hinzugefügt wird:

  • Positionieren Sie die Dienstregistrierung, bevor die Bibliothek dem Dienstcontainer hinzugefügt wird.
  • Wenn sie danach aufgerufen werden soll, positionieren Sie die Dienstregistrierung, nachdem die Bibliothek hinzugefügt wurde.

Hinweis: Sie können die ASP.NET Core-App nicht erweitern, wenn Sie Configure überschreiben. Weitere Informationen finden Sie in diesem GitHub-Issue.

Hinzufügen von Konfigurationen aus einer externen Assembly beim Start

Eine IHostingStartup-Implementierung ermöglicht das Hinzufügen von Erweiterungen zu einer App beim Start von einer externen Assembly außerhalb der Program.cs-Datei der App aus. Weitere Informationen finden Sie unter Verwenden von Hostingstartassemblys in ASP.NET Core.

Start, ConfigureServices und Konfigurieren

Informationen zur Verwendung der Methoden ConfigureServices und Configure mit dem minimalen Hostingmodell finden Sie unter:

• Verwenden des Starts mit dem minimalen Hostingmodell
• Die ASP.NET Core 5.0-Version dieses Artikels:
  • Die ConfigureServices-Methode
  • Die Configure-Methode