如何从 Lombok builder 中排除财产？

Question

我有一个名为 "XYZClientWrapper" 的类，它具有以下结构：

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

我不希望为属性XYZClient client生成构建函数

Lombok 是否支持这样的用例？

Answer 1

要从构建器中排除字段，请尝试使用@Builder.Default

Answer 2

我之前使用的一种方法是将实例字段分组为配置字段和会话字段。配置字段作为类实例并且对 Builder 可见，而 Session 字段进入 nested private static class 并通过具体的 final 实例字段访问（默认情况下，Builder 将忽略该字段） .

类似这样的：

@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);
    }
}

Answer 3

工厂静态方法示例

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，除非 @调用 987654327@，然后执行构造函数静态方法 of 中的分配逻辑。

另外，注意 of 方法是私有访问的，因此 build 方法是调用者可见的唯一方法

Answer 4

我有另一种方法使用@Delegate 和Inner Class，它支持排除字段的“计算值”。

首先，我们将要排除的字段移动到 Inner Class 中，以避免 Lombok 将它们包含在 Builder 中。

然后，我们使用@Delegate 来公开构建器排除字段的 Getter/Setter。

示例：

@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();

}

position 和 nickname 实际上是内部类的字段，这对 Person 类的外部是透明的。

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
• 支持排除字段的计算值
• 允许计算字段引用构建器设置的任何字段（换句话说，允许内部类为非静态类）
• 不需要重复所有字段的列表（例如，在构造函数中列出除排除字段之外的所有字段）
• 不要覆盖 Lombok 库的 @Builder（例如创建 MyBuilder extends FooBuilder）

缺点：

• 排除的字段实际上是Inner Class的字段；但是，使用 private 标识符和适当的 Getter/Setter，您可以模仿它们，就好像它们是真实的字段一样
• 因此，这种方法限制您使用 Getters/Setters 访问排除的字段
• 当调用 Getter 时，计算值被延迟初始化，而不是在 .build() 时。

Answer 5

这是我的首选解决方案。这样，您可以在最后创建您的字段client，并根据构建器先前设置的其他字段来拥有它。

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

Answer 6

使用 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 允许更改生成的构建器类名称。上面的示例假设使用了默认的构建器类名。

Answer 7

我找到了另一种解决方案 您可以将您的字段包装到 initiated final 包装器或代理中。 将其包装到 AtomicReference 中的最简单方法。

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

您可以通过 get 和 set 方法与它内部交互，但它不会出现在 builder 中。

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

Answer 8

我发现我能够实现静态 Builder 类的“shell”，使用私有访问修饰符添加我想要隐藏的方法，并且在 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;
        }
    }

}

Answer 9

在代码中创建构建器并为您的属性添加私有设置器。

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

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

Answer 10

另外，我发现将字段标记为 final、static 或 static final 会指示 @Builder 忽略该字段。

@Builder
public class MyClass {
   private String myField;

   private final String excludeThisField = "bar";
}

龙目岛 1.16.10

Answer 11

是的，您可以将@Builder 放在构造函数或静态（工厂）方法上，只包含您想要的字段。

披露：我是 Lombok 开发人员。