Как исключить недвижимость из застройщика Ломбок?

Да, вы можете разместить @Builder в конструкторе или статическом (фабричном) методе, содержащем только нужные поля.

Раскрытие информации: я разработчик Lombok.

Кроме того, я обнаружил, что отметка поля как final, static или static final указывает @Builder игнорировать это поле.

@Builder
public class MyClass {
   private String myField;

   private final String excludeThisField = "bar";
}

Ломбок 1.16.10

Создайте конструктор в коде и добавьте частный сеттер для своей собственности.

@Builder
XYZClientWrapper{
    String name;
    String domain;
    XYZClient client;

    public static class XYZClientWrapperBuilder {
        private XYZClientWrapperBuilder client(XYZClient client) { return this; }
    }
}

Вот мое предпочтительное решение. При этом вы можете создать свое поле client в конце и иметь его в зависимости от других полей, которые ранее были установлены конструктором.

XYZClientWrapper{
    String name;
    String domain;
    XYZClient client;
    
    @Builder
    public XYZClientWrapper(String name, String domain) {
        this.name = name;
        this.domain = domain;
        this.client = calculateClient();
    }
}

Для примера статического метода фабрики

class Car {
   private String name;
   private String model;


   private Engine engine; // we want to ignore setting this
   
   @Builder
   private static Car of(String name, String model){
      Car car=new Car();
      car.name = name;
      car.model = model;
      constructEngine(car); // some static private method to construct engine internally
      return car;  
   }

   private static void constructEngine(Car car) {
       // car.engine = blabla...
       // construct engine internally
   }
}

то вы можете использовать следующее:

Car toyotaCorollaCar=Car.builder().name("Toyota").model("Corolla").build();
// You can see now that Car.builder().engine() is not available

Обратите внимание: статический метод of будет вызываться всякий раз, когда вызывается build (), поэтому выполнение чего-то вроде Car.builder().name("Toyota") фактически не установит значение "Toyota" в name, если не будет вызван build(), а затем назначить логику в статическом методе конструктора. of выполняется.

Кроме того, обратите внимание, что к методу of осуществляется частный доступ, поэтому метод build является единственным методом, видимым вызывающим абонентам.

Я обнаружил, что смог реализовать «оболочку» статического класса Builder, добавить метод, который я хочу скрыть, с помощью модификатора частного доступа, и он больше не доступен в построителе. Точно так же я могу добавлять собственные методы в построитель.

package com.something;

import lombok.AccessLevel;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;

import javax.persistence.AttributeOverride;
import javax.persistence.AttributeOverrides;
import javax.persistence.Column;
import javax.persistence.Embedded;
import javax.persistence.Entity;
import java.time.ZonedDateTime;

@Data
@Entity
@Builder
@AllArgsConstructor
@NoArgsConstructor
public class MyClass{

    //The builder will generate a method for this property for us.
    private String anotherProperty;

    @Embedded
    @AttributeOverrides({
            @AttributeOverride(name = "localDateTime", column = @Column(name = "some_date_local_date_time")),
            @AttributeOverride(name = "zoneId", column = @Column(name = "some__date_zone_id"))
    })
    @Getter(AccessLevel.PRIVATE)
    @Setter(AccessLevel.PRIVATE)
    private ZonedDateTimeEmbeddable someDateInternal;

    public ZonedDateTime getSomeDate() {
        return someDateInternal.toZonedDateTime();
    }

    public void setSomeDate(ZonedDateTime someDate) {
        someDateInternal = new ZonedDateTimeEmbeddable(someDate);
    }

    public static class MyClassBuilder {
        //Prevent direct access to the internal private field by pre-creating builder method with private access.
        private MyClassBuilder shipmentDateInternal(ZonedDateTimeEmbeddable zonedDateTimeEmbeddable) {
            return this;
        }

        //Add a builder method because we don't have a field for this Type
        public MyClassBuilder someDate(ZonedDateTime someDate) {
            someDateInternal = new ZonedDateTimeEmbeddable(someDate);
            return this;
        }
    }

}

Может помочь добавление в класс так называемого «частичного построителя» с Lombok @Builder. Уловка состоит в том, чтобы добавить внутренний частичный класс построителя следующим образом:

@Getter
@Builder
class Human {
    private final String name;
    private final String surname;
    private final Gender gender;
    private final String prefix; // Should be hidden, depends on gender

