Wprowadzenie do projektu Lombok

1. Unikaj powtarzającego się kodu

Java to świetny język, ale czasami robi się zbyt rozwlekły w przypadku rzeczy, które musisz zrobić w swoim kodzie dla typowych zadań lub zgodności z niektórymi praktykami ramowymi. Bardzo często nie wnoszą one żadnej realnej wartości do biznesowej strony programów - i właśnie tutaj Lombok jest tutaj, aby uczynić Twoje życie szczęśliwszym, a Ciebie bardziej produktywnym.

Sposób, w jaki to działa, polega na podłączeniu do procesu kompilacji i automatycznym generowaniu kodu bajtowego Java do plików .class zgodnie z liczbą adnotacji projektu, które wprowadzasz w kodzie.

Włączenie go do kompilacji, niezależnie od używanego systemu, jest bardzo proste. Ich strona projektu zawiera szczegółowe instrukcje dotyczące szczegółów. Większość moich projektów opiera się na mavenach, więc zazwyczaj porzucam ich zależność w podanym zakresie i jestem gotowy:

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

Sprawdź tutaj najnowszą dostępną wersję.

Zwróć uwagę, że zależność od Lombok nie spowoduje, że użytkownicy Twojego pliku .jar również będą od niego zależni, ponieważ jest to czysta zależność od kompilacji, a nie środowisko wykonawcze.

2. Getters / Setters, Constructors - so repetitive

Hermetyzowanie właściwości obiektów za pomocą publicznych metod pobierających i ustawiających jest tak powszechną praktyką w świecie Java, a wiele frameworków w dużym stopniu opiera się na tym wzorcu „Java Bean”: klasa z pustym konstruktorem i metodami get / set dla „właściwości”.

Jest to tak powszechne, że większość IDE obsługuje automatyczne generowanie kodu dla tych wzorców (i nie tylko). Ten kod musi jednak znajdować się w źródłach, a także być utrzymywany, gdy, powiedzmy, zostanie dodana nowa właściwość lub zmieniona zostanie nazwa pola.

Rozważmy tę klasę, której chcemy użyć jako encji JPA jako przykład:

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

Jest to dość prosta klasa, ale nadal rozważmy, że gdybyśmy dodali dodatkowy kod dla metod pobierających i ustawiających, otrzymalibyśmy definicję, w której mielibyśmy więcej standardowego kodu o zerowej wartości niż odpowiednich informacji biznesowych: „Użytkownik najpierw i nazwiska i wiek ”.

Pozwól nam teraz Lombok-ize tej klasy:

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

Dodając adnotacje @Getter i @Setter , powiedzieliśmy Lombokowi , żeby wygenerował je dla wszystkich pól tej klasy. @NoArgsConstructor doprowadzi do pustego generowania konstruktora.

Zauważ, że jest to cały kod klasy, nie pomijam niczego w przeciwieństwie do wersji powyżej z komentarzem // getters i setters . W przypadku trzech odpowiednich klas atrybutów jest to znaczna oszczędność kodu!

Jeśli dodatkowo dodasz atrybuty (właściwości) do swojej klasy użytkownika , stanie się to samo: zastosowałeś adnotacje do samego typu, aby domyślnie uwzględniać wszystkie pola.

A jeśli chcesz poprawić widoczność niektórych nieruchomości? Na przykład, chciałbym, aby moje podmioty id modyfikatorów pole pakiet lub chronione widoczne, ponieważ oczekuje się ich czytać, ale nie są wyraźnie określone przez kod aplikacji. Po prostu użyj drobniejszego @Setter dla tego konkretnego pola:

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

3. Lazy Getter

Często aplikacje wymagają wykonania kosztownych operacji i zapisywania wyników do późniejszego wykorzystania.

Na przykład, powiedzmy, że musimy odczytać dane statyczne z pliku lub bazy danych. Na ogół dobrą praktyką jest jednorazowe pobranie tych danych, a następnie zapisanie ich w pamięci podręcznej, aby umożliwić odczytywanie w pamięci aplikacji. Dzięki temu aplikacja nie musi powtarzać kosztownej operacji.

