Introduktion till Project Lombok

1. Undvik upprepad kod

Java är ett fantastiskt språk men det blir ibland för ordentligt för saker du måste göra i din kod för vanliga uppgifter eller efterlevnad av vissa ramrutiner. Dessa ger ofta inget verkligt värde för affärssidan av dina program - och det är här Lombok är här för att göra ditt liv lyckligare och dig själv mer produktiv.

Så det fungerar är att ansluta till din byggprocess och automatisera Java-bytkod till dina .class- filer enligt ett antal projektanteckningar som du introducerar i din kod.

Att inkludera det i dina byggnader, vilket system du använder, är väldigt rakt framåt. Deras projektsida har detaljerade instruktioner om detaljerna. De flesta av mina projekt är baserade på maven, så jag tappar vanligtvis bara deras beroende i det angivna omfånget och jag är redo att gå:

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

Sök efter den senaste tillgängliga versionen här.

Observera att beroende på Lombok inte kommer att göra att användare av dina .jar är beroende av det också, eftersom det är en ren byggberoende, inte runtime.

2. Getters / Setters, Constructors - So Repetitive

Inkapsling av objektegenskaper via offentliga getter- och settermetoder är en så vanlig praxis i Java-världen, och många ramar förlitar sig i stor utsträckning på detta “Java Bean” -mönster: en klass med en tom konstruktör och få / ställa in metoder för “egenskaper”.

Detta är så vanligt att de flesta IDE stöder autogenererande kod för dessa mönster (och mer). Den här koden måste emellertid finnas i dina källor och ska också upprätthållas när vi till exempel lägger till en ny egendom eller ett fält byter namn.

Låt oss betrakta den här klassen som vi vill använda som en JPA-enhet som ett exempel:

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

Det här är en ganska enkel klass, men överväga ändå om vi lade till den extra koden för getters och setter skulle vi sluta med en definition där vi skulle ha mer pannplattans nollvärde-kod än relevant affärsinformation: ”en användare har efternamn och ålder. ”

Låt oss nu Lombok-ize denna klass:

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

Genom att lägga till @Getter- och @Setter- anteckningarna sa vi till Lombok att, ja, generera dessa för alla klassens fält. @NoArgsConstructor leder till en tom konstruktörgenerering.

Observera att detta är hela klasskoden, jag utelämnar ingenting i motsats till versionen ovan med // getters and setters- kommentaren. För en tre relevanta attributklasser är detta en betydande besparing i kod!

Om du dessutom lägga till attribut (egenskaper) till din Användar klass kommer samma att hända: du tillämpat anteckningar på vilken typ själva så de kommer ihåg alla fält som standard.

Vad händer om du vill förfina synligheten för vissa fastigheter? Till exempel, jag gillar att hålla mina enheter id fält modifierare paket eller skyddade synlig eftersom de förväntas att läsas, men inte explicit av programkoden. Använd bara en finare kornad @Setter för just detta fält:

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

3. Lazy Getter

Ofta måste applikationer utföra dyra operationer och spara resultaten för senare användning.

Låt oss till exempel säga att vi måste läsa statisk data från en fil eller en databas. Det är i allmänhet en bra praxis att hämta dessa data en gång och sedan cacha dem för att tillåta läsning i minnet i programmet. Detta sparar applikationen från att upprepa den dyra operationen.

Ett annat vanligt mönster är att bara hämta dessa data när de behövs först . Med andra ord, få bara data när motsvarande getter anropas första gången. Detta kallas lat laddning .

Antag att dessa data är cachade som ett fält i en klass. Klassen måste nu se till att all åtkomst till det här fältet returnerar cachade data. Ett möjligt sätt att implementera en sådan klass är att få gettermetoden att hämta data endast om fältet är null . Av denna anledning, vi kallar det en lat getter .

Lombok gör detta möjligt med den lata parametern i @ Getter- kommentaren vi såg ovan.

Tänk till exempel på den här enkla klassen:

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

Detta läser in några transaktioner från en fil till en karta . Eftersom data i filen inte ändras cachar vi den en gång och tillåter åtkomst via en getter.

Om vi ​​nu tittar på den kompilerade koden för den här klassen ser vi en getter-metod som uppdaterar cachen om den var null och sedan returnerar cachadata :

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

Det är intressant att påpeka att Lombok slog in datafältet i en AtomicReference. Detta säkerställer atomuppdateringar i transaktionsfältet . De getTransactions () metoden ser också till att läsa filen om transaktioner är null.

Användningen av fältet AtomicReference-transaktioner direkt från klassen avskräcks. Det rekommenderas att använda metoden getTransactions () för att komma åt fältet.

Av denna anledning, om vi använder en annan Lombok-kommentar som ToString i samma klass , kommer den att använda getTransactions () istället för direkt åtkomst till fältet.

4. Värdeklasser / DTO: er

Det finns många situationer där vi vill definiera en datatyp med det enda syftet att representera komplexa "värden" eller som "Dataöverföringsobjekt", oftast i form av oföränderliga datastrukturer som vi bygger en gång och aldrig vill ändra .

Vi utformar en klass för att representera en framgångsrik inloggningsoperation. Vi vill att alla fält ska vara icke-null och att objekt ska vara oföränderliga så att vi säkert kan få åtkomst till dess egenskaper:

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 }

Återigen skulle mängden kod som vi skulle behöva skriva för de kommenterade avsnitten ha en mycket större volym som den information vi vill inkapsla och som har verkligt värde för oss. Vi kan använda Lombok igen för att förbättra detta:

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

Lägg bara till @RequiredArgsConstructor- anteckningen så får du en konstruktör för alla de sista fälten i klassen, precis som du förklarade dem. Att lägga till @NonNull till attribut gör att vår konstruktör kontrollerar om den är ogiltig och kastar NullPointerExceptions därefter . Detta skulle också hända om fälten inte var slutgiltiga och vi lade till @Setter för dem.

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 flesta funktioner som vi har visat har också ett antal anpassningsalternativ som du kan hitta praktiskt för att få verktyget att generera saker som är mest kompatibla med ditt team för att namnge etc. Det tillgängliga inbyggda konfigurationssystemet kan också hjälpa dig med det.

Jag hoppas att du har hittat motivationen att ge Lombok en chans att komma in i ditt Java-utvecklingsverktyg. Prova och öka din produktivitet!

Exempelkoden finns i GitHub-projektet.