Configurer Lombok avec Eclipse et Intellij

1. Vue d'ensemble

Lombok est une bibliothèque qui facilite de nombreuses tâches fastidieuses et réduit la verbosité du code source Java.

Bien sûr, nous voulons généralement pouvoir utiliser la bibliothèque dans un IDE, ce qui nécessite une configuration supplémentaire.

Dans ce didacticiel, nous parlerons de sa configuration dans deux des IDE Java les plus populaires - IntelliJ IDEA et Eclipse .

2. Lombok dans IntelliJ IDEA

2.1. Activation du traitement des annotations

Lombok utilise le traitement des annotations via APT, donc, lorsque le compilateur l'appelle, la bibliothèque génère de nouveaux fichiers source basés sur des annotations dans les originaux.

Cependant, le traitement des annotations n'est pas activé par défaut.

Donc, la première chose à faire pour nous est d'activer le traitement des annotations dans notre projet.

Nous devons aller dans les Préférences | Construction, exécution, déploiement | Compilateur | Processeurs d'annotations et assurez-vous des éléments suivants:

  • La case Activer le traitement des annotations est cochée
  • L' option Obtenir les processeurs à partir du chemin de classe du projet est sélectionnée

2.2. Installation du plug-in IDE

Comme Lombok génère du code uniquement lors de la compilation, l'EDI met en évidence les erreurs dans le code source brut:

Il existe un plugin dédié qui rend IntelliJ conscient du code source à générer. Après l'avoir installé, les erreurs disparaissent et les fonctionnalités régulières telles que Rechercher les utilisations , Naviguer pour commencer à fonctionner.

Nous devons aller dans les Préférences | Plugins , ouvrez l' onglet Marketplace , tapez lombok et choisissez Lombok Plugin par Michail Plushnikov :

Ensuite, cliquez sur le bouton Installer sur la page du plugin:

Après l'installation, cliquez sur le bouton Redémarrer l'IDE :

3. Lombok dans Eclipse

Si nous utilisons Eclipse IDE, nous devons d'abord obtenir le jar Lombok. La dernière version se trouve sur Maven Central. Pour notre exemple, nous utilisons lombok-1.18.4.jar.

Ensuite, nous pouvons exécuter le jar via la commande java -jar et une interface utilisateur d'installation s'ouvrira. Cela tente de détecter automatiquement toutes les installations Eclipse disponibles, mais il est également possible de spécifier l'emplacement manuellement.

Une fois que nous avons sélectionné les installations, nous appuyons sur le bouton Installer / Mettre à jour :

Si l'installation réussit, nous pouvons quitter le programme d'installation.

Après avoir installé le plugin, nous devons redémarrer l'EDI et nous assurer que Lombok est correctement configuré. Nous pouvons vérifier cela dans la boîte de dialogue À propos :

4. Ajout de Lombok au chemin de classe de compilation

La dernière partie restante est de s'assurer que les binaires Lombok sont sur le chemin de classe du compilateur. En utilisant Maven, nous pouvons ajouter la dépendance au pom.xml:

  org.projectlombok lombok 1.18.10 provided  

La version la plus récente se trouve sur Maven Central.

Tout devrait bien se passer maintenant, le code source ci-dessous devrait être affiché sans erreur dans l'EDI, correctement compilé et exécuté:

public class UserIntegrationTest { @Test public void givenAnnotatedUser_thenHasGettersAndSetters() { User user = new User(); user.setFirstName("Test"); assertEquals(user.gerFirstName(), "Test"); } @Getter @Setter class User { private String firstName; } }

5. Conclusion

Lombok fait un excellent travail en réduisant la verbosité Java et en couvrant les choses standard sous le capot. Dans cet article, nous avons vérifié comment configurer l'outil pour les deux IDE Java les plus populaires.

Le code source des exemples est disponible à l'adresse over sur GitHub.