Вступ до проекту Ломбок

1. Уникайте повторюваного кодексу

Java є чудовою мовою, але іноді вона стає занадто багатослівною для речей, які ви повинні робити у своєму коді для загальних завдань або відповідності деяким практикам фреймворку. Вони дуже часто не приносять реального значення діловій стороні ваших програм - і саме тут Ломбок тут, щоб зробити ваше життя щасливішим, а вас більш продуктивними.

Це працює шляхом підключення до процесу збірки та автоматичного генерування байт-коду Java у файли .class відповідно до ряду анотацій проекту, які ви вводите у свій код.

Включити його у свої збірки, яку б систему ви не використовували, дуже прямо. На їхній сторінці проекту є детальні інструкції щодо особливостей. Більшість моїх проектів засновані на maven, тому я просто знижую їх залежність у передбаченому обсязі, і я готовий:

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

Перевірте найновішу доступну версію тут.

Зауважте, що залежно від Lombok не змусить користувачів вашого .jar також залежати від нього, оскільки це суто залежність від збірки, а не час роботи.

2. Геттери / сетери, конструктори - так повторюються

Інкапсуляція властивостей об’єктів за допомогою методів загального отримання та встановлення є настільки поширеною практикою у світі Java, і багато фреймворків широко покладаються на цей шаблон “Java Bean”: клас із порожнім конструктором та методами get / set для “властивостей”.

Це настільки загальноприйняте, що більшість IDE підтримує автогенерацію коду для цих шаблонів (і більше). Однак цей код повинен існувати у ваших джерелах, а також підтримувати його, коли, скажімо, додається нова властивість або перейменовується поле.

Давайте розглянемо цей клас, який ми хочемо використовувати як сутність JPA, як приклад:

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

Це досить простий клас, але все ж врахуйте, якщо б ми додали додатковий код для геттерів і сеттерів, ми б отримали визначення, де ми мали б більше типового коду нульового значення, ніж відповідна інформація про бізнес: прізвища та вік ".

Давайте тепер Ломбок-ізе цей клас:

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

Додавши анотації @Getter та @Setter, ми сказали Lombok створити їх для всіх полів класу. @NoArgsConstructor призведе до порожнього генератора конструктора.

Зверніть увагу, що це весь код класу, я нічого не пропускаю, на відміну від наведеної вище версії з коментарем // getters та setters . Для трьох відповідних класів атрибутів це суттєва економія коду!

Якщо ви далі додасте атрибути (властивості) до вашого класу User , те саме станеться: ви застосували анотації до самого типу, щоб вони за замовчуванням враховували всі поля.

Що робити, якщо ви хочете покращити видимість деяких властивостей? Наприклад, мені подобається залишати видимим пакет модифікаторів полів ідентифікаторів моїх сутностей або захищений, оскільки вони, як очікується, будуть прочитані, але не явно встановлені кодом програми. Просто використовуйте більш тонкий зернистий @Setter для цього конкретного поля:

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

3. Ледачий Геттер

Часто програмам потрібно виконати якусь дорогу операцію та зберегти результати для подальшого використання.

Наприклад, скажімо, нам потрібно читати статичні дані з файлу або бази даних. Як правило, корисно отримувати ці дані один раз, а потім кешувати їх, щоб дозволити читання в пам’яті в програмі. Це позбавляє програму від повторення дорогої операції.

Ще однією поширеною схемою є отримання цих даних лише тоді, коли це спочатку потрібно . Іншими словами, отримуйте дані лише тоді, коли відповідний геттер викликається вперше. Це називається ледачим завантаженням .

Припустимо, що ці дані кешуються як поле всередині класу. Тепер клас повинен переконатися, що будь-який доступ до цього поля повертає кешовані дані. Одним із можливих способів реалізації такого класу є змусити метод getter отримувати дані, лише якщо поле є нульовим . З цієї причини ми називаємо це ледачим здобувачем .

Ломбок робить це можливим з ледачим параметром в @ Getter анотації ми бачили вище.

Наприклад, розглянемо цей простий клас:

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

Це зчитує деякі транзакції з файлу на карту . Оскільки дані у файлі не змінюються, ми кешуємо їх один раз і надамо доступ через геттер.

Якщо ми зараз подивимося на скомпільований код цього класу, ми побачимо метод getter, який оновлює кеш, якщо він був нульовим, а потім повертає кешовані дані :

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

Цікаво зазначити, що Ломбок обернув поле даних у AtomicReference. Це забезпечує атомне оновлення поля транзакцій . Метод getTransactions () також гарантує зчитування файлу, якщо транзакції є нульовими.

Не рекомендується використовувати поле транзакцій AtomicReference безпосередньо з класу. Для доступу до поля рекомендується використовувати метод getTransactions () .

З цієї причини, якщо ми використовуємо іншу анотацію Ломбока, як ToString, у тому ж класі , вона використовуватиме getTransaction () замість безпосереднього доступу до поля.

4. Ціннісні класи / DTO

Є багато ситуацій, коли ми хочемо визначити тип даних з єдиною метою представляти складні „значення” або як „Об’єкти передачі даних”, більшу частину часу у вигляді незмінних структур даних, які ми будуємо один раз і ніколи не хочемо змінювати .

Ми розробляємо клас, який представляє успішну операцію входу. Ми хочемо, щоб усі поля були ненульовими, а об’єкти - незмінними, щоб ми могли безпечно отримувати доступ до його властивостей:

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 }

Знову ж таки, кількість коду, який ми повинні були б написати для коментованих розділів, мала б набагато більший обсяг, ніж інформація, яку ми хочемо інкапсулювати, і яка має для нас реальне значення. Ми можемо використовувати Lombok знову, щоб покращити це:

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

Просто додайте анотацію @RequiredArgsConstructor, і ви отримаєте конструктор для всіх остаточних полів у класі, як ви їх оголосили. Додавання @NonNull до атрибутів змушує наш конструктор перевіряти наявність похибок і відповідно викидати NullPointerExceptions . Це також траплялося б, якби поля були не остаточними, і ми додали для них @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.

Крім того, більшість функцій, які ми показали, мають ряд варіантів налаштування, які вам можуть стати в нагоді, щоб інструмент генерував речі, найбільш відповідні практиці вашої команди щодо іменування тощо. Наявна вбудована система конфігурації також може вам у цьому допомогти.

Сподіваюся, ви знайшли мотивацію дати Lombok можливість потрапити у ваш набір інструментів для розробки Java. Спробуйте і підвищте свою продуктивність!

Приклад коду можна знайти в проекті GitHub.