Introduzione al progetto Lombok

1. Evita il codice ripetitivo

Java è un ottimo linguaggio, ma a volte diventa troppo prolisso per le cose che devi fare nel tuo codice per attività comuni o per la conformità con alcune pratiche del framework. Questi molto spesso non apportano alcun valore reale al lato commerciale dei tuoi programmi - ed è qui che Lombok è qui per rendere la tua vita più felice e più produttivo.

Il modo in cui funziona è collegarsi al processo di compilazione e generare automaticamente il bytecode Java nei file .class in base a una serie di annotazioni di progetto introdotte nel codice.

Includerlo nelle build, a prescindere dal sistema in uso, è molto semplice. La loro pagina del progetto ha istruzioni dettagliate sulle specifiche. La maggior parte dei miei progetti sono basati su esperti, quindi di solito elimino la loro dipendenza dall'ambito fornito e sono a posto:

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

Controlla la versione più recente disponibile qui.

Nota che dipendere da Lombok non farà dipendere anche gli utenti dei tuoi .jar , poiché è una pura dipendenza di build, non runtime.

2. Getters / Setters, costruttori - Così ripetitivi

L'incapsulamento delle proprietà degli oggetti tramite metodi pubblici getter e setter è una pratica comune nel mondo Java e molti framework si basano ampiamente su questo modello "Java Bean": una classe con un costruttore vuoto e metodi get / set per le "proprietà".

Questo è così comune che la maggior parte degli IDE supporta il codice di generazione automatica per questi modelli (e altro). Questo codice, tuttavia, deve risiedere nelle tue fonti e anche essere mantenuto quando, ad esempio, viene aggiunta una nuova proprietà o viene rinominato un campo.

Consideriamo questa classe che vogliamo utilizzare come entità JPA come esempio:

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

Questa è una classe piuttosto semplice, ma considera comunque che se aggiungessimo il codice extra per getter e setter, ci ritroveremmo con una definizione in cui avremmo più codice a valore zero standard rispetto alle informazioni aziendali pertinenti: "un utente ha prima e cognomi ed età. "

Vediamo ora Lombok-ize questa classe:

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

Aggiungendo le annotazioni @Getter e @Setter abbiamo detto a Lombok di generarle per tutti i campi della classe. @NoArgsConstructor porterà a una generazione di costruttori vuoti.

Nota che questo è l' intero codice della classe, non sto omettendo nulla rispetto alla versione sopra con il commento // getter e setter . Per una classe di tre attributi rilevanti, questo è un notevole risparmio di codice!

Se aggiungi ulteriormente attributi (proprietà) alla tua classe User , accadrà lo stesso: hai applicato le annotazioni al tipo stesso in modo che si occupino di tutti i campi per impostazione predefinita.

E se volessi affinare la visibilità di alcune proprietà? Ad esempio, mi piace mantenere visibile il pacchetto dei modificatori del campo id delle mie entità o protetto perché ci si aspetta che vengano letti ma non impostati esplicitamente dal codice dell'applicazione. Usa solo un @Setter a grana più fine per questo particolare campo:

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

3. Getter pigro

Spesso le applicazioni devono eseguire operazioni costose e salvare i risultati per un utilizzo successivo.

Ad esempio, supponiamo di dover leggere dati statici da un file o da un database. In genere è buona norma recuperare questi dati una volta e quindi memorizzarli nella cache per consentire le letture in memoria all'interno dell'applicazione. Ciò evita all'applicazione di ripetere l'operazione costosa.

Un altro modello comune consiste nel recuperare questi dati solo quando sono necessari per la prima volta . In altre parole, ottieni i dati solo quando il getter corrispondente viene chiamato per la prima volta. Questo si chiama caricamento lento .

Supponiamo che questi dati siano memorizzati nella cache come campo all'interno di una classe. La classe deve ora assicurarsi che qualsiasi accesso a questo campo restituisca i dati memorizzati nella cache. Un modo possibile per implementare una tale classe è fare in modo che il metodo getter recuperi i dati solo se il campo è nullo . Per questo motivo, lo chiamiamo un getter pigro .

Lombok rende possibile con il pigro parametro nel @ Getter annotazione abbiamo visto sopra.

Ad esempio, considera questa semplice classe:

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

Questo legge alcune transazioni da un file in una mappa . Poiché i dati nel file non cambiano, li memorizzeremo una volta nella cache e consentiremo l'accesso tramite un getter.

Se ora guardiamo il codice compilato di questa classe, vedremo un metodo getter che aggiorna la cache se era nulla e quindi restituisce i dati memorizzati nella 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)); } }

È interessante sottolineare che Lombok ha racchiuso il campo dati in un AtomicReference. Ciò garantisce aggiornamenti atomici al campo delle transazioni . Il metodo getTransactions () si assicura anche di leggere il file se le transazioni sono nulle.

The use of the AtomicReference transactions field directly from within the class is discouraged. It's recommended to use the getTransactions() method for accessing the field.

For this reason, if we use another Lombok annotation like ToString in the same class, it will use getTransactions() instead of directly accessing the field.

4. Value Classes/DTO's

There are many situations in which we want to define a data type with the sole purpose of representing complex “values” or as “Data Transfer Objects”, most of the time in the form of immutable data structures we build once and never want to change.

We design a class to represent a successful login operation. We want all fields to be non-null and objects be immutable so that we can thread-safely access its properties:

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 }

Again, the amount of code we'd have to write for the commented sections would be of a much larger volume that the information we want to encapsulate and that has real value for us. We can use Lombok again to improve this:

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

Just add the @RequiredArgsConstructor annotation and you'd get a constructor for all the final fields int the class, just as you declared them. Adding @NonNull to attributes makes our constructor check for nullability and throw NullPointerExceptions accordingly. This would also happen if the fields were non-final and we added @Setter for them.

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.

Inoltre, la maggior parte delle funzioni che abbiamo mostrato hanno una serie di opzioni di personalizzazione che potresti trovare utili per far sì che lo strumento generi cose più conformi alle pratiche del tuo team per la denominazione, ecc. Anche il sistema di configurazione integrato disponibile potrebbe aiutarti in questo.

Spero che tu abbia trovato la motivazione per dare a Lombok la possibilità di entrare nel tuo set di strumenti di sviluppo Java. Fai una prova e aumenta la tua produttività!

Il codice di esempio può essere trovato nel progetto GitHub.