Lombok

Основные разделы

• Основные аннотации
• @Singular
• Подключение к Spring

Основные аннотации

• @NonNull - проверка переменных на отсутствие null.
• @Getter/@Setter - создание getters и setters.
• @ToString - создание toString().
• @EqualsAndHashCode - создает equals() и hashCode().
• @NoArgsConstructor - создание пустого конструктора.
• @RequiredArgsConstructor - создание конструктора только с final полями.
• @AllArgsConstructor - создание конструктора со всеми полями.
• @Data - содержит: @ToString, @EqualsAndHashCode, @Getter, @Setter, @RequiredArgsConstructor.
• @Value - аналог @Data, но для immutable классов. Не содержит @Setter.
• @Builder - реализация паттерна Builder. Также можно указывать на переменные с коллекциями аннотацию. @Builder(toBuilder = true) - добавляем возможность создания Builder с любого экземпляра.
• @SneakyThrows - позволяет обрабатывать проверенные исключения, не объявляя их в сигнатуре метода.
• @Synchronized - замена слова synchronized.
• @Log - добавление инициализации логирования, так же позволяет выбрать вид логгера: @CommonsLog, @JBossLog, @Log, @Log4j, @Log4j2, @Slf4j, @XSlf4j.
• @Cleanup - замена try with resources.
• @Singular - поможет по отдельности добавлять в коллекции.
• @With - для создания неизменяемых (immutable) копий объектов с изменённым значением одного из полей. Она автоматически генерирует метод withFieldName(value), который создаёт копию объекта с новым значением указанного поля, оставляя остальные поля без изменений. Полезно для работы с immutable объектами.
  • Работает только с final полями (чтобы обеспечить неизменяемость объекта).
  • Создаёт новый объект при каждом вызове withFieldName(newValue), не изменяя оригинальный.
  • Если применить @With к классу, методы with... будут сгенерированы для всех final полей.
  • Можно применять к отдельным полям, если не требуется генерация методов для всех.
• @Jacksonized - добавляет поддержку Jackson'а к сгенерированным Lombok'ом объектам, особенно полезна для иммутабельных классов (например, с использованием @Builder и @Value).

@Singular

Аннотация дополняющая Builder, применяется на поля типа Map, Set, List и позволяет в builder добавлять объекты по одному, а не списком.

Без @Singular

@Builder
public class Person {
    String name;
    List<String> cars;
}

Person person = Person.builder()
        .name("A")
        .cars(Arrays.asList("fictional", "incidental"))
        .build();
        

С @Singular

@Builder
public class Person {
    String name;
    @Singular
    List<String> cars;
}

Person person = Person.builder()
        .name("A")
        .car("carA")
        .car("carB")
        .build();
        

@SneakyThrows

Аннотация оборачивает выбрасываемые исключения в RuntimeException, что позволяет избежать необходимости объявления исключений в сигнатуре метода(throws) или использования блоков try-catch.

import lombok.SneakyThrows;

@SneakyThrows
public void someMethod() {
    // код, который может бросить IOException
}
        

@Jacksonized

Автоматически добавляет поддержку Jackson'а к сгенерированным Lombok'ом объектам, особенно полезна для иммутабельных классов (например, с использованием @Builder и @Value).

import lombok.Value;
import lombok.Builder;
import lombok.extern.jackson.Jacksonized;

@Value
@Builder
@Jacksonized
public class Person {
    String name;
    int age;
}
        

Без @Jacksonized Jackson не сможет корректно десериализовать JSON в этот класс, потому что у него нет конструктора по умолчанию, а поля final. @Jacksonized добавляет нужные аннотации и конфигурацию, чтобы Jackson понимал, как использовать builder для десериализации.

Что делает аннотация:

• Добавляет Jackson-аннотацию @JsonDeserialize(builder = ...), указывая на сгенерированный билдера.
• Делает класс совместимым с Jackson без ручной настройки.

Когда использовать:

• Когда вы используете @Builder + @Value (или @Builder + @Data) и хотите сериализовать/десериализовать объект в/из JSON.
• Когда вам нужен чистый, иммутабельный объект с поддержкой JSON без лишнего кода.

Подключение к Spring Boot + Gradle

Узнать последнюю версию в:

https://mvnrepository.com/artifact/org.projectlombok/lombok

build.gradle

def lombokVersion = '1.18.36'

//dependency
//Lombok
compileOnly "org.projectlombok:lombok:${lombokVersion}"
annotationProcessor "org.projectlombok:lombok:${lombokVersion}"
        

Установить Idea Plugin

Lombok