解决Lombok使用@Builder无法build父类属性的问题
作者:腿短,快跑
Lombok使用@Builder无法build父类属性
问题描述
实体类使用Lombok的@Builder来实现Builder模式,但是如果使用了extend继承,则子类无法通过Builder来Build父类属性值
解决方案
父类增加@NoArgsConstructor、@AllArgsConstructor注解来增加无参和全参构造函数【注:父类属性不能设置为private,否则仍然无法访问,父类不允许有@Builder注解,否则会和子类冲突】
子类增加@NoArgsConstructor来增加无参构造函数,自定义一个全参构造函数(包含父类属性)
使用示例
父类:
package com.baijia.uqun.individual.management.facade; import lombok.AllArgsConstructor; import lombok.Getter; import lombok.NoArgsConstructor; import lombok.Setter; /** * @Author C.W * @Date 2020/6/15 5:25 下午 * @Description 父类 */ @Setter @Getter @NoArgsConstructor @AllArgsConstructor public class Father { /** * 父类名称 */ public String fatherName; }
子类:
package com.baijia.uqun.individual.management.facade; import lombok.Builder; import lombok.Getter; import lombok.NoArgsConstructor; import lombok.Setter; /** * @Author C.W * @Date 2020/6/15 5:26 下午 * @Description 子类 */ @Setter @Getter @NoArgsConstructor public class Child extends Father { /** * 子类名称 */ private String childName; /** * 用于解决Lombok的Builder无法Build父类属性问题 * * @param fatherName * @param childName */ @Builder(toBuilder = true) public Child(String fatherName, String childName) { super(fatherName); this.childName = childName; } }
使用:
package com.baijia.uqun.individual.management.facade; /** * @Author C.W * @Date 2020/6/15 5:28 下午 * @Description 测试代码 */ public class Test { public static void main(String[] args) { // 创建一个子类 Child child = Child.builder() .fatherName("父类名称") .childName("子类名称") .build(); System.out.println(String.format("父类名称:%s,子类名称:%s", child.getFatherName(), child.getChildName())); } }
输出结果:
父类名称:父类名称,子类名称:子类名称
lombok @Builder注解和build父类属性问题
1、简介
通过@Builder注解,lombok可以方便的实践建造者模式。
2、使用
1)创建基类User
import lombok.*; /** * @author Saint */ @Getter @Setter @ToString @NoArgsConstructor @AllArgsConstructor @Builder public class User { private Long id; private String name; }
2)创建子类UserExt
import lombok.*; /** * @author Saint */ @Getter @Setter @Builder @NoArgsConstructor @AllArgsConstructor @ToString public class UserExt extends User{ private String address; private Integer age; }
3)分别使用Builder创建父类和子类
// 父类 User user = User.builder().id(1L).name("saint").build(); // 子类 UserExt userExt = UserExt.builder().address("南京").age(18).build();
3、@Builder注解对类做了什么?
反编译后的UserExt.class:
public class UserExt extends User { private String address; private Integer age; public static UserExt.UserExtBuilder builder() { return new UserExt.UserExtBuilder(); } public String getAddress() { return this.address; } public Integer getAge() { return this.age; } public void setAddress(final String address) { this.address = address; } public void setAge(final Integer age) { this.age = age; } public UserExt() { } public UserExt(final String address, final Integer age) { this.address = address; this.age = age; } public String toString() { return "UserExt(address=" + this.getAddress() + ", age=" + this.getAge() + ")"; } public static class UserExtBuilder { private String address; private Integer age; UserExtBuilder() { } public UserExt.UserExtBuilder address(final String address) { this.address = address; return this; } public UserExt.UserExtBuilder age(final Integer age) { this.age = age; return this; } public UserExt build() { return new UserExt(this.address, this.age); } public String toString() { return "UserExt.UserExtBuilder(address=" + this.address + ", age=" + this.age + ")"; } } }
注解在编译后使UserExt类中多了一个名为UserExt.UserExtBuilder的静态内部类。这个静态类拥有和UserExt类相同的属性,并且他额外实现了一些方法:
1.address、age的属性方法
其实这些方法和setAttribute十分类似,只是额外返回了实例本身,这使得它可以使用类似于链式调用的写法。
2.build方法
该方法调用UserExt类的全参构造方法来生成UserExt实例。
UserExt类还是实现了builder方法,这个方法生成一个空的UserExt.UserExtBuilder实例。
4、优缺点
- 优点:
写法更优雅,不需要太多的set方法设置属性。
- 缺点:
在生成UserExt实例之前,先创建了一个UserExt.UserExtBuilder实例,其占用了额外的内存。并且Java是按值传递,我们可以直接修改引用对象,不用新建一个对象再赋值;而Builder.build()方法每次调用都会new一个实例出来。
5、问题:@Builder注解不能 build 父类属性
从反编译后的UserExt类可以看出,UserExtBuilder并没有从父类User继承来的属性:id、name的填充方法。
解决方案:
在子类和父类中都使用@SuperBuilder,去掉@Builder。但从import的包中也能看到@SuperBuilder注解是experimental实验性的。不知道会不存存在什么潜在风险,慎用。
从反编译后的User 和UserExt类来看:
public abstract static class UserBuilder<C extends User, B extends User.UserBuilder<C, B>> public abstract static class UserExtBuilder<C extends UserExt, B extends UserExt.UserExtBuilder<C, B>> extends UserBuilder<C, B>
lombok对UserBuilder 与 UserExtBuilder做了继承关系
以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。