Всем привет ,

Прежде всего, позвольте мне поздравить вас с Новым 2023 годом. Желаю вам достичь всех ваших личных и профессиональных целей.

Сегодня мы подробно рассмотрим проект Lombok и его аннотации. Мы также увидим, как он может быть полезен разработчикам в эффективной разработке Java-приложений.

Что такое Ломбок:

Project Lombok — это библиотека Java, которую можно использовать для сокращения шаблонного кода в приложениях Java. Он предоставляет аннотации, которые можно использовать для автоматического создания геттеров, сеттеров, конструкторов и других распространенных методов для классов Java.

Это может значительно упростить процесс разработки и сделать код более читабельным. Lombok прост в использовании, легковесен и может быть интегрирован в большинство Java IDE. Он также имеет ряд дополнительных функций, таких как ведение журнала, безопасность потоков и обработка исключений.

История:

Проект Lombok был впервые выпущен в сентябре 2008 года голландским разработчиком программного обеспечения Рейньером Звитсерлоотом. Он был доступен под лицензией Apache 2.0 с открытым исходным кодом. С тех пор он регулярно пополняется новыми функциями и улучшениями и остается популярным инструментом среди разработчиков Java для сокращения шаблонного кода и улучшения его читаемости.

Подарок:

Текущая версия Project Lombok — версия 1.18.24. Эта версия была выпущена 18 апреля 2022 г. и включает в себя несколько исправлений ошибок и улучшений.

Project Lombok — один из наиболее широко используемых проектов в экосистеме Java, от него зависит более 31 000 репозиториев с открытым исходным кодом. Проект Lombok входит в число 40 лучших проектов Maven, что свидетельствует о широком распространении проекта.

Известные аннотации:

Одной из самых популярных функций Lombok является аннотация @Data. Эту аннотацию можно применить к классу, и она будет автоматически генерировать геттеры и сеттеры для всех полей, а также методы equals, hashCode и toString. Это может сэкономить много времени и усилий для разработчиков, так как эти методы часто необходимы в большинстве классов Java, но их написание может занять много времени.

Еще одна полезная функция — аннотация @Builder, которую можно использовать для создания шаблона построителя для класса. Это упрощает создание объектов со многими полями в более удобной для чтения форме путем объединения вызовов методов в цепочку.

Lombok также предоставляет ряд других аннотаций, таких как @NonNull, @Cleanup и @Synchronized, которые можно использовать для повышения удобочитаемости кода и повышения производительности.

Project Lombok предоставляет несколько аннотаций, которые можно использовать для сокращения шаблонного кода и повышения удобочитаемости кода Java. Некоторые из наиболее часто используемых аннотаций Ломбока включают:

  • @Getter и @Setter: эти аннотации можно применять к классу или полю для автоматического создания методов получения и установки для этого класса или поля.
  • @ToString: эта аннотация генерирует метод toString() для класса, который возвращает строковое представление полей объекта.
  • @EqualsAndHashCode: эта аннотация генерирует методы equals() и hashCode() для класса на основе полей класса.
  • @NoArgsConstructor, @RequiredArgsConstructor и @AllArgsConstructor: эти аннотации создают конструкторы для класса. Аннотация @NoArgsConstructor создает конструктор без аргументов, @RequiredArgsConstructor создает конструктор с аргументами для окончательных и ненулевых полей, а @AllArgsConstructor создает конструктор с аргументами для всех полей.
  • @Data: эта аннотация является ярлыком для одновременного применения @ToString, @EqualsAndHashCode, @Getter и @Setter и @RequiredArgsConstructor.
  • @Builder: эта аннотация создает шаблон построителя для класса, который упрощает создание объектов со многими полями более удобочитаемым способом путем объединения вызовов методов в цепочку.
  • @Cleanup: эта аннотация автоматически вызывает метод close() для ресурса, например файла или соединения JDBC, когда он выходит за рамки.
  • @Synchronized: эта аннотация используется для обеспечения потокобезопасности метода или блока кода путем добавления механизма синхронизации.
  • @NonNull: эту аннотацию можно применить к возвращаемому значению параметра, поля или метода, чтобы указать, что значение никогда не должно быть нулевым.
  • @Log: эта аннотация создает регистратор для класса, который можно использовать для вывода сообщений журнала.
  • @Value: эта аннотация создает неизменяемую версию класса, в которой сеттеры заменены конструкторами, а все поля являются окончательными.
  • @Delegate: эту аннотацию можно использовать для делегирования реализации метода или поля другому объекту.

