Error Handling

Ouvrir dans ChatGPT

La gestion des erreurs est un aspect crucial du développement d'applications web fiables. Dans webforJ, la gestion des erreurs est conçue pour être flexible et personnalisable, permettant aux développeurs de gérer les exceptions de la manière qui convient le mieux aux besoins de leur application.

Vue d'ensemble

Dans webforJ, la gestion des erreurs tourne autour de l'interface ErrorHandler. Cette interface permet aux développeurs de définir comment leur application doit réagir lorsque des exceptions se produisent pendant l'exécution. Par défaut, webforJ fournit un GlobalErrorHandler qui gère toutes les exceptions de manière générique. Cependant, les développeurs peuvent créer des gestionnaires d'erreurs personnalisés pour des exceptions spécifiques afin de fournir des réponses plus adaptées.

Découverte et utilisation des gestionnaires d'erreurs

webforJ utilise l'Interface de Fournisseur de Services (SPI) de Java pour découvrir et charger les gestionnaires d'erreurs.

Processus de découverte

1. Enregistrement de services : Les gestionnaires d'erreurs sont enregistrés via le mécanisme META-INF/services.
2. Chargement de services : Lors du démarrage de l'application, webforJ charge toutes les classes répertoriées dans META-INF/services/com.webforj.error.ErrorHandler.
3. Gestion des erreurs : Lorsqu'une exception se produit, webforJ vérifie si un gestionnaire d'erreurs existe pour cette exception spécifique.

Sélection du gestionnaire

• Si un gestionnaire spécifique pour l'exception existe, il est utilisé.
• Si aucun gestionnaire spécifique n'est trouvé, mais qu'un gestionnaire d'erreurs global personnalisé WebforjGlobalErrorHandler est défini, il est utilisé.
• Si aucun des deux n'est trouvé, le GlobalErrorHandler par défaut est utilisé.

L'interface ErrorHandler

L'interface ErrorHandler est conçue pour gérer les erreurs qui se produisent lors de l'exécution d'une application webforJ. Les applications qui souhaitent gérer des exceptions spécifiques doivent implémenter cette interface.

Méthodes

• onError(Throwable throwable, boolean debug) : Appelée lorsqu'une erreur se produit. Cette méthode doit contenir la logique pour gérer l'exception.
• showErrorPage(String title, String content) : Une méthode par défaut qui affiche la page d'erreur avec le titre et le contenu donnés.

Convention de nommage

La classe d'implémentation doit être nommée d'après l'exception qu'elle gère, avec le suffixe ErrorHandler. Par exemple, pour gérer NullPointerException, la classe doit être nommée NullPointerExceptionErrorHandler.

Enregistrement

Le gestionnaire d'erreurs personnalisé doit être enregistré dans le fichier META-INF/services/com.webforj.error.ErrorHandler afin que webforJ puisse le découvrir et l'utiliser.

Implémentation d'un gestionnaire d'erreurs personnalisé

Les étapes suivantes détaillent l'implémentation d'un gestionnaire d'erreurs personnalisé pour une exception spécifique :

Étape 1 : Créer la classe de gestionnaire d'erreurs

Créez une nouvelle classe qui implémente l'interface ErrorHandler et est nommée d'après l'exception qu'elle gère.

package com.example.error;

import com.webforj.error.ErrorHandler;

public class NullPointerExceptionErrorHandler implements ErrorHandler {

  @Override
  public void onError(Throwable throwable, boolean debug) {
    // Logique de traitement personnalisée pour NullPointerException
    String title = "Exception de pointeur nul";
    String content = "Une valeur nulle a été rencontrée là où un objet est requis.";

    showErrorPage(title, content);
  }
}

Méthode showErrorPage()

La méthode showErrorPage est une méthode utilitaire qui utilise l'API webforJ pour envoyer le contenu HTML fourni et le titre de la page au navigateur, affichant une page d'erreur. Lorsqu'une exception se produit et que l'application est incapable de récupérer, il devient impossible d'utiliser les composants webforJ pour construire une page d'erreur personnalisée. Cependant, l'API Page reste accessible, permettant au développeur de rediriger ou d'afficher une page d'erreur en ultime recours.

Étape 2 : Enregistrer le gestionnaire d'erreurs

Créez un fichier nommé com.webforj.error.ErrorHandler dans le répertoire META-INF/services de votre application. Ajoutez le nom complet de votre classe de gestionnaire d'erreurs à ce fichier.

Fichier : META-INF/services/com.webforj.error.ErrorHandler

com.example.error.NullPointerExceptionErrorHandler

Maintenant, chaque fois qu'un NullPointerException est lancé, webforJ sélectionne votre gestionnaire enregistré et exécute sa logique pour gérer l'erreur.

Utilisation de AutoService pour simplifier l'enregistrement

Il est facile pour les développeurs d'oublier de mettre à jour ou de préciser correctement les descripteurs de service. En utilisant AutoService de Google, vous pouvez automatiser la génération du fichier META-INF/services/com.webforj.error.ErrorHandler. Tout ce que vous avez à faire est d'annoter le gestionnaire d'erreurs avec l'annotation AutoService. Vous pouvez en savoir plus sur AutoService ici.

@AutoService(ErrorHandler.class)
public class NullPointerExceptionErrorHandler implements ErrorHandler {

  @Override
  public void onError(Throwable throwable, boolean debug) {
    // Logique de traitement personnalisée pour NullPointerException
    String title = "Exception de pointeur nul";
    String content = "Une valeur nulle a été rencontrée là où un objet est requis.";

    showErrorPage(title, content);
  }
}

La classe GlobalErrorHandler

Le GlobalErrorHandler est le gestionnaire d'erreurs par défaut fourni par webforJ. Il implémente l'interface ErrorHandler et fournit une gestion des erreurs générique.

Comportement

• Journalisation : Les erreurs sont enregistrées dans les consoles du serveur et du navigateur.
• Affichage de la page d'erreur : En fonction du mode de débogage, la page d'erreur affiche la trace de la pile ou un message d'erreur générique.

Définir un gestionnaire d'erreurs global personnalisé

Pour définir un gestionnaire d'erreurs global, vous devez créer un nouveau gestionnaire d'erreurs nommé WebforjGlobalErrorHandler, puis suivre les étapes pour enregistrer des gestionnaires d'erreurs comme expliqué précédemment. Dans ce cas, webforJ recherche d'abord tous les gestionnaires d'erreurs personnalisés pour gérer les exceptions. Si aucun n'est trouvé, webforJ revient au gestionnaire d'erreurs global personnalisé.

info

Si plusieurs WebforjGlobalErrorHandler sont enregistrés, alors webforJ sélectionne le premier