Introducere în Proiectul Lombok

1. Evitați codul repetitiv

Java este un limbaj excelent, dar uneori devine prea detaliat pentru lucrurile pe care trebuie să le faceți în codul dvs. pentru sarcini obișnuite sau respectarea unor practici cadru. De cele mai multe ori acestea nu aduc nici o valoare reală pentru partea de afaceri a programelor dvs. - și aici este locul unde Lombok este aici pentru a vă face viața mai fericită și a vă face mai productiv.

Modul în care funcționează este conectarea la procesul de construire și generarea automată a codului secundar Java în fișierele dvs. .class conform unui număr de adnotări de proiect pe care le introduceți în cod.

Includerea acestuia în versiunile dvs., indiferent de sistemul pe care îl utilizați, este foarte simplă. Pagina proiectului lor conține instrucțiuni detaliate cu privire la detalii. Majoritatea proiectelor mele sunt bazate pe maven, așa că, de obicei, renunț la dependența lor în domeniul de aplicare furnizat și sunt bine să merg:

 ...  org.projectlombok lombok 1.18.10 provided  ... 

Căutați cea mai recentă versiune disponibilă aici.

Rețineți că, în funcție de Lombok, nu îi va determina și pe utilizatorii fișierelor .jar să depindă de acesta, deoarece este o dependență pură de compilare, nu runtime.

2. Getters / Setters, Constructors - Deci repetitive

Incapsularea proprietăților obiectelor prin metode publice de tip getter și setter este o practică atât de obișnuită în lumea Java, iar o mulțime de cadre se bazează pe acest model „Java Bean” pe larg: o clasă cu un constructor gol și metode get / set pentru „proprietăți”.

Acest lucru este atât de obișnuit încât majoritatea IDE acceptă codul de generare automată pentru aceste modele (și multe altele). Cu toate acestea, acest cod trebuie să locuiască în sursele dvs. și, de asemenea, să fie menținut atunci când, să zicem, o nouă proprietate este adăugată sau un câmp redenumit.

Să luăm în considerare această clasă pe care dorim să o folosim ca entitate JPA ca exemplu:

@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 }

Aceasta este o clasă destul de simplă, dar totuși luați în considerare dacă am adăuga codul suplimentar pentru getters și seteri, am ajunge la o definiție în care am avea mai multe coduri de valoare zero decât informațiile comerciale relevante: numele de familie și vârsta. ”

Haideți acum Lombok-ize această clasă:

@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; } }

Prin adăugarea @Getter și @Setter adnotările am spus Lombok la, bine, pentru a genera aceste toate domeniile clasei. @NoArgsConstructor va duce la o generație goală de constructori.

Rețineți că acesta este întregul cod al clasei, nu omit nimic, spre deosebire de versiunea de mai sus, cu // getters and seters comment. Pentru o clasă de trei atribute relevante, aceasta este o economie semnificativă în cod!

Dacă adăugați în continuare atribute (proprietăți) la clasa dvs. de Utilizator , se va întâmpla același lucru: ați aplicat adnotările la tipul în sine, astfel încât aceștia să aibă în vedere implicit toate câmpurile.

Ce se întâmplă dacă doriți să rafinați vizibilitatea unor proprietăți? De exemplu, îmi place să păstrez vizibil pachetul de modificatori ai câmpului de identitate al entităților sau protejat, deoarece se așteaptă să fie citit, dar nu setat în mod explicit de codul aplicației. Folosiți doar un @Setter cu granulație mai fină pentru acest câmp special:

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

3. Lazy Getter

Adesea, aplicațiile trebuie să efectueze unele operațiuni costisitoare și să salveze rezultatele pentru o utilizare ulterioară.

De exemplu, să presupunem că trebuie să citim date statice dintr-un fișier sau dintr-o bază de date. În general, este o bună practică să preluați aceste date o dată și apoi să le memorați în cache pentru a permite citirile în memorie în cadrul aplicației. Acest lucru salvează aplicația de a repeta operațiunea costisitoare.

Un alt model obișnuit este preluarea acestor date numai atunci când sunt necesare pentru prima dată . Cu alte cuvinte, obțineți datele numai atunci când getter-ul corespunzător este apelat pentru prima dată. Aceasta se numește încărcare leneșă .