Это одни из наиболее часто используемых аннотаций Lombok, но есть и другие доступные аннотации, которые можно использовать для дальнейшего сокращения стандартного кода и улучшения читабельности кода Java.

Использование Ломбока с Maven:

Чтобы настроить lombok с помощью любого инструмента сборки, вы должны указать, что зависимость lombok требуется для компиляции вашего исходного кода, но не обязательно должна присутствовать при запуске/тестировании/сотрясении/ином развертывании вашего кода. Обычно это называется «предоставленной» зависимостью.

Lombok доступен в maven Central, поэтому легко сказать Maven загрузить lombok.

Добавление ломбока в ваш файл pom

Чтобы включить ломбок в качестве «предоставленной» зависимости, добавьте его в свой блок <dependencies> следующим образом:

<dependencies>
	<dependency>
		<groupId>org.projectlombok</groupId>
		<artifactId>lombok</artifactId>
		<version>1.18.24</version>
		<scope>provided</scope>
	</dependency>
</dependencies>

На этой странице объясняется, как интегрировать ломбок с инструментом сборки Apache Maven.



Maven
Чтобы настроить lombok с помощью любого инструмента сборки, вы должны указать, что для компиляции вашего исходного кода требуется зависимость lombok…projectlombok.org



Примеры кода Java:

Давайте рассмотрим несколько примеров того, как вы можете использовать некоторые из наиболее часто используемых аннотаций Lombok в своем коде Java:

Использование аннотации @Data:

import lombok.Data;

@Data
public class User{
    private String name;
    private int age;
}

Аннотация @Data генерирует геттеры и сеттеры для всех полей, а также методы equals, hashCode и toString для класса.

Использование аннотации @Builder:

import lombok.Builder;
import lombok.Data;

@Data
@Builder
public class User{
    private String name;
    private int age;
}
User user= User.builder().name("John").age(25).build();

Аннотация @Builder создает шаблон построителя для класса, который упрощает создание объектов с множеством полей в более удобной для чтения форме.

Использование аннотации @Synchronized:

import lombok.Synchronized;

public class Counter {
    private int count = 0;
    @Synchronized
    public void increment() {
        count++;
    }
}

Аннотация @Synchronized используется, чтобы сделать метод потокобезопасным за счет добавления механизма синхронизации.

Использование аннотации @NonNull:

import lombok.NonNull;
import lombok.RequiredArgsConstructor;

@RequiredArgsConstructor
public class Person {
    private final String name;
    private final int age;

public void setName(@NonNull String name) {
        this.name = name;
    }
}

Аннотацию @NonNull можно использовать, чтобы указать, что параметр или поле никогда не должны быть нулевыми.

Использование аннотации @Log:

import lombok.extern.java.Log;
@Log
public class Person {
    public void doSomething() {
        log.info("doing something");
    }
}

Аннотация @Log создает регистратор для класса, который можно использовать для вывода сообщений журнала.

Вот некоторые дополнительные аннотации Lombok, которые могут быть полезны в определенных ситуациях:

  • @Wither: эту аннотацию можно использовать для создания метода with для класса или поля, который создает новый экземпляр класса с заданным полем, установленным на новое значение.
  • @Accessors: эту аннотацию можно использовать для управления именами сгенерированных методов получения и установки для класса или поля.
  • @SneakyThrows: эту аннотацию можно использовать для более лаконичной обработки проверенных исключений, автоматически добавляя необходимый блок try-catch.
  • @Var: эту аннотацию можно использовать для замены традиционных объявлений типов ключевым словом var, которое является более кратким и может быть определено компилятором.
  • @FieldNameConstants: эту аннотацию можно использовать для создания постоянных полей для всех нестатических, непереходных полей класса, которые можно использовать, чтобы сделать ваш код более читабельным и удобным в сопровождении.
  • @UtilityClass: эту аннотацию можно использовать для создания частного конструктора для класса, который гарантирует, что он не может быть создан и используется только как служебный класс.
  • @Singular: эту аннотацию можно использовать для создания методов добавления элементов в коллекцию или поля карты.
  • @Log4j, @Log4j2, @Slf4j и @CommonsLog: эти аннотации можно использовать для создания средств ведения журнала для различных сред ведения журнала.

