Comment les API Web ASP.NET doivent-elles renvoyer des erreurs : immédiatement ou collectivement ?

Meilleures pratiques pour renvoyer les erreurs dans l'API Web ASP.NET

Lors du traitement des erreurs dans les API Web ASP.NET, il existe deux principaux approches : renvoyer les erreurs immédiatement ou accumuler les erreurs et les renvoyer collectivement. Cet article examine les avantages et les inconvénients de chaque approche et propose les meilleures pratiques recommandées.

1. Renvoi immédiat des erreurs

Dans la première approche, les erreurs sont renvoyées immédiatement à l'aide de HttpResponseExceptions. Cela convient lorsque :

• L'erreur est fatale : Cela empêche l'API de poursuivre le traitement, car une exécution ultérieure est impossible.
• L'erreur est spécifique et exploitable : Il fournit une indication claire du problème et des étapes concrètes pour le client.

Exemple :

public void Post(Customer customer)
{
    if (string.IsNullOrEmpty(customer.Name))
    {
        throw new HttpResponseException("Customer Name cannot be empty", HttpStatusCode.BadRequest);
    }
    if (customer.Accounts.Count == 0)
    {
        throw new HttpResponseException("Customer does not have any account", HttpStatusCode.BadRequest);
    }
}

2. Accumulation et renvoi des erreurs

Dans la deuxième approche, les erreurs sont accumulées et renvoyées collectivement à la fin de l'action. Ceci est recommandé lorsque :

• Les erreurs ne sont pas fatales :Elles n'empêchent pas la réalisation de l'action, mais doivent néanmoins être communiquées au client.
• Les erreurs peuvent être nombreuses et couvrir différentes parties de la saisie : Leur consolidation permet d'avoir une erreur globale message.

Exemple :

public void Post(Customer customer)
{
    List<string> errors = new List<string>();
    if (string.IsNullOrEmpty(customer.Name))
    {
        errors.Add("Customer Name cannot be empty");
    }
    if (customer.Accounts.Count == 0)
    {
        errors.Add("Customer does not have any account");
    }
    var responseMessage = new HttpResponseMessage<List<string>>(errors, HttpStatusCode.BadRequest);
    throw new HttpResponseException(responseMessage);
}

Meilleures pratiques

Bien que les deux approches aient leurs mérites, la La meilleure pratique recommandée est de renvoyer les erreurs immédiatement. Ceci :

• Fournit un retour instantané : Le client est informé de l'erreur dès qu'elle se produit, ce qui lui permet d'y remédier rapidement.
• Simplifie la gestion des erreurs : La capture et la gestion des exceptions à l'emplacement approprié évitent la nécessité d'une propagation complexe des erreurs. mécanismes.
• Favorise la maintenabilité :Une logique de gestion des erreurs clairement délimitée rend le code plus facile à comprendre et à maintenir.

Cependant, pour les erreurs non fatales qui font partie d'une étape de validation ou de traitement plus large, accumuler les erreurs et les renvoyer collectivement peut être plus approprié.

Mises à jour

Cet article a été mis à jour au fil du temps avec des informations provenant d'articles de blog et des changements dans les meilleures pratiques :

• Utiliser HttpResponseExceptions pour les retours d'erreur immédiats et les erreurs d'état du modèle.
• Gérez les erreurs au niveau du serveur dans un filtre d'exception global, en fournissant des Codes d'état HTTP et messages d'erreur conviviaux.
• Exploitez l'interface IHttpActionResult et les classes intégrées pour les retours d'erreurs généraux, tels que NotFound et BadRequest.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!