Вне POJOs — еще десять способов уменьшить Boilerplate с Lombok

Экспериментальные Особенности

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

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

Методы расширения

Почти в каждом Java-проекте есть так называемые служебные классы — классы, которые содержат только статические методы. Часто их авторы предпочитают, чтобы методы были частью интерфейса, к которому они относятся. Например, методы в классе StringUtils работают со строками, и было бы хорошо, если бы их можно было вызывать непосредственно в экземплярах String .

 public class StringUtils { // would be nice to call "abc".isNullOrEmpty() // instead of StringUtils.isNullOrEmpty("abc") public static boolean isNullOrEmpty(String str) { return str == null || str.isEmpty(); } } 

Lombok имеет аннотацию для этого варианта использования, навеянную методами расширения других языков (например, в Scala ). Он добавляет методы из служебного класса в интерфейс объекта. Поэтому все, что нам нужно сделать, чтобы добавить isNullOrEmpty к интерфейсу String — это передать класс, который его определяет, в аннотацию @ExtensionMethod . Каждый статический метод в этом случае добавляется к классу своего первого аргумента:

 @ExtensionMethod({StringUtils.class}) public class App { public static void main(String[] args) { String s = null; String s2 = "str"; s.isNullOrEmpty(); // returns "true" s2.isNullOrEmpty(); // returns "false"; } } 

Мы также можем использовать эту аннотацию со встроенными служебными классами, такими как Arrays :

 @ExtensionMethod({Arrays.class}) public class App { public static void main(String[] args) { String[] arr = new String[] {"foo", "bar", "baz"}; List<String> list = arr.asList(); } } 

Это будет иметь эффект только внутри аннотированного класса, в этом примере App .

Конструкторы служебных классов

Говоря о служебных классах … Важно помнить о них, что нам нужно сообщить, что этот класс не должен создаваться. Обычный способ сделать это — создать приватный конструктор, который генерирует исключение (в случае, если кто-то использует отражение для его вызова):

 public class StringUtils { private StringUtils() { throw new UnsupportedOperationException( "Utility class should not be instantiated"); } public static boolean isNullOrEmpty(String str) { return str == null || str.isEmpty(); } } 

Этот конструктор отвлекает и громоздок. К счастью, у Lombok есть аннотация, которая генерирует это для нас:

 @UtilityClass class StringUtils { public static boolean isNullOrEmpty(String str) { return str == null || str.isEmpty(); } } 

Теперь мы можем вызывать методы этого служебного класса, как и раньше, и не можем его создать:

 StringUtils.isNullOrEmpty("str"); // returns "false" // javac: StringUtils() has private access in lomboktest.StringUtils new StringUtils(); 

Гибкие @Accessors

Эта функция не работает сама по себе, но используется для настройки того, как аннотации @Getter и @Setter генерируют новые методы. У этого есть три флага, которые настраивают его поведение:

• chain : заставляет сеттеров возвращать this ссылку вместо void
• fluent : Создает свободный интерфейс. Это имя всех методов получения и установки вместо getName и setName . Он также устанавливает chain в true, если не указано иное.
• prefix : некоторые разработчики предпочитают начинать имена полей с префикса типа «f». Эта аннотация позволяет удалить указанный префикс из методов получения и установки, чтобы избежать имен методов, таких как fName или getFName .

Вот пример класса со свободным интерфейсом, где все поля имеют префикс «f»:

 @Accessors(fluent = true, prefix = "f") @Getter @Setter class Person { private String fName; private int fAge; } 

И вот как вы можете использовать это:

 Person person = new Person() .name("John") .age(34); System.out.println(person.name()); 

Поле по умолчанию

Нередко можно увидеть класс, в котором все поля имеют одинаковый набор модификаторов. Их раздражает читать и еще больше раздражает, печатать их снова и снова:

 public class Person { private final String name; private final int age; // constructor and getters } 

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

 @FieldDefaults(level = AccessLevel.PUBLIC, makeFinal = true) @AllArgsConstructor public class Person { String name; int age; } 

Как следствие, вы можете получить доступ к name вне пакета:

 Person person = new Person("John", 34); System.out.println(person.name); 

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

 @FieldDefaults(level = AccessLevel.PUBLIC, makeFinal = true) @AllArgsConstructor public class Person { // Make this field package private @PackagePrivate String name; // Make this field non final @NonFinal int age; } 

Выводы

Lombok предлагает широкий спектр инструментов, которые могут спасти вас от тысяч линий шаблонов и сделать ваши приложения более лаконичными и краткими. Основная проблема заключается в том, что некоторые члены вашей команды могут не согласиться с тем, какие функции использовать и когда их использовать. Аннотации типа @Log вряд ли вызовут серьезные разногласия, в то время как val и @SneakyThrows могут иметь много противников. Прежде чем вы начнете использовать Lombok, я бы предложил договориться о том, как вы собираетесь его использовать.

В любом случае имейте в виду, что все аннотации Lombok могут быть легко преобразованы в простой Java-код с помощью команды delombok .

Если Lombok заинтриговал вас и вы хотите узнать, как он работает, или хотите начать использовать его прямо сейчас, прочитайте мое руководство по Lombok .