Sample project

https://github.com/ebpro/sample-annotationprocessor

Qu’est-ce qu’un processeur d’annotations ?

• Définition simple: Un processeur d’annotations est un outil qui analyse le code source à la recherche d’annotations spécifiques.

• Fonctionnement: Il intercepte le processus de compilation pour exécuter du code personnalisé en fonction des annotations trouvées.

• Analogie: C’est comme un “traducteur” qui transforme les annotations en instructions compréhensibles par la machine.

• Exemple: L’annotation @Override indique que une méthode redéfinie une méthode héritée. Le compilateur utilise cette information pour vérifier la cohérence. Qu’est-ce qu’un processeur d’annotations ?

• Définition simple: Un processeur d’annotations est un outil qui analyse le code source à la recherche d’annotations spécifiques.

• Fonctionnement: Il intercepte le processus de compilation pour exécuter du code personnalisé en fonction des annotations trouvées.

• Analogie: C’est comme un “traducteur” qui transforme les annotations en instructions compréhensibles par la machine.

• Exemple: L’annotation @Override indique que une méthode redéfinie une méthode héritée. Le compilateur utilise cette information pour vérifier la cohérence.

Pourquoi utiliser les processeurs d’annotations ?

• Génération de code: Automatisation de tâches répétitives (getters, setters, builders, etc.).
• Validation de données: Vérification de contraintes à la compilation (non-nullité, plages de valeurs, etc.).
• Configuration: Paramétrage de composants à partir d’annotations.
• Documentation: Génération automatique de documentation à partir d’annotations.
• Intégration avec d’autres outils: Liaison avec des outils de build, de test, etc.

Le framework APT (Annotation Processing Tool)

• Rôle: Fournit l’infrastructure de base pour développer des processeurs d’annotations.
• Interfaces clés:
  • Processor: Point d’entrée du processeur.
  • RoundEnvironment: Contient les éléments annotés lors d’un round de traitement.
  • AnnotationMirror: Représente une annotation.
• Cycle de vie:
  • Initialisation
  • Traitement des annotations
  • Génération de code
  • Nettoyage

Création d’une annotation personnalisée

• Syntaxe:

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.SOURCE)
public @interface Log {
  String value() default "";
}

• Éléments:
  • @Target: Indique où l’annotation peut être utilisée (méthodes, classes, etc.).
  • @Retention: Détermine la durée de vie de l’annotation.
  • value: Attribut de l’annotation.

Implémentation d’un processeur simple

public class LogProcessor implements Processor {
    // ...
    @Override
    public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
        for (Element element : roundEnv.getElementsAnnotatedWith(Log.class)) {
            // Traitement de l'élément annoté (cf. ci-dessous)
        }
        return true;
    }
}

Cas d’utilisation concrets

• Validation de données: Vérifier la cohérence des données avant leur utilisation.
• Génération de code pour des frameworks: ORM, REST, etc.
• Configuration de projets: Charger des propriétés à partir d’annotations.
• Documentation: Générer des rapports, des diagrammes, etc.

Bonnes pratiques et pièges à éviter

• Modularité: Séparer les différentes responsabilités du processeur.
• Testabilité: Écrire des tests unitaires pour vérifier le comportement du processeur.
• Documentation: Documenter clairement le processeur et ses fonctionnalités.
• Éviter les régressions infinies: Assurez-vous que le processeur ne génère pas de code qui déclenche à nouveau le traitement.