    // Partial builder to manage dependent fields, and hidden fields
    public static class HumanBuilder {

        public HumanBuilder gender(final Gender gender) {
            this.gender = gender;
            if (Gender.MALE == gender) {
                this.prefix = "Mr.";
            } else if (Gender.FEMALE == gender) {
                this.prefix = "Ms.";
            } else {
                this.prefix = "";
            }
            return this;
        }

        // This method hides the field from external set 
        private HumanBuilder prefix(final String prefix) {
            return this;
        }

    }

}

PS: @Builder позволяет изменять сгенерированное имя класса построителя. В приведенном выше примере предполагается, что используется имя класса построителя по умолчанию.

Я нашел еще одно решение. Вы можете обернуть свое поле в начальную финальную оболочку или прокси. Самый простой способ обернуть его в AtomicReference.

@Builder
public class Example {
    private String field1;
    private String field2;
    private final AtomicReference<String> excluded = new AtomicReference<>(null);
}

Вы можете взаимодействовать с ним внутри с помощью методов get и set, но он не будет отображаться в построителе.

excluded.set("Some value");
excluded.get();

У меня есть другой подход, использующий @Delegate и Inner Class, который поддерживает вычисленные значения для исключенных полей.

Во-первых, мы перемещаем поля, которые нужно исключить, в Inner Class, чтобы Lombok не включил их в Builder.

Затем мы используем @Delegate, чтобы открыть геттеры / сеттеры полей, исключенных построителем.

Пример:

@Builder
@Getter @Setter @ToString
class Person {

    private String name;
    private int value;
    /* ... More builder-included fields here */

    @Getter @Setter @ToString
    private class BuilderIgnored {

        private String position; // Not included in the Builder, and remain `null` until p.setPosition(...)
        private String nickname; // Lazy initialized as `name+value`, but we can use setter to set a new value
        /* ... More ignored fields here! ... */

        public String getNickname(){ // Computed value for `nickname`
            if(nickname == null){
                nickname = name+value;
            }
            return nickname;
        }
        /* ... More computed fields' getters here! ... */

    }
    @Delegate @Getter(AccessLevel.NONE) // Delegate Lombok Getters/Setters and custom Getters
    private final BuilderIgnored ignored = new BuilderIgnored();

}

За пределами этого Person класса будет очевидно, что position и nickname на самом деле являются полями внутреннего класса.

Person p = Person.builder().name("Test").value(123).build();
System.out.println(p); // Person(name=Test, value=123, ignored=Person.BuilderIgnored(position=null, nickname=Test123))
p.setNickname("Hello World");
p.setPosition("Manager");
System.out.println(p); // Person(name=Test, value=123, ignored=Person.BuilderIgnored(position=Manager, nickname=Hello World))

Плюсы:

• Не заставляйте исключенные поля быть final
• Поддержка вычисляемых значений для исключенных полей
• Разрешить вычисляемым полям ссылаться на любые поля, установленные построителем (другими словами, разрешить внутреннему классу быть нестатическим классом)
• Не нужно повторять список всех полей (например, перечисление всех полей, кроме исключенных, в конструкторе)
• Не отменять @Builder библиотеки Lombok (например, создание MyBuilder extends FooBuilder)

Минусы:

• Исключенные поля на самом деле являются полями Inner Class; однако, используя идентификатор private с соответствующими геттерами / сеттерами, вы можете имитировать, как если бы они были настоящими полями
• Следовательно, этот подход ограничивает доступ к исключенным полям с помощью Getters / Setters.
• Вычисленные значения инициализируются отложенным образом при вызове геттеров, а не при .build().

Один из подходов, который я использовал раньше, заключался в группировке полей экземпляра в поля конфигурации и поля сеанса. Поля конфигурации идут как экземпляры классов и видны Строителю, в то время как поля сеанса входят в вложенный private static class и доступны через конкретное поле экземпляра final (которое Строитель по умолчанию игнорирует).

Что-то вроде этого:

@Builder
class XYZClientWrapper{
    private String name;
    private String domain;
 
    private static class Session {
        XYZClient client;
    }

    private final Session session = new Session();

    private void initSession() {
        session.client = ...;
    }
 
    public void foo() {
        System.out.println("name: " + name);
        System.out.println("domain: " + domain;
        System.out.println("client: " + session.client);
    }
}