Gestion complète des exceptions dans ASP.net Core Web API

Cet article relève des défis de la gestion de manière fiable des exceptions provenant de tous les filtres, y compris les filtres d'autorisation, au sein des API Web ASP.NET Core. Les différences entre la gestion des exceptions dans ASP.NET Core et ASP.NET Web Classic ASP.NET sont significatives, provoquant souvent une confusion pour les développeurs qui font la transition.

Adresse des limites des filtres d'exception traditionnels

Bien que les filtres d'exception dans ASP.NET Core peuvent gérer les exceptions d'action, ils ont historiquement eu du mal à capturer des exceptions lancées dans d'autres filtres, tels que les filtres d'autorisation. Cette limitation nécessite une approche plus robuste.

La solution iExceptionHandler (asp.net core 8 et ultérieure)

ASP.net Core 8 et ultérieurement Les versions introduisent l'interface iExceptionHandler , fournissant une solution puissante et flexible. iExceptionHandler permet:

• Injection de dépendance (par exemple, pour la journalisation).
• Manipulation personnalisée basée sur des types d'exceptions spécifiques.
• Gestion des exceptions cohérente sur les actions et tous les types de filtres.

implémentation iExceptionHandler:

1. Créer un iExceptionHandler implémentation:

using Microsoft.AspNetCore.Diagnostics;

public class MyExceptionHandler : IExceptionHandler
{
    public async ValueTask TryHandleAsync(HttpContext context, Exception exception, CancellationToken cancellationToken)
    {
        // Implement your exception handling logic here.  This could include logging,
        // returning a custom error response, etc.
        return true; // Return true to indicate the exception was handled.
    }
}

2. Enregistrez le middleware exceptionhandler:

builder.Services.AddExceptionHandler();
app.UseExceptionHandler(_ => { });

Considérations clés:

• Ordre d'enregistrement: multiple iExceptionHandler Les implémentations peuvent être enregistrées. Ils seront exécutés séquentiellement dans l'ordre d'enregistrement.
• TryHandleasync Return Value: returning true de tryHandleasync signale que l'exception a été manipulée. Une false la valeur de retour passe l'exception aux gestionnaires suivants.

Cette méthode garantit une gestion complète des exceptions sur votre API Web ASP.NET Core, abordé les limites des approches précédentes.