Въведение в проект Ломбок

Програмиране

1. Избягвайте повтарящия се код

Java е чудесен език, но понякога става твърде многословен за неща, които трябва да правите в кода си за общи задачи или за съответствие с някои рамкови практики. Те много често не носят реална стойност за бизнес страна на вашите програми - и тук е Lombok тук, за да направи живота ви по-щастлив и себе си по-продуктивни.

Начинът, по който работи, е чрез включване в процеса на изграждане и автоматично генериране на байт код на 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 }

Това е доста прост клас, но все пак помислете, ако добавим допълнителния код за гетери и сетъри, ще се окажем с дефиниция, при която ще имаме повече кодов код с нулева стойност от съответната бизнес информация: „Потребителят има първо и фамилни имена и възраст. "

Нека сега Lombok-ize този клас:

@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 коментар. За три съответни класа атрибути това е значително спестяване на код!

Ако допълнително добавите атрибути (свойства) към вашия потребителски клас, ще се случи същото: приложихте поясненията към самия тип, така че те да имат предвид всички полета по подразбиране.

Ами ако искате да подобрите видимостта на някои имоти? Например, аз обичам да държа моите образувания " идентификатор полеви модификатори пакет или защитени видими, тъй като те се очаква да се чете, но не е изрично определен от кода на приложението. Просто използвайте по-фин зърнен @Setter за това конкретно поле:

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

3. Мързелив гетър

Често приложенията трябва да извършат някаква скъпа операция и да запазят резултатите за последваща употреба.

Да приемем например, че трябва да четем статични данни от файл или база данни. Обикновено е добра практика да извличате тези данни веднъж и след това да ги кеширате, за да позволите четене в паметта в приложението. Това спестява приложението от повтаряне на скъпата операция.

Друг често срещан модел е извличането на тези данни само когато е необходимо за първи път . С други думи, получавайте данните само когато съответният гетер е извикан за първи път. Това се нарича мързеливо зареждане .

Да предположим, че тези данни се кешират като поле в клас. Класът трябва да се увери, че всеки достъп до това поле връща кешираните данни. Един от възможните начини за внедряване на такъв клас е да накарате метода getter да извлича данните само ако полето е null . Поради тази причина наричаме това мързелив добивач .

Lombok прави това възможно с мързеливия параметър в анотацията @ 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; } }

Това чете някои транзакции от файл в карта . Тъй като данните във файла не се променят, ще ги кешираме веднъж и ще разрешим достъп чрез гетер.

Ако сега разгледаме компилирания код на този клас, ще видим метод за получаване, който актуализира кеша, ако е нулев, и след това връща кешираните данни :

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

Интересно е да се отбележи, че Lombok уви полето с данни в AtomicReference. Това осигурява атомни актуализации на полето за транзакции . Методът getTransactions () също така гарантира, че чете файла, ако транзакциите са нула.

Препоръчва се използването на полето за транзакции AtomicReference директно от класа. Препоръчително е да използвате метода getTransactions () за достъп до полето.

Поради тази причина, ако използваме друга анотация на Lombok като 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.