lombok 子类中如何使用@Builder问题

2022-11-13 17:11:02 lombok 如何使用类中

lombok子类中如何使用@Builder

lombok大家都知道，在使用POJO过程中，它给我们带来了很多便利，省下大量写get、set方法、构造器、equal、toString方法的时间。除此之外，通过@Builder注解，lombok还可以方便的时间建造者模式。

但是，在使用@Builder过程中，我发现了一问题：子类的Builder对象没有父类的属性。这在使用上造成了一定的问题。

几番搜索，对于这个问题，找到了如下解法，解法的链接会放到文末。

1. 对于父类，使用@AllArgsConstructor注解

2. 对于子类，手动编写全参数构造器，内部调用父类全参数构造器，在子类全参数构造器上使用@Builder注解

通过这种方式，子类Builder对象可以使用父类的所有私有属性。

但是这种解法也有两个副作用：

1. 因为使用AllArgsConstructor注解，父类构造函数字段的顺序由声明字段的顺序决定，如果子类构造函数传参的时候顺序不一致，字段类型还一样的话，出了错不好发现

2. 如果父类字段有增减，所有子类的构造器都要修改

虽然有这两个副作用，但是这种解法是我找到的唯一一种解决子类使用@Builder，能使用父类属性的方式。

参考博客：

Lombok’s @Builder annotation and inheritance

副作用见博客评论

另，这个博主对lombok使用很有心得，我闲看还看到他另一篇涉及到@Builder的文章，将如何在使用@Builder的模式中，加入字段的默认值。因为使用了建造者模式，那么一般在类内声明字段的时候给字段默认值的方式就是无效的，需要在建造者上动手脚。

方式是：

1. 自定义静态内部类作为建造者，赋予默认值，再使用@Builder注解，这个时候lombok会补全已有的建造者类，进而使用默认值

2. 更新的lombok有@Builder.Default声明，注解在需要默认值的字段上即可。

在评论区也有这种方式的副作用讨论，可以一看。链接是：

Using Lombok’s @Builder annotation with default values

子类使用lombok的@Builder注解正确姿势

在实际开发中，有时候需要对子类使用lombok的 @Builder注解来使用builder模式构造该子类对象。

父类

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
 
@Data
@NoArgsConstructor
@AllArgsConstructor
public class Parent {
    private Long id;
 
    private String name;
}

子类

import lombok.Builder;
import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.NoArgsConstructor;
 
@EqualsAndHashCode(callSuper = true)
@Data
@NoArgsConstructor
@Builder
public class Child extends Parent{
 
 
}

此时虽然在子类上添加了@Builder注解，但是由于子类没有属性，如下图所示，无法使用builder模式。

分析一下

通过阅读 lombok.Builder的源码，可知 @Builder 注解不仅可以用在类上，还可以用在构造函数上。

因此尝试如下写法：

@EqualsAndHashCode(callSuper = true)
@Data
@NoArgsConstructor
@Builder
public class Child extends Parent {
 
    @Builder
    private Child(Long id, String name) {
        super(id, name);
    }
}

再次运行上面的单元测试，发现支持了 builder 模式，但是奇怪的是，单测不通过。

java.lang.AssertionError:

Expected :1024

Actual :null

因此我们观察一下 Child.class 反编译后的代码：

//
// Source code recreated from a .class file by IntelliJ idea
// (powered by Fernflower decompiler)
//
 
package com.chujianyun.libs.lombok;
 
public class Child extends Parent {
    private Child(Long id, String name) {
        super(id, name);
    }
 
    public static Child.ChildBuilder builder() {
        return new Child.ChildBuilder();
    }
 
    public boolean equals(final Object o) {
        if (o == this) {
            return true;
        } else if (!(o instanceof Child)) {
            return false;
        } else {
            Child other = (Child)o;
            if (!other.canEqual(this)) {
                return false;
            } else {
                return super.equals(o);
            }
        }
    }
 