Să presupunem că aceste date sunt stocate în cache ca un câmp din interiorul unei clase. Clasa trebuie să se asigure acum că orice acces la acest câmp returnează datele din cache. O modalitate posibilă de a implementa o astfel de clasă este de a face ca metoda getter să recupereze datele numai dacă câmpul este nul . Din acest motiv, numim acest lucru un getger leneș .

Lombok face acest lucru posibil cu parametrul leneș din adnotarea @ Getter pe care am văzut-o mai sus.

De exemplu, luați în considerare această clasă simplă:

public class GetterLazy { @Getter(lazy = true) private final Map transactions = getTransactions(); private Map getTransactions() { 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; } }

Aceasta citește unele tranzacții dintr-un fișier într-o hartă . Deoarece datele din fișier nu se modifică, le vom memora în cache o dată și vom permite accesul prin intermediul unui getter.

Dacă ne uităm acum la codul compilat al acestei clase, vom vedea o metodă getter care actualizează memoria cache dacă a fost nulă și apoi returnează datele memorate în cache :

public class GetterLazy { private final AtomicReference transactions = new AtomicReference(); public GetterLazy() { } //other methods public Map getTransactions() { Object value = this.transactions.get(); if (value == null) { synchronized(this.transactions) { value = this.transactions.get(); if (value == null) { Map actualValue = this.readTxnsFromFile(); value = actualValue == null ? this.transactions : actualValue; this.transactions.set(value); } } } return (Map)((Map)(value == this.transactions ? null : value)); } }

Este interesant de menționat faptul că Lombok a înfășurat câmpul de date într-o AtomicReference. Acest lucru asigură actualizări atomice la câmpul de tranzacții . Metoda getTransactions () asigură, de asemenea, citirea fișierului dacă tranzacțiile sunt nule.

Este descurajată utilizarea câmpului de tranzacții AtomicReference direct din cadrul clasei. Este recomandat să utilizați metoda getTransactions () pentru accesarea câmpului.

Din acest motiv, dacă folosim o altă adnotare Lombok precum ToString din aceeași clasă , va folosi getTransactions () în loc să acceseze direct câmpul.

4. Clase valorice / DTO-uri

Există multe situații în care dorim să definim un tip de date cu singurul scop de a reprezenta „valori” complexe sau ca „Obiecte de transfer de date”, de cele mai multe ori sub formă de structuri de date imuabile pe care le construim o dată și niciodată nu vrem să le schimbăm .

Proiectăm o clasă pentru a reprezenta o operațiune de conectare reușită. Vrem ca toate câmpurile să nu fie nule și obiectele să fie imuabile, astfel încât să putem accesa în siguranță proprietățile sale:

public class LoginResult { private final Instant loginTs; private final String authToken; private final Duration tokenValidity; private final URL tokenRefreshUrl; // constructor taking every field and checking nulls // read-only accessor, not necessarily as get*() form }

Din nou, cantitatea de cod pe care ar trebui să o scriem pentru secțiunile comentate ar avea un volum mult mai mare pe care informațiile pe care dorim să le încapsulăm și care au o valoare reală pentru noi. Putem folosi Lombok din nou pentru a îmbunătăți acest lucru:

@RequiredArgsConstructor @Accessors(fluent = true) @Getter public class LoginResult { private final @NonNull Instant loginTs; private final @NonNull String authToken; private final @NonNull Duration tokenValidity; private final @NonNull URL tokenRefreshUrl; }

Doar adăugați adnotarea @RequiredArgsConstructor și veți obține un constructor pentru toate câmpurile finale din clasă, exact așa cum le-ați declarat. Adăugarea @NonNull la atribute face ca constructorul nostru să verifice nulitatea și să arunce NullPointerExceptions în consecință. Acest lucru s-ar întâmpla și în cazul în care câmpurile nu sunt finale și am adăuga @Setter pentru ele.

Don't you want boring old get*() form for your properties? Because we added @Accessors(fluent=true) in this example “getters” would have the same method name as the properties: getAuthToken() simply becomes authToken().

This “fluent” form would apply to non-final fields for attribute setters and as well allow for chained calls:

// Imagine fields were no longer final now return new LoginResult() .loginTs(Instant.now()) .authToken("asdasd") . // and so on

5. Core Java Boilerplate

Another situation in which we end up writing code we need to maintain is when generating toString(), equals() and hashCode() methods. IDEs try to help with templates for autogenerating these in terms of our class attributes.

We can automate this by means of other Lombok class-level annotations:

