Lombok 我们可以在单个 class 上一起使用 @Builder 和 @Value

Question

首先要感谢 Lombok，我们的 java 代码现在更加简洁明了。我的用例是我想创建一个不可变的 class。为此，我会使用@Value 注释。我还想使用构建器功能，为此我会使用 @Builder 注释。我的问题是我们是否可以在单个 class 上同时使用@Builder 和@Value。这是 Lombok users/developers 推荐的好做法吗？

Answer 1

当然可以。要检查，只需 delombok 您的代码并查看它生成的内容。举个例子：

@Builder
@Value
public class Pair {
    private Object left;
    private Object right;
}

在 delombokification 之后，这会产生：

public class Pair {
    private Object left;
    private Object right;

    @java.beans.ConstructorProperties({ "left", "right" })
    Pair(Object left, Object right) {
        this.left = left;
        this.right = right;
    }

    public static PairBuilder builder() {
        return new PairBuilder();
    }

    public Object getLeft() {
        return this.left;
    }

    public Object getRight() {
        return this.right;
    }

    public boolean equals(Object o) {
        if (o == this) return true;
        if (!(o instanceof Pair)) return false;
        final Pair other = (Pair) o;
        final Object this$left = this.left;
        final Object other$left = other.left;
        if (this$left == null ? other$left != null : !this$left.equals(other$left)) return false;
        final Object this$right = this.right;
        final Object other$right = other.right;
        if (this$right == null ? other$right != null : !this$right.equals(other$right)) return false;
        return true;
    }

    public int hashCode() {
        final int PRIME = 59;
        int result = 1;
        final Object $left = this.left;
        result = result * PRIME + ($left == null ? 0 : $left.hashCode());
        final Object $right = this.right;
        result = result * PRIME + ($right == null ? 0 : $right.hashCode());
        return result;
    }

    public String toString() {
        return "Pair(left=" + this.left + ", right=" + this.right + ")";
    }

    public static class PairBuilder {
        private Object left;
        private Object right;

        PairBuilder() {
        }

        public Pair.PairBuilder left(Object left) {
            this.left = left;
            return this;
        }

        public Pair.PairBuilder right(Object right) {
            this.right = right;
            return this;
        }

        public Pair build() {
            return new Pair(left, right);
        }

        public String toString() {
            return "Pair.PairBuilder(left=" + this.left + ", right=" + this.right + ")";
        }
    }
}

所以你可以清楚地同时使用 @Value 和 @Builder

Answer 2

从版本 1.16.10 开始，当您同时使用两者时，构造函数是 而不是 public。

您可以添加@AllArgsConstructor 来弥补这一点。

Answer 3

简短回答：是的，您始终可以同时使用@Value 和@Builder。我在我的生产代码中使用了它并且它工作正常。

长答案：您可以将它们一起使用。你要记住的一件事是，自 lombok v1.16.0 以来，@Value 提供的 AllArgsConstructor 将对包私有。因此，如果您希望它成为 public，您将必须通过@AllArgsConstructor 额外访问控制。但就我而言，私有构造函数才是我真正想要的。我使用@Builder 的目的是真正允许仅使用构建器实例化对象，而不是稍后使用构造函数或 setter 方法。

这是我的代码：


@Value
@Builder
@ApiModel(description = "Model to represent annotation")
public class Annotation {

    @NonNull
    @ApiModelProperty(value = "Unique identifier")
    private String id;

}

@Value type from eclipse

@Builder tyoe from eclipse

Lombok 我们可以在单个 class 上一起使用 @Builder 和 @Value

Lombok Can we use @Builder and @Value together on a single class

java

lombok