    protected boolean canEqual(final Object other) {
        return other instanceof Child;
    }
 
    public int hashCode() {
        int result = super.hashCode();
        return result;
    }
 
    public String toString() {
        return "Child()";
    }
 
    public Child() {
    }
 
    public static class ChildBuilder {
        private Long id;
        private String name;
 
        ChildBuilder() {
        }
 
        public Child build() {
            return new Child();
        }
 
        public String toString() {
            return "Child.ChildBuilder()";
        }
 
        public Child.ChildBuilder id(final Long id) {
            this.id = id;
            return this;
        }
 
        public Child.ChildBuilder name(final String name) {
            this.name = name;
            return this;
        }
    }
}

找到了原因，同时在子类和全参数的构造函数使用 @Builder 注解，会有 BUG，即最终的 build() 函数只是返回了空参的构造函数创建了一个 Child 对象，因此属性“采用 builder 方式设置的 id 和 name” 最终“丢失”。

那么如何解决这个问题呢？

我们再次回到@Builder 源码的注释上：

If a member is annotated, it must be either a constructor or a method. If a class is annotated,* then a private constructor is generated with all fields as arguments* (as if {@code @AllArgsConstructor(access = AccessLevel.PRIVATE)} is present* on the class), and it is as if this constructor has been annotated with {@code @Builder} instead.

可知，将其加到类上，相当于包含所有属性的私有构造方法，且构造方法上加上 @Builder 注解。

因此我们写的代码可能有冲突，我们修改如下：

import lombok.Builder;
import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.NoArgsConstructor;
 
@EqualsAndHashCode(callSuper = true)
@Data
@NoArgsConstructor
public class Child extends Parent {
 
    @Builder
    private Child(Long id, String name) {
        super(id, name);
    }
}

最终单测通过

我们观察一下此时编译后的代码：

//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by Fernflower decompiler)
//
 
package com.chujianyun.libs.lombok;
 
public class Child extends Parent {
    private Child(Long id, String name) {
        super(id, name);
    }
 
    public static Child.ChildBuilder builder() {
        return new Child.ChildBuilder();
    }
 
    public boolean equals(final Object o) {
        if (o == this) {
            return true;
        } else if (!(o instanceof Child)) {
            return false;
        } else {
            Child other = (Child)o;
            if (!other.canEqual(this)) {
                return false;
            } else {
                return super.equals(o);
            }
        }
    }
 
    protected boolean canEqual(final Object other) {
        return other instanceof Child;
    }
 
    public int hashCode() {
        int result = super.hashCode();
        return result;
    }
 
    public String toString() {
        return "Child()";
    }
 
    public Child() {
    }
 
    public static class ChildBuilder {
        private Long id;
        private String name;
 
        ChildBuilder() {
        }
 
        public Child.ChildBuilder id(final Long id) {
            this.id = id;
            return this;
        }
 
        public Child.ChildBuilder name(final String name) {
            this.name = name;
            return this;
        }
 
        public Child build() {
            return new Child(this.id, this.name);
        }
 
        public String toString() {
            return "Child.ChildBuilder(id=" + this.id + ", name=" + this.name + ")";
        }
    }
}

此时的build() 函数才是我们需要的状态。

从编译后的代码我们可以清晰地看出 lombok 通过@Builder 实现的 builder模式的核心逻辑。

即构造内部类，在内部类赋值属性，build时调用含有所有属性的构造方法创建对象。

更多细节可以仔细查看 @Builder 注解的源码和注释，查看官方的手册 https://projectlombok.org/features/Builder

总结：

遇到诡异的问题一定不要轻易放过。分析问题要有步骤，比如可以看源码中是否有说明，也可以看编译后的代码，还可以通过反汇编等，观察注解对类文件作出了哪些影响。还可以去看官方手册。

以上为个人经验，希望能给大家一个参考，也希望大家多多支持。

相关文章

lombok 子类中如何使用@Builder问题

目录