Einführung in das Projekt Lombok

Lombok ist eines der Tools, die ich buchstäblich immer als erstes in meine Projekte einbaue. Ich könnte mir nicht vorstellen, Java heutzutage ohne es zu programmieren. Ich hoffe wirklich, dass Sie seine Kraft finden, diesen Artikel zu lesen!

1. Vermeiden Sie sich wiederholenden Code

Java ist eine großartige Sprache, aber es wird manchmal zu ausführlich für Dinge, die Sie in Ihrem Code für allgemeine Aufgaben oder die Einhaltung einiger Framework-Praktiken tun müssen. Diese bringen häufig keinen wirklichen Nutzen für die Geschäftsseite Ihrer Programme - und hier ist Lombok für Sie da, um Ihr Leben glücklicher und produktiver zu gestalten.

Die Funktionsweise besteht darin, sich in Ihren Erstellungsprozess einzufügen und Java-Bytecode gemäß einer Reihe von Projektanmerkungen, die Sie in Ihren Code einfügen, automatisch in die.class-Dateien zu generieren.

Weitere Lektüre:

Lombok Builder mit Standardwert

Erfahren Sie, wie Sie mit Lombok Standardeigenschaftswerte für Builder erstellen

Lombok mit Eclipse und Intellij einrichten

Erfahren Sie, wie Sie Lombok mit gängigen IDEs einrichten

2. Getters/Setters, Constructors – So Repetitive

Das Einkapseln von Objekteigenschaften über öffentliche Getter- und Setter-Methoden ist in der Java-Welt weit verbreitet, und viele Frameworks stützen sich weitgehend auf dieses „Java Bean“ -Muster: eine Klasse mit einem leeren Konstruktor und Get / Set-Methoden für „Properties“.

Dies ist so häufig, dass die meisten IDEs den Code für die automatische Generierung dieser Muster (und mehr) unterstützen. Dieser Code muss sich jedoch in Ihren Quellen befinden und auch beibehalten werden, wenn beispielsweise eine neue Eigenschaft hinzugefügt oder ein Feld umbenannt wird.

Betrachten wir diese Klasse, die wir als JPA-Entität verwenden möchten, als Beispiel:

@Entity
public class User implements Serializable {

    private @Id Long id; // will be set when persisting

    private String firstName;
    private String lastName;
    private int age;

    public User() {
    }

    public User(String firstName, String lastName, int age) {
        this.firstName = firstName;
        this.lastName = lastName;
        this.age = age;
    }

    // getters and setters: ~30 extra lines of code
}

Dies ist eine ziemlich einfache Klasse, aber wenn wir den zusätzlichen Code für Getter und Setter hinzufügen, erhalten wir eine Definition, bei der wir mehr Nullwertcode als die relevanten Geschäftsinformationen haben würden: „Ein Benutzer hat zuerst und Nachnamen und Alter. "

Lassen Sie uns jetztLombok-ize diese Klasse:

@Entity
@Getter @Setter @NoArgsConstructor // <--- THIS is it
public class User implements Serializable {

    private @Id Long id; // will be set when persisting

    private String firstName;
    private String lastName;
    private int age;

    public User(String firstName, String lastName, int age) {
        this.firstName = firstName;
        this.lastName = lastName;
        this.age = age;
    }
}

Durch Hinzufügen der Anmerkungen@Getter und@Setter haben wir Lombok angewiesen, diese für alle Felder der Klasse zu generieren. @NoArgsConstructor führt zu einer leeren Konstruktorgenerierung.

Beachten Sie, dass dies der Klassencode vonwholeist. Ich lasse nichts aus, im Gegensatz zu der obigen Version mit dem Kommentar von// getters and setters. Für eine Klasse mit drei relevanten Attributen bedeutet dies eine erhebliche Codeeinsparung!

Wenn Sie Ihrer KlasseUserweitere Attribute (Eigenschaften) hinzufügen, geschieht dasselbe: Sie haben die Anmerkungen auf den Typ selbst angewendet, sodass sie standardmäßig alle Felder berücksichtigen.

Was wäre, wenn Sie die Sichtbarkeit einiger Objekte optimieren möchten? Zum Beispiel möchte ich die Feldmodifikatorenpackage oderprotected meiner Entitäten sichtbar halten, da erwartet wird, dass sie gelesen, aber nicht explizit durch den Anwendungscode festgelegt werden. Verwenden Sie einfach feinkörnigere@Setter für dieses spezielle Feld:

private @Id @Setter(AccessLevel.PROTECTED) Long id;

3. Lazy Getter

Oft müssen Anwendungen teure Vorgänge ausführen und die Ergebnisse für die spätere Verwendung speichern.

Angenommen, wir müssen statische Daten aus einer Datei oder einer Datenbank lesen. Im Allgemeinen empfiehlt es sich, diese Daten einmal abzurufen und dann zwischenzuspeichern, um In-Memory-Lesevorgänge in der Anwendung zu ermöglichen. Dies erspart der Anwendung, den teuren Vorgang zu wiederholen.

Ein weiteres häufiges Muster istretrieve this data only when it’s first needed. Mit anderen Worten,only get the data when the corresponding getter is called the first time. This is called lazy-loading.

Angenommen, diese Daten werden als Feld in einer Klasse zwischengespeichert. Die Klasse muss jetzt sicherstellen, dass jeder Zugriff auf dieses Feld die zwischengespeicherten Daten zurückgibt. Eine Möglichkeit, eine solche Klasse zu implementieren, besteht darin, die Getter-Methode die Daten nur dann abrufen zu lassen, wenn das Feldnull ist. Aus diesem Grund istwe call this a lazy getter.

Lombok macht dies mit den oben gesehenenlazy parameter in the @Getter annotation möglich.

Betrachten Sie zum Beispiel diese einfache Klasse:

public class GetterLazy {

    @Getter(lazy = true)
    private final Map transactions = readTxnsFromFile();

    private Map readTxnsFromFile() {

        final Map cache = new HashMap<>();
        List txnRows = readTxnListFromFile();

        txnRows.forEach(s -> {
            String[] txnIdValueTuple = s.split(DELIMETER);
            cache.put(txnIdValueTuple[0], Long.parseLong(txnIdValueTuple[1]));
        });

        return cache;
    }
}

Dies liest einige Transaktionen aus einer Datei inMap. Da sich die Daten in der Datei nicht ändern, werden sie einmal zwischengespeichert und der Zugriff über einen Getter ermöglicht.

Wenn wir uns jetzt den kompilierten Code dieser Klasse ansehen, sehen wir eingetter method which updates the cache if it was null and then returns the cached data:

public class GetterLazy {

    private final AtomicReference

TOC

Einführung in das Projekt Lombok