Конечно, вот еще несколько примеров того, как вы можете использовать некоторые аннотации Lombok в своем коде Java:

Использование аннотации @Cleanup:

import java.io.FileInputStream;
import java.io.IOException;
import lombok.Cleanup;

public class Example {
    public static void main(String[] args) throws IOException {
        @Cleanup FileInputStream in = new FileInputStream("example.txt");
        // do something with 'in'
    }
}

Аннотация @Cleanup автоматически вызывает метод close() для ресурса, например файла или соединения JDBC, когда он выходит за рамки.

Использование аннотации @SneakyThrows:

import lombok.SneakyThrows;

public class Example {
    @SneakyThrows(IOException.class)
    public static void main(String[] args) {
        throw new IOException();
    }
}

Аннотацию @SneakyThrows можно использовать для более лаконичной обработки проверенных исключений, автоматически добавляя необходимый блок try-catch.

Использование аннотации @Wither:

import lombok.Data;
import lombok.experimental.Wither;
@Data
public class Person {
    private final String name;
    @Wither private int age;
}
Person p = new Person("John").withAge(25);

Аннотация @Wither создает метод with для класса или поля, который создает новый экземпляр класса с заданным полем, установленным на новое значение.

Использование аннотации @Accessors:

import lombok.AccessLevel;
import lombok.Getter;
import lombok.Setter;
import lombok.experimental.Accessors;

@Accessors(fluent = true, chain = true)
public class Person {
    @Getter @Setter private String name;
    @Getter(AccessLevel.PRIVATE) 
   @Setter private int age;
}
Person p = new Person().setName("John").setAge(25);

Аннотацию @Accessors можно использовать для управления именами сгенерированных методов получения и установки для класса или поля. В этом примере он включает параметры fluent и chain, что означает, что установщики вернут это, что позволит объединить вызовы в цепочку.

Использование аннотации @UtilityClass:

import lombok.experimental.UtilityClass;

@UtilityClass
public class MathUtils {
    public static int add(int a, int b) {
        return a + b;
    }
}

Аннотацию @UtilityClass можно использовать для создания закрытого конструктора для класса, который гарантирует, что он не может быть создан и используется только как служебный класс.

Стоит отметить, что это всего лишь несколько примеров того, как вы можете использовать аннотации Lombok в своем коде Java, но есть еще много других доступных способов, которые можно использовать для дальнейшего сокращения стандартного кода и улучшения читабельности вашего кода.

Важно понимать используемые вами аннотации и их влияние на код, а также хорошо знать Java и среду разработки, чтобы в полной мере использовать преимущества Lombok.



журнал изменений
ФУНКЦИЯ: превратить поле с именем uShape в геттер сложно: getUShape или getuShape? Сообщество разделено на…projectlombok.org



Стоит отметить, что Lombok активно поддерживается и развивается, поэтому новая версия может быть выпущена после прекращения моих знаний, вы можете проверить последнюю версию Lombok на официальном сайте.



Project Lombok
Project Lombok — это библиотека Java, которая автоматически подключается к вашему редактору и инструментам сборки, оживляя ваш Java. Никогда…projectlombok.org



Project Lombok поддерживает Java 8 и выше. Это означает, что он должен работать с любой версией Java, основанной на Java 8 или более поздней версии, включая Java 8, 9, 10, 11, 12, 13, 14, 15, , 16 и другие. Стоит отметить, что Lombok активно поддерживается и развивается, поэтому он может поддерживать более свежую версию Java в будущих выпусках, и всегда лучше проверять официальный сайт.



