Einrichten von Lombok mit Eclipse und Intellij

1. Übersicht

Lombok ist eine Bibliothek, die viele mühsame Aufgaben erleichtert und die Ausführlichkeit des Java-Quellcodes verringert.

Natürlich möchten wir normalerweise die Bibliothek in einer IDE verwenden können, was zusätzliche Einstellungen erfordert.

In diesem Tutorial werden wir uns mit der Konfiguration in zwei der beliebtesten Java-IDEs befassen - IntelliJ IDEA und Eclipse .

2. Lombok in IntelliJ IDEA

2.1. Aktivieren der Anmerkungsverarbeitung

Lombok verwendet die Annotationsverarbeitung über APT. Wenn der Compiler sie aufruft, generiert die Bibliothek neue Quelldateien basierend auf Annotationen in den Originalen.

Die Verarbeitung von Anmerkungen ist jedoch standardmäßig nicht aktiviert.

Das erste, was wir tun müssen, ist, die Annotationsverarbeitung in unserem Projekt zu aktivieren.

Wir müssen zu den Einstellungen gehen Erstellen, Ausführen, Bereitstellen | Compiler | Annotation Processors und stellen Sie Folgendes sicher:

  • Das Kontrollkästchen Anmerkungsverarbeitung aktivieren ist aktiviert
  • Die Option Prozessoren aus Projektklassenpfad beziehen ist ausgewählt

2.2. Installieren des IDE-Plugins

Da Lombok Code nur während der Kompilierung generiert, hebt die IDE Fehler im Rohquellcode hervor:

Es gibt ein spezielles Plugin, das IntelliJ auf den zu generierenden Quellcode aufmerksam macht. Nach der Installation verschwinden die Fehler und reguläre Funktionen wie Verwendungen suchen , Navigieren, um mit der Arbeit zu beginnen.

Wir müssen zu den Einstellungen gehen Plugins , öffnen Sie die Registerkarte Marketplace , geben Sie lombok ein und wählen Sie Lombok Plugin von Michail Plushnikov :

Klicken Sie anschließend auf der Plugin-Seite auf die Schaltfläche Installieren :

Klicken Sie nach der Installation auf die Schaltfläche IDE neu starten:

3. Lombok in Eclipse

Wenn wir Eclipse IDE verwenden, müssen wir zuerst das Lombok-Glas besorgen. Die neueste Version befindet sich in Maven Central. In unserem Beispiel verwenden wir lombok-1.18.4.jar.

Als nächstes können wir das jar über den Befehl java -jar ausführen und eine Installer-Benutzeroberfläche wird geöffnet. Dadurch wird versucht, alle verfügbaren Eclipse-Installationen automatisch zu erkennen. Es ist jedoch auch möglich, den Speicherort manuell anzugeben.

Sobald wir die Installationen ausgewählt haben, klicken wir auf die Schaltfläche Installieren / Aktualisieren :

Wenn die Installation erfolgreich ist, können wir das Installationsprogramm beenden.

Nach der Installation des Plugins müssen wir die IDE neu starten und sicherstellen, dass Lombok korrekt konfiguriert ist. Wir können dies im Dialogfeld " Info " überprüfen :

4. Hinzufügen von Lombok zum Compile Classpath

Der letzte verbleibende Teil besteht darin, sicherzustellen, dass sich Lombok-Binärdateien im Compiler-Klassenpfad befinden. Mit Maven können wir die Abhängigkeit zur pom.xml hinzufügen :

  org.projectlombok lombok 1.18.10 provided  

Die neueste Version befindet sich in Maven Central.

Jetzt sollte alles in Ordnung sein, der folgende Quellcode sollte fehlerfrei in der IDE angezeigt, korrekt kompiliert und ausgeführt werden:

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. Schlussfolgerung

Lombok leistet hervorragende Arbeit bei der Reduzierung der Java-Ausführlichkeit und beim Abdecken von Boilerplate-Dingen unter der Haube. In diesem Artikel haben wir überprüft, wie das Tool für die beiden beliebtesten Java-IDEs konfiguriert wird.

Der Quellcode für die Beispiele ist auf GitHub verfügbar.