  • @ToString: will generate a toString() method including all class attributes. No need to write one ourselves and maintain it as we enrich our data model.
  • @EqualsAndHashCode: will generate both equals() and hashCode() methods by default considering all relevant fields, and according to very well though semantics.

These generators ship very handy configuration options. For example, if your annotated classes take part of a hierarchy you can just use the callSuper=true parameter and parent results will be considered when generating the method's code.

More on this: say we had our User JPA entity example include a reference to events associated to this user:

@OneToMany(mappedBy = "user") private List events;

We wouldn't like to have the whole list of events dumped whenever we call the toString() method of our User, just because we used the @ToString annotation. No problem: just parameterize it like this: @ToString(exclude = {“events”}), and that won't happen. This is also helpful to avoid circular references if, for example, UserEvents had a reference to a User.

For the LoginResult example, we may want to define equality and hash code calculation just in terms of the token itself and not the other final attributes in our class. Then, simply write something like @EqualsAndHashCode(of = {“authToken”}).

Bonus: if you liked the features from the annotations we've reviewed so far you may want to examine @Data and @Value annotations as they behave as if a set of them had been applied to our classes. After all, these discussed usages are very commonly put together in many cases.

5.1. (Not) Using the @EqualsAndHashCode With JPA Entities

Whether to use the default equals() and hashCode() methods or create custom ones for the JPA entities, is an often discussed topic among developers. There are multiple approaches we can follow; each having its pros and cons.

By default, @EqualsAndHashCode includes all non-final properties of the entity class. We can try to “fix” this by using the onlyExplicitlyIncluded attribute of the @EqualsAndHashCode to make Lombok use only the entity's primary key. Still, however, the generated equals() method can cause some issues. Thorben Janssen explains this scenario in greater detail in one of his blog posts.

In general, we should avoid using Lombok to generate the equals() and hashCode() methods for our JPA entities!

6. The Builder Pattern

The following could make for a sample configuration class for a REST API client:

public class ApiClientConfiguration { private String host; private int port; private boolean useHttps; private long connectTimeout; private long readTimeout; private String username; private String password; // Whatever other options you may thing. // Empty constructor? All combinations? // getters... and setters? }

We could have an initial approach based on using the class default empty constructor and providing setter methods for every field. However, we'd ideally want configurations not to be re-set once they've been built (instantiated), effectively making them immutable. We therefore want to avoid setters, but writing such a potentially long args constructor is an anti-pattern.

Instead, we can tell the tool to generate a builder pattern, preventing us to write an extra Builder class and associated fluent setter-like methods by simply adding the @Builder annotation to our ApiClientConfiguration.

@Builder public class ApiClientConfiguration { // ... everything else remains the same }

Leaving the class definition above as such (no declare constructors nor setters + @Builder) we can end up using it as:

ApiClientConfiguration config = ApiClientConfiguration.builder() .host("api.server.com") .port(443) .useHttps(true) .connectTimeout(15_000L) .readTimeout(5_000L) .username("myusername") .password("secret") .build();

7. Checked Exceptions Burden

Lots of Java APIs are designed so that they can throw a number of checked exceptions client code is forced to either catch or declare to throws. How many times have you turned these exceptions you know won't happen into something like this?

public String resourceAsString() { try (InputStream is = this.getClass().getResourceAsStream("sure_in_my_jar.txt")) { BufferedReader br = new BufferedReader(new InputStreamReader(is, "UTF-8")); return br.lines().collect(Collectors.joining("\n")); } catch (IOException | UnsupportedCharsetException ex) { // If this ever happens, then its a bug. throw new RuntimeException(ex); <--- encapsulate into a Runtime ex. } }

If you want to avoid this code patterns because the compiler won't be otherwise happy (and, after all, you know the checked errors cannot happen), use the aptly named @SneakyThrows:

@SneakyThrows public String resourceAsString() { try (InputStream is = this.getClass().getResourceAsStream("sure_in_my_jar.txt")) { BufferedReader br = new BufferedReader(new InputStreamReader(is, "UTF-8")); return br.lines().collect(Collectors.joining("\n")); } }

8. Ensure Your Resources Are Released

Java 7 introduced the try-with-resources block to ensure your resources held by instances of anything implementing java.lang.AutoCloseable are released when exiting.

Lombok provides an alternative way of achieving this, and more flexibly via @Cleanup. Use it for any local variable whose resources you want to make sure are released. No need for them to implement any particular interface, you'll just get its close() method called.

@Cleanup InputStream is = this.getClass().getResourceAsStream("res.txt");

Your releasing method has a different name? No problem, just customize the annotation:

@Cleanup("dispose") JFrame mainFrame = new JFrame("Main Window");

9. Annotate Your Class to Get a Logger

Many of us add logging statements to our code sparingly by creating an instance of a Logger from our framework of choice. Say, SLF4J:

public class ApiClientConfiguration { private static Logger LOG = LoggerFactory.getLogger(ApiClientConfiguration.class); // LOG.debug(), LOG.info(), ... }

This is such a common pattern that Lombok developers have cared to simplify it for us:

@Slf4j // or: @Log @CommonsLog @Log4j @Log4j2 @XSlf4j public class ApiClientConfiguration { // log.debug(), log.info(), ... }

Many logging frameworks are supported and of course you can customize the instance name, topic, etc.

10. Write Thread-Safer Methods

In Java you can use the synchronized keyword to implement critical sections. However, this is not a 100% safe approach: other client code can eventually also synchronize on your instance, potentially leading to unexpected deadlocks.

This is where @Synchronized comes in: annotate your methods (both instance and static) with it and you'll get an autogenerated private, unexposed field your implementation will use for locking:

@Synchronized public /* better than: synchronized */ void putValueInCache(String key, Object value) { // whatever here will be thread-safe code }

11. Automate Objects Composition

Java does not have language level constructs to smooth out a “favor composition inheritance” approach. Other languages have built-in concepts such as Traits or Mixins to achieve this.

Lombok's @Delegate comes in very handy when you want to use this programming pattern. Let's consider an example:

  • We want Users and Customers to share some common attributes for naming and phone number
  • We define both an interface and an adapter class for these fields
  • We'll have our models implement the interface and @Delegate to their adapter, effectively composing them with our contact information

First, let's define an interface:

public interface HasContactInformation { String getFirstName(); void setFirstName(String firstName); String getFullName(); String getLastName(); void setLastName(String lastName); String getPhoneNr(); void setPhoneNr(String phoneNr); }

And now an adapter as a support class:

@Data public class ContactInformationSupport implements HasContactInformation { private String firstName; private String lastName; private String phoneNr; @Override public String getFullName() { return getFirstName() + " " + getLastName(); } }

The interesting part comes now, see how easy it is to now compose contact information into both model classes:

public class User implements HasContactInformation { // Whichever other User-specific attributes @Delegate(types = {HasContactInformation.class}) private final ContactInformationSupport contactInformation = new ContactInformationSupport(); // User itself will implement all contact information by delegation }

The case for Customer would be so similar we'd omit the sample for brevity.

12. Rolling Lombok Back?

Short answer: Not at all really.

You may be worried there is a chance that you use Lombok in one of your projects, but later want to rollback that decision. You'd then have a maybe large number of classes annotated for it… what could you do?

I have never really regretted this, but who knows for you, your team or your organization. For these cases you're covered thanks to the delombok tool from the same project.

By delombok-ing your code you'd get autogenerated Java source code with exactly the same features from the bytecode Lombok built. So then you may simply replace your original annotated code with these new delomboked files and no longer depend on it.

This is something you can integrate in your build and I have done this in the past to just study the generated code or to integrate Lombok with some other Java source code based tool.

13. Conclusion

There are some other features we have not presented in this article, I'd encourage you to take a deeper dive into the feature overview for more details and use cases.

De asemenea, majoritatea funcțiilor pe care le-am arătat au o serie de opțiuni de personalizare pe care le puteți găsi la îndemână pentru ca instrumentul să genereze cele mai conforme cu practicile echipei dvs. pentru denumire etc. Sistemul de configurare încorporat disponibil vă poate ajuta, de asemenea, în acest sens.

Sper că ați găsit motivația pentru a oferi lui Lombok șansa de a intra în setul dvs. de instrumente de dezvoltare Java. Încercați și sporiți-vă productivitatea!

Exemplul de cod poate fi găsit în proiectul GitHub.