Project Lombok
Project Lombok — это библиотека Java, которая автоматически подключается к вашему редактору и инструментам сборки, оживляя ваш Java. Никогда…projectlombok.org



Для получения последней информации и требований. Также важно проверить совместимость Lombok с конкретной версией Java, которую вы используете, и IDE, которую вы используете, прежде чем интегрировать его в свой проект.

Использование Lombok с вашей любимой IDE:

Вы можете настроить Lombok с вашей любимой IDE. Подробности указаны в ссылках ниже:



Eclipse, Spring Tool Suite, (Red Hat) JBoss Developer Studio, MyEclipse
Редактор Eclipse совместим с ломбоком. Ответвления Eclipse также совместимы с lombok, в частности…projectlombok.org





IntelliJ IDEA
Редактор Jetbrains IntelliJ IDEA совместим с lombok без подключаемого модуля начиная с версии 2020.3.projectlombok.org





Microsoft Visual Studio Code
Редактор Microsoft Visual Studio Code совместим с lombok. Пакет расширений для Java содержит встроенные…projectlombok.org



Стоит отметить, что Lombok — мощный инструмент, но у него есть потенциальные недостатки. Это может усложнить вашу кодовую базу, а поскольку он не является частью стандартной библиотеки Java, он требует дополнительной установки и настройки. Кроме того, важно понимать используемые вами аннотации и их влияние на код.

Есть несколько плюсов и минусов использования Project Lombok в разработке Java:

Плюсы:

  • Сокращает шаблонный код: Lombok предоставляет аннотации, которые можно использовать для автоматического создания общих методов, таких как геттеры, сеттеры, конструкторы и toString, которые могут сэкономить много времени и усилий для разработчиков.
  • Улучшает читаемость кода: уменьшая объем стандартного кода, Lombok делает код более читабельным и понятным.
  • Повышает производительность: аннотацию Lombok @Synchronized можно использовать, чтобы сделать метод или блок кода потокобезопасным, а @Cleanup можно использовать для автоматического закрытия ресурсов, что может повысить производительность вашего кода.
  • Упрощает обработку исключений: аннотацию Lombok @SneakyThrows можно использовать для более лаконичной обработки проверенных исключений, автоматически добавляя необходимый блок try-catch.

Минусы:

  • Требует дополнительной настройки и настройки: поскольку Lombok не входит в стандартную библиотеку Java, он требует дополнительной настройки и настройки.
  • Может усложнить вашу кодовую базу: Lombok предоставляет множество аннотаций, и важно понимать, какие аннотации вы используете и как они влияют на код.
  • Поддерживается не всеми IDE: хотя большинство популярных IDE Java поддерживают Lombok, но не все из них поддерживают его, что может затруднить его использование в некоторых средах.
  • Не всегда рекомендуется: в некоторых случаях шаблонный код, который он призван устранить, добавляется по какой-то причине, например, для того, чтобы сделать код более читабельным или удобным для сопровождения, или для обработки крайних случаев.

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

В целом, Lombok может помочь в разработке более эффективного кода Java за счет сокращения повторяющегося и подверженного ошибкам кода. Это позволяет разработчикам сосредоточиться на бизнес-логике приложения, а не на стандартном коде. Это также делает код более читабельным и удобным для сопровождения.

Мы надеемся, что вам понравился этот пост, чтобы узнать больше о Project Lombok и его аннотациях в деталях.



Project Lombok for Enterprise
Project Lombok и разработчики тысяч других пакетов работают с Tidelift над созданием одного предприятия…projectlombok.org



Счастливого обучения… Счастливого кодирования…..

Другие интересные статьи:

АРМ Лямбда в действии

AWS SOAR: Повышение безопасности с помощью автоматизации

Java: Понимание золотой пайки Phi

Обучение AWS: путь к безграничным возможностям в облаке.

Бесплатные способы изучения облака AWS во время праздников

Понимание 𝗻𝗴

Команды Linux для облачного обучения

Принципы программирования на Java: Закон Деметры