Introduction au projet Lombok

1. Évitez les codes répétitifs

Java est un excellent langage mais il devient parfois trop verbeux pour les choses que vous devez faire dans votre code pour les tâches courantes ou la conformité avec certaines pratiques du framework. Celles-ci n'apportent très souvent aucune valeur réelle au côté commercial de vos programmes - et c'est là que Lombok est là pour rendre votre vie plus heureuse et vous-même plus productive.

La façon dont cela fonctionne consiste à se connecter à votre processus de construction et à générer automatiquement le bytecode Java dans vos fichiers .class selon un certain nombre d'annotations de projet que vous introduisez dans votre code.

L'inclure dans vos builds, quel que soit le système que vous utilisez, est très simple. Leur page de projet contient des instructions détaillées sur les détails. La plupart de mes projets sont basés sur maven, donc je laisse généralement tomber leur dépendance dans la portée fournie et je suis prêt à partir:

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

Recherchez la version disponible la plus récente ici.

Notez que dépendre de Lombok ne fera pas dépendre les utilisateurs de votre .jar , car il s'agit d'une dépendance de construction pure, pas d'exécution.

2. Getters / Setters, constructeurs - si répétitifs

L'encapsulation des propriétés d'objet via les méthodes publiques getter et setter est une pratique courante dans le monde Java, et de nombreux frameworks s'appuient largement sur ce modèle «Java Bean»: une classe avec un constructeur vide et des méthodes get / set pour les «propriétés».

Ceci est si courant que la plupart des IDE prennent en charge le code de génération automatique pour ces modèles (et plus). Ce code doit cependant vivre dans vos sources et également être conservé lorsque, par exemple, une nouvelle propriété est ajoutée ou un champ renommé.

Considérons cette classe que nous voulons utiliser comme entité JPA à titre d'exemple:

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

C'est une classe assez simple, mais considérez toujours que si nous ajoutions le code supplémentaire pour les getters et les setters, nous finirions par avoir une définition où nous aurions plus de code standard à valeur nulle que les informations commerciales pertinentes: "un utilisateur a d'abord et noms de famille et âge. »

Laissez-nous maintenant Lombok-ize cette 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; } }

En ajoutant les annotations @Getter et @Setter, nous avons dit à Lombok de les générer pour tous les champs de la classe. @NoArgsConstructor conduira à une génération de constructeur vide.

Notez que c'est tout le code de la classe, je n'omets rien par opposition à la version ci-dessus avec le commentaire // getters et setters . Pour une classe de trois attributs pertinents, c'est une économie de code significative!

Si vous ajoutez davantage d'attributs (propriétés) à votre classe User , la même chose se produira: vous avez appliqué les annotations au type lui-même afin qu'elles s'occupent de tous les champs par défaut.

Et si vous vouliez affiner la visibilité de certaines propriétés? Par exemple, j'aime garder le package de modificateurs de champ d' identifiant de mes entités ou protégé visible car ils sont censés être lus mais pas explicitement définis par le code d'application. Utilisez simplement un @Setter plus fin pour ce champ particulier:

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

3. Lazy Getter

Souvent, les applications doivent effectuer des opérations coûteuses et enregistrer les résultats pour une utilisation ultérieure.

Par exemple, disons que nous devons lire des données statiques à partir d'un fichier ou d'une base de données. Il est généralement recommandé de récupérer ces données une fois, puis de les mettre en cache pour permettre les lectures en mémoire dans l'application. Cela évite à l'application de répéter l'opération coûteuse.

Un autre modèle courant consiste à récupérer ces données uniquement lorsqu'elles sont nécessaires pour la première fois . En d'autres termes, n'obtenez les données que lorsque le getter correspondant est appelé la première fois. C'est ce qu'on appelle le chargement paresseux .

Supposons que ces données soient mises en cache en tant que champ à l'intérieur d'une classe. La classe doit maintenant s'assurer que tout accès à ce champ renvoie les données mises en cache. Une manière possible d'implémenter une telle classe consiste à faire en sorte que la méthode getter récupère les données uniquement si le champ est nul . Pour cette raison, nous appelons cela un getter paresseux .

Lombok rend cela possible avec le paramètre paresseux dans l' annotation @ Getter que nous avons vue ci-dessus.

Par exemple, considérez cette classe simple:

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

Cela lit certaines transactions d'un fichier dans une carte . Puisque les données du fichier ne changent pas, nous les mettrons en cache une fois et autoriserons l'accès via un getter.

Si nous regardons maintenant le code compilé de cette classe, nous verrons une méthode getter qui met à jour le cache s'il était nul , puis retourne les données mises en 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)); } }

Il est intéressant de souligner que Lombok a enveloppé le champ de données dans un AtomicReference. Cela garantit des mises à jour atomiques du champ des transactions . La méthode getTransactions () s'assure également de lire le fichier si les transactions sont nulles.

L'utilisation du champ de transactions AtomicReference directement à partir de la classe est déconseillée. Il est recommandé d'utiliser la méthode getTransactions () pour accéder au champ.

Pour cette raison, si nous utilisons une autre annotation Lombok comme ToString dans la même classe , elle utilisera getTransactions () au lieu d'accéder directement au champ.

4. Classes de valeur / DTO

Il existe de nombreuses situations dans lesquelles nous voulons définir un type de données dans le seul but de représenter des «valeurs» complexes ou comme des «objets de transfert de données», la plupart du temps sous la forme de structures de données immuables que nous construisons une fois et que nous ne voulons jamais changer .

Nous concevons une classe pour représenter une opération de connexion réussie. Nous voulons que tous les champs soient non nuls et que les objets soient immuables afin de pouvoir accéder en toute sécurité à ses propriétés:

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 }

Encore une fois, la quantité de code que nous aurions à écrire pour les sections commentées serait d'un volume beaucoup plus important que les informations que nous voulons encapsuler et qui ont une valeur réelle pour nous. Nous pouvons à nouveau utiliser Lombok pour améliorer cela:

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

Ajoutez simplement l' annotation @RequiredArgsConstructor et vous obtiendrez un constructeur pour tous les champs finaux de la classe, comme vous les avez déclarés. L'ajout de @NonNull aux attributs permet à notre constructeur de vérifier la nullité et de lancer des exceptions NullPointerExceptions en conséquence. Cela se produirait également si les champs n'étaient pas définitifs et que nous ajoutions @Setter pour eux.

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 plus, la plupart des fonctions que nous avons présentées ont un certain nombre d'options de personnalisation que vous pouvez trouver utiles pour que l'outil génère les éléments les plus conformes aux pratiques de votre équipe en matière de dénomination, etc. Le système de configuration intégré disponible pourrait également vous aider.

J'espère que vous avez trouvé la motivation pour donner à Lombok une chance d'entrer dans votre ensemble d'outils de développement Java. Essayez-le et augmentez votre productivité!

L'exemple de code se trouve dans le projet GitHub.