Démarrage d’une application dans ASP.NET Core

Par Rick Anderson

Les applications ASP.NET Core créées avec les modèles web contiennent le code de démarrage de l’application dans le fichier Program.cs.

Le code de démarrage d’application suivant prend en charge les éléments suivants :

• Razor Pages
• Contrôleurs MVC avec vues
• API web avec contrôleurs
• API minimales

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

Les applications utilisant EventSource peuvent mesurer le temps de démarrage pour comprendre et optimiser les performances de démarrage. L’événement ServerReady dans Microsoft.AspNetCore.Hosting représente le point où le serveur est prêt à répondre aux demandes.

Pour plus d’informations sur le démarrage de l’application, consultez ASP.NET Core vue d’ensemble des principes fondamentaux.

Étendre le démarrage avec les filtres de démarrage

Utilisez IStartupFilter :

• Pour configurer l’intergiciel (middleware) au début ou à la fin du pipeline d’intergiciels d’une application sans appel explicite à Use{Middleware}. Permet IStartupFilter d’ajouter des valeurs par défaut au début du pipeline sans inscrire explicitement l’intergiciel par défaut. IStartupFilter permet à un autre composant d’appeler Use{Middleware} au nom de l’auteur de l’application.
• Pour créer un pipeline de méthodes Configure. IStartupFilter.Configure peut définir un middleware à exécuter avant ou après les middlewares qui sont ajoutés par les bibliothèques.

IStartupFilter implémente Configure, qui reçoit et retourne un Action<IApplicationBuilder>. IApplicationBuilder définit une classe pour configurer le pipeline de requête d’une application. Pour plus d’informations, consultez Créer un pipeline de middlewares avec IApplicationBuilder.

Chaque IStartupFilter peut ajouter un ou plusieurs middlewares au pipeline de requête. Les filtres sont appelés dans l’ordre dans lequel ils ont été ajoutés au conteneur de service. Les filtres peuvent ajouter l’intergiciel avant ou après la transmission du contrôle au filtre suivant. Par conséquent, ils s’ajoutent au début ou à la fin du pipeline de l’application.

L’exemple suivant montre comment inscrire un middleware auprès de IStartupFilter. Le middleware RequestSetOptionsMiddleware définit une valeur d’options à partir d’un paramètre de chaîne de requête :

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

RequestSetOptionsMiddleware est configuré dans la classe RequestSetOptionsStartupFilter :

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

Le IStartupFilter est inscrit dans Program.cs :

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

Quand un paramètre de chaîne de requête pour option est fourni, le middleware traite l’affectation de valeur avant que le middleware ASP.NET Core n’affiche la réponse :

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

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

L’ordre d’exécution de l’intergiciel est défini par l’ordre des inscriptions d’IStartupFilter :

• Plusieurs implémentations d’IStartupFilter peuvent interagir avec les mêmes objets. Si l’ordre est important, définissez l’ordre des inscriptions de leurs services IStartupFilter pour qu’il corresponde à l’ordre dans lequel leurs intergiciels doivent s’exécuter.

• Les bibliothèques peuvent ajouter des intergiciels avec une ou plusieurs implémentations IStartupFilter qui s’exécutent avant ou après l’autre intergiciel d’application inscrit avec IStartupFilter. Pour appeler un middleware IStartupFilter avant un middleware ajouté par le IStartupFilter d’une bibliothèque :

  • Placez l’inscription du service avant l’ajout de la bibliothèque au conteneur de service.
  • Pour les appels suivants, placez l’inscription du service après l’ajout de la bibliothèque.

Remarque : Vous ne pouvez pas étendre l’application ASP.NET Core lorsque vous remplacez Configure. Pour plus d’informations sur la mise en forme, consultez ce problème GitHub.

Ajouter la configuration au démarrage à partir d’un assembly externe

Une implémentation de IHostingStartup permet d’ajouter des améliorations à une application au démarrage à partir d’un assembly externe, en dehors de le fichier Program.cs de l’application. Pour plus d’informations, consultez Utiliser des assemblys d’hébergement au démarrage dans ASP.NET Core.

Startup, ConfigureServices et Configure

Pour plus d’informations sur l’utilisation des méthodes ConfigureServices et Configure avec le modèle d’hébergement minimal, consultez :

• Utiliser Startup avec le nouveau modèle d'hébergement minimal
• Version ASP.NET Core 5.0 de cet article :
  • Méthode ConfigureServices
  • Méthode Configure