Цикл статей «Project Lombok».
Следующая статья — «Lombok @EqualsAndHashCode — облегчаем сравнение объектов».
Предыдущая статья — «Lombok @Getter и @Setter — больше не нужно писать геттеры и сеттеры».
К любому объявлению класса можно добавить аннотацию @ToString, чтобы lombok генерировал реализацию метода toString(). По умолчанию он возвращает имя класса и значения всех полей, разделённые запятыми.
Устанавливая параметр includeFieldNames в true, вы можете сделать вывод полей более понятным (но увеличить длину).
По умолчанию все нестатические поля выводятся. Если вы хотите пропустить некоторые поля, то вы можете перечислить их в параметре exclude. Или вы можете указать только поля, которые нужно выводить в параметре of.
Устанавливая callSuper в true, вы можете включить в результат результат вызова родительского класса. Имейте в виду, что реализация toString() в классе java.lang.Object бессмысленна, а значит вы, вероятно, не захотите делать этого, если только вы не расширяете другой класс.
С помощью Lombok
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 |
import lombok.ToString; @ToString(exclude = "id") public class ToStringExample { private static final int STATIC_VAR = 10; private String name; private Shape shape = new Square(5, 10); private String[] tags; private int id; public String getName() { return this.getName(); } @ToString(callSuper = true, includeFieldNames = true) public static class Square extends Shape { private final int width, height; public Square(int width, int height) { this.width = width; this.height = height; } } } |
Чистая Java
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 |
import java.util.Arrays; public class ToStringExample { private static final int STATIC_VAR = 10; private String name; private Shape shape = new Square(5, 10); private String[] tags; private int id; public String getName() { return this.getName(); } public static class Square extends Shape { private final int width, height; public Square(int width, int height) { this.width = width; this.height = height; } @Override public String toString() { return "Square(super=" + super.toString() + ", width=" + this.width + ", height=" + this.height + ")"; } } @Override public String toString() { return "ToStringExample(" + this.getName() + ", " + this.shape + ", " + Arrays.deepToString(this.tags) + ")"; } } |
Поддерживаемые ключи конфигурации
|
1 |
lombok.toString.includeFieldNames = [true | false] (default: true) |
Обычно lombok генерирует фрагмент результата toString для каждого поля в виде «-имя поля = значение» Если эту настройку установить в false, то lombok будет пропускать имя поля и просто генерировать разделённый запятыми список значений полей. Параметр аннотации includeFieldNames, если указан, имеет приоритет перед этой настройкой.
|
1 |
lombok.toString.doNotUseGetters = [true | false] (default: false) |
Если установлено в true, то lombok при генерации методов toString() будет получать доступ к полям напрямую вместо использования методов получения значений. Параметр аннотации doNotUseGetters, если явно указан, имеет приоритет перед этой настройкой.
|
1 |
lombok.toString.flagUsage = [warning | error] (default: not set) |
Lombok будет помечать все использования @ToString предупреждением или ошибкой, если указано.
Мелкий шрифт
Если уже есть метод с именем toString без аргументов, независимо от типа возвращаемого значения, никакой метод генерироваться не будет, а вместо этого появится предупреждение, объясняющее, что аннотация @ToString ничего не делает. Вы можете пометить любой метод @lombok.experimental.Tolerate, чтобы скрыть их от lombok.
Массивы выводятся с помощью Arrays.deepToString, что означает, что массивы, содержащие самих себя, генерируют исключение StackOverflowError. Однако это поведение не отличается от ArrayList.
Попытка исключить поля, которых нет или которые уже исключены (потому что они статические), приводит к появлению предупреждений на этих полях. Поэтому вам не нужно беспокоится об опечатках.
Одновременное присутствие exclude и of генерирует предупреждение, и в этом случае exclude будет игнорироваться.
Не гарантируется сохранение одинакового вывода сгенерированных методов toString() в различных версиях lombok. Вам не следует проектировать API таким образом, чтобы ваш код парсил toString()!
По умолчанию все переменные, начинающиеся с символа «$», исключаются автоматически. Вы можете только включить их, используя параметр of.
Если метод получения значения существует для включаемого поля, то вызывается он вместо прямого обращения к полю. Это поведение может быть изменено: @ToString(doNotUseGetters = true)
@ToString можно использовать при объявлении перечисления.
Цикл статей «Project Lombok».
Следующая статья — «Lombok @EqualsAndHashCode — облегчаем сравнение объектов».
Предыдущая статья — «Lombok @Getter и @Setter — больше не нужно писать геттеры и сеттеры».