IntelliJ IDEA
The Jetbrains IntelliJ IDEA editor is compatible with lombok without a plugin as of version 2020.3 to version 2023.1.
- Go to File > Settings > Plugins
- Click on Browse repositories.
- Search for Lombok Plugin
- Click on Install plugin
- Restart IntelliJ IDEA
You can also check out Setting up Lombok with Eclipse and IntelliJ, a blog article on baeldung.
credits | Copyright © 2009-2023 The Project Lombok Authors, licensed under the MIT license.
Как подключить Lombok к Android Studio в 2023 году
Для тех, кто еще не перешел на Kotlin, или работает с легаси, код которого в ближайшее время не будет переведен на него, использование Lombok сильно уменьшает количество шаблонного кода. Он скрывает геттеры, сеттеры, конструкторы и другие шаблонные методы за аннотациями.
Например, вместо кода:
public class UserDto < private String name; public HumanDto(String name) < this.name = name; >public void setName(String name) < this.name = name; >public String getName() < return this.name; >>Мы просто укажем нужные аннотации, остальное Lombok сгенерирует под капотом:
@Data @AllArgsConstructor public class UserDto
Проблема
Плагин Lombok в Marketplace JetBrains не совместим с последними версиями Android Studio.
Поэтому подключить его через File > Settings > Plugins не получится.
Если скачать его и попытаться подключить с диска, получим ошибку:
Что бы подключить плагин Lombok к Android Studio, в нем необходимо поправить совместимую версию.
Решение
В разделе Install > Platforms > Android находим ссылку Lombok IntelliJ plugin.
Нам могут показать предупреждение, что этот плагин не совместим с нашей студией.
Кому интересно как Marketplace узнает нашу версию
Marketplace в JS делает запросы http://localhost:63342/api/installPlugin по портам 63342, 63343, 63344, 63345 и наша студия выдает нас, отправляя ответ с заголовком «Server: IntelliJ IDEA 2023.1.2».
Нажимаем Get, и видим, что последние версии от 20 января 2021.
Распаковываем загруженный файл lombok-plugin-0.34.1-2019.1.zip . В каталоге lombok-plugin/lib будут еще два JAR архива. Нам нужен файл lombok-plugin-0.34.1-2019.1.jar , распаковываем его.
В текстовом редакторе открываем файл META-INF/plugin.xml .
В теге idea-version указана версия поддерживаемой студии:
Смотрим какая версия у нас сейчас, открываем Help > About .
Нас интересуют первые две цифры билда (в примере 222.4459), копируем их.
Вставляем в since-build и until-build , но для until-build меняем вторую цифру на звездочку. Должно получиться:
Запаковываем все обратно. И подключаем его в списке плагинов Settings > Plugins вручную: Install Plugin from Disk.
При смене мажорной версии студии, придется снова править эти параметры.
Пока с Lombok так. Переходите на Kotlin.
Настройка Lombok в Eclipse и IntelliJ IDEA
Lombok — это библиотека, облегчающая многие утомительные задачи и уменьшающая многословность исходного кода Java.
Конечно, обычно мы хотим иметь возможность использовать библиотеку в среде IDE, что требует дополнительной настройки.
В этом руководстве мы поговорим о настройке Lombok в двух самых популярных Java IDE — IntelliJ IDEA и Eclipse.
2. Ломбок в IntelliJ IDEA
Начиная с IntelliJ версии 2020.3 , нам больше не нужно настраивать IDE для использования Lombok. IDE поставляется в комплекте с плагином. Кроме того, обработка аннотаций будет включена автоматически.
В более ранних версиях IntelliJ нам необходимо выполнить следующие шаги, чтобы использовать Lombok. Кроме того, если мы используем последнюю версию, а IDE не распознает аннотацию Lombok, нам необходимо убедиться, что приведенная ниже конфигурация не была отключена вручную.
2.1. Включение обработки аннотаций
Lombok использует обработку аннотаций через APT . Таким образом, когда компилятор вызывает ее, библиотека создает новые исходные файлы на основе аннотаций в оригиналах.
Однако обработка аннотаций не включена по умолчанию.
Поэтому первое, что нужно сделать, это включить обработку аннотаций в нашем проекте.
Нам нужно перейти в Настройки | Сборка, выполнение, развертывание | Компилятор | Обработчики аннотаций и убедитесь в следующем:
- Флажок Включить обработку аннотаций установлен
- ` Выбран параметр «Получить процессоры из пути к классам проекта ».`
2.2. Установка подключаемого модуля IDE
В то время как Lombok генерирует код только во время компиляции, IDE выделяет ошибки в необработанном исходном коде:
Существует специальный плагин, который информирует IntelliJ о сгенерированном исходном коде. После его установки ошибки исчезают, и начинают работать обычные функции, такие как Find Usages и Navigate To .
Нам нужно перейти в Настройки | Плагины , откройте вкладку Marketplace , введите «lombok» и выберите « Плагин Lombok» от Михаила Плюшникова :
Затем нажмите кнопку « Установить » на странице плагина:
После установки нажмите кнопку « Перезапустить IDE » :
3. Ломбок в «Затмении»
Если мы используем Eclipse IDE, нам нужно сначала получить банку Lombok. Последняя версия находится на Maven Central .
В нашем примере мы используем lombok-1.18.4.jar .
Затем мы можем запустить банку с помощью команды java -jar , и откроется пользовательский интерфейс установщика. Это пытается автоматически обнаружить все доступные установки Eclipse, но также можно указать местоположение вручную.
После того, как мы выбрали установки, мы нажимаем кнопку « Установить/обновить » :
Если установка прошла успешно, мы можем выйти из установщика.
После установки плагина нам нужно перезапустить IDE и убедиться, что Lombok правильно настроен. Мы можем проверить это в диалоговом окне « О программе»:
4. Добавление Lombok в путь к классам компиляции
Последняя оставшаяся часть — убедиться, что двоичные файлы Lombok находятся в пути к классам компилятора. Используя Maven, мы можем добавить зависимость к pom.xml :
dependencies> dependency> groupId>org.projectlombokgroupId> artifactId>lombokartifactId> version>1.18.20version> scope>providedscope> dependency> dependencies> Самая последняя версия находится на Maven Central .
Теперь все должно быть хорошо. Исходный код должен отображаться без ошибок в IDE, правильно скомпилирован и выполнен:
public class UserIntegrationTest @Test public void givenAnnotatedUser_thenHasGettersAndSetters() User user = new User(); user.setFirstName("Test"); assertEquals(user.gerFirstName(), "Test"); > @Getter @Setter class User private String firstName; > > 5. Вывод
Lombok отлично справляется с сокращением многословия Java и скрытием шаблонного кода. В этой статье мы проверили, как настроить инструмент для двух самых популярных Java IDE.
Исходный код примеров доступен на GitHub .
Lombok – установка и настройка
Зачастую язык Java критикуют за излишнюю многословность – при объявлении класса приходится создавать геттеры и сеттеры для каждого необходимого поля, создавать конструкторы, переопределять методы toString, а также связку equals/hashCode. В современных IDE, конечно же, есть возможность всё это генерировать полуавтоматически, но необходимость заниматься шаблонным кодом всё равно никуда не исчезает. Проект Lombok призван бороться с этой проблемой.
Что такое Lombok
Lombok – это Java библиотека, призванная освободить разработчика от написания шаблонного кода. Lombok берёт на себя генерирование шаблонного кода по специальным аннотациям, которые указываются программистом в зависимости от того, какой код он хочет сгенерировать.
Установка Lombok
Установка состоит из двух этапов:
- Подключение библиотеки Lombok в проекте
- Установка плагина Lombok в IDE
Здесь мы будем использовать Maven и IntelliJ IDEA.
Подключение библиотеки Lombok в Maven
Добавьте в pom.xml следующую зависимость:
org.projectlombok lombok 1.18.12 provided
В случае, если вы используете Java 9 с module-info.java, добавьте следующую конфигурацию в pom.xml:
org.apache.maven.plugins maven-compiler-plugin 3.5.1 org.projectlombok lombok 1.18.12
Последняя версия Lombok:
Установка плагина в IDEA
Откройте меню File → Settings → Plugins
В открывшемся окне плагинов введите «Lombok» в строке поиска а нажмите кнопку «Install»:
Подтвердите установку («Accept») и перезагрузите IDEA, чтобы плагин активировался.
Заключение
Мы вкратце рассмотрели основные возможности проекта Lombok. Также мыустановку библиотеки Lombok в качестве зависимости в проекте и плагина в IDE. В следующих статьях мы используем Lombok для того, чтобы уменьшить написание шаблонного кода.
Lombok – установка и настройка
- ← Как перевернуть строку
- Как использовать библиотеку Lombok →