Innym częstym wzorcem jest pobieranie tych danych tylko wtedy, gdy są potrzebne . Innymi słowy, pobierz dane tylko wtedy, gdy odpowiedni getter zostanie wywołany po raz pierwszy. Nazywa się to leniwym ładowaniem .

Załóżmy, że te dane są przechowywane w pamięci podręcznej jako pole wewnątrz klasy. Klasa musi teraz upewnić się, że każdy dostęp do tego pola zwraca dane z pamięci podręcznej. Jednym z możliwych sposobów zaimplementowania takiej klasy jest spowodowanie, aby metoda pobierająca pobierała dane tylko wtedy, gdy pole ma wartość null . Z tego powodu nazywamy to leniwym dzieckiem .

Lombok umożliwia to za pomocą parametru lazy w adnotacji @ Getter, którą widzieliśmy powyżej.

Na przykład rozważmy tę prostą klasę:

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

To odczytuje niektóre transakcje z pliku do mapy . Ponieważ dane w pliku się nie zmieniają, zapiszemy je raz w pamięci podręcznej i umożliwimy dostęp przez getter.

Jeśli teraz spojrzymy na skompilowany kod tej klasy, zobaczymy metodę pobierającą, która aktualizuje pamięć podręczną, jeśli ma wartość null, a następnie zwraca dane z pamięci podręcznej :

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

Warto zauważyć, że Lombok opakował pole danych w AtomicReference. Zapewnia to niepodzielne aktualizacje pola transakcji . Metoda getTransactions () zapewnia również odczyt pliku, jeśli transakcje mają wartość null.

Nie zaleca się używania pola transakcji AtomicReference bezpośrednio z poziomu klasy. W celu uzyskania dostępu do pola zaleca się użycie metody getTransactions () .

Z tego powodu, jeśli użyjemy innej adnotacji Lombok, takiej jak ToString w tej samej klasie , użyje ona metody getTransactions () zamiast bezpośredniego dostępu do pola.

4. Klasy wartości / DTO

Istnieje wiele sytuacji, w których chcemy zdefiniować typ danych wyłącznie w celu przedstawienia złożonych „wartości” lub jako „Obiekty transferu danych”, najczęściej w postaci niezmiennych struktur danych, które budujemy raz i nigdy nie chcemy ich zmieniać .

Projektujemy klasę, która reprezentuje pomyślną operację logowania. Chcemy, aby wszystkie pola były niezerowe, a obiekty były niezmienne, abyśmy mogli bezpiecznie korzystać z wątków w ich właściwościach:

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 }

Ponownie, ilość kodu, który musielibyśmy napisać dla skomentowanych sekcji, byłaby znacznie większa niż informacja, którą chcemy hermetyzować i która ma dla nas prawdziwą wartość. Możemy ponownie użyć Lombok, aby to poprawić:

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

Po prostu dodaj adnotację @RequiredArgsConstructor, a otrzymasz konstruktor dla wszystkich końcowych pól w klasie, tak jak je zadeklarowałeś. Dodanie @NonNull do atrybutów sprawia, że ​​nasz konstruktor sprawdza, czy nie ma wartości null i odpowiednio rzuca NullPointerExceptions . Stałoby się tak również, gdyby pola nie były ostateczne i dodaliśmy dla nich @Setter .

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.

Ponadto większość funkcji, które pokazaliśmy, ma wiele opcji dostosowywania, które mogą być przydatne, aby narzędzie generowało rzeczy najbardziej zgodne z praktykami zespołu w zakresie nazewnictwa itp. Dostępny wbudowany system konfiguracji również może Ci w tym pomóc.

Mam nadzieję, że znalazłeś motywację, aby dać Lombok szansę na skorzystanie z zestawu narzędzi programistycznych Java. Spróbuj i zwiększ swoją produktywność!

Przykładowy kod można znaleźć w projekcie GitHub.