Lombok中@Builder和@SuperBuilder注解的用法案例

 更新时间:2023年01月11日 08:48:00   作者:Twilight's Blog  
@Builder 是 lombok 中的注解,可以使用builder()构造的Person.PersonBuilder对象进行链式调用,给所有属性依次赋值,这篇文章主要介绍了Lombok中@Builder和@SuperBuilder注解的用法,需要的朋友可以参考下

Lombok中@Builder和@SuperBuilder注解的用法

@Builder 是 lombok 中的注解。可以使用builder()构造的Person.PersonBuilder对象进行链式调用,给所有属性依次赋值。

 Person person1 = Person.builder()
            .name("张三")
            .age(20)
            .build();
    System.out.println(person1);                // Person(name=张三, age=20)
    System.out.println(Person.builder());       // Person.PersonBuilder(name=null, age=null)

文档中给了案例,在实体类上添加 @Builder 后,实体类会被改造成如下的结构:

Before:
  @Builder
  class Example<T> {
  	private T foo;
  	private final String bar;
  }
  
After:
  class Example<T> {
  	private T foo;
  	private final String bar;
  	
  	// 私有的全参数构造函数
  	private Example(T foo, String bar) {
  		this.foo = foo;
  		this.bar = bar;
  	}
  	
  	public static <T> ExampleBuilder<T> builder() {
  		return new ExampleBuilder<T>();
  	}
  	
  	public static class ExampleBuilder<T> {
  		private T foo;
  		private String bar;
  		
  		private ExampleBuilder() {}
  		
  		public ExampleBuilder foo(T foo) {
  			this.foo = foo;
  			return this;
  		}
  		
  		public ExampleBuilder bar(String bar) {
  			this.bar = bar;
  			return this;
  		}
  		
  		@java.lang.Override public String toString() {
  			return "ExampleBuilder(foo = " + foo + ", bar = " + bar + ")";
  		}
  		
  		public Example build() {
  			return new Example(foo, bar);
  		}
  	}
  }

源码如下:

@Target({TYPE, METHOD, CONSTRUCTOR})
@Retention(SOURCE)
public @interface Builder {

	@Target(FIELD)
	@Retention(SOURCE)
	public @interface Default {}

	String builderMethodName() default "builder";

	String buildMethodName() default "build";
	
	String builderClassName() default "";

	boolean toBuilder() default false;

	AccessLevel access() default lombok.AccessLevel.PUBLIC;

	String setterPrefix() default "";
	
	@Target({FIELD, PARAMETER})
	@Retention(SOURCE)
	public @interface ObtainVia {

		String field() default "";

		String method() default "";
		
		boolean isStatic() default false;
	}
}

@Singular 注解修饰集合

该注解默认变量的名称是一个复数,并且尝试生成该变量的奇数形式。例如 List<String> skills,会添加3个方法:

  • skill(String skill) 添加单个元素
  • skills(List<String> skillList) 添加一个集合
  • clearSkills() 清空集合,并且将未初始化的集合初始化未空集合。

如果无法计算得到变量名称的奇数形式,则会提示报错信息。用户可以手动指定单数形式的方法名:

@Singular("skill")
    private List<String> skillList;

这时会生成skill(String skill) 、 skillList(List<String> skillList) 和 clearSkillList()三个方法。

@Builder.Default

使用 @Builder.Default 设置默认值,构建对象时可以不用调用name()方法。(调用后会覆盖默认值)

@Builder.Default
    private String name = "zhangsan";

@SuperBuilder

@Builder 注解无法解析父类的属性,而@SuperBuilder可以读取父类的属性。使用时需要在子类和父类上都加上这个注解

@SuperBuilder
public class Male extends Person{
}

@SuperBuilder
public class Person {
    @Builder.Default
    private String name = "zhangsan";

    private Integer age;

    @Singular("skillList")
    private List<String> skillList;
}

@SuperBuilder(toBuilder=true)

使用 @SuperBuilder(toBuilder=true) 可以使用已有的对象构建新的对象,旧对象的属性值会被保留和覆盖。注意: 子类和父类都需要加上toBuilder=true

  Male man = Male.builder()
                .name("张三")
                .age(20)
                .build();
        
        Male man2 = man.toBuilder()
                .age(30)
                .build();

PS:java Lombok下解决@Builder继承解决方法(@SuperBuilder)

由于Lombok @Builder不适用于继承用例:

class Foo{
 protected int xyz1;
 .....
 protected String xyz7;
}

class Bar extends Foo{

}

对于给定的用例,Lombok将无法生成方法来设置Foo类中定义的参数值。

解决方法是:

    • 手动创建Bar的构造函数。
    • 在该构造函数上放置一个Builder注释。

Lombok引入了实验性功能,其版​​本为:1.18.2,用于解决Builder注释所面临的继承问题,并且可以使用@SuperBuilder注释解决如下。

@SuperBuilder
public class ParentClass {
    private final String a;
    private final String b;
}

@SuperBuilder
public class ChildClass extends ParentClass{
    private final String c;
}

现在,可以使用如下所示的Builder类(使用@Builder注解是不可能的)

ChildClass.builder().a("testA").b("testB").c("testC").build();

到此这篇关于Lombok中@Builder和@SuperBuilder注解的用法的文章就介绍到这了,更多相关Lombok中@Builder和@SuperBuilder注解内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Java countDownLatch如何实现多线程任务阻塞等待

    Java countDownLatch如何实现多线程任务阻塞等待

    这篇文章主要介绍了Java countDownLatch如何实现多线程任务阻塞等待,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-10-10
  • 全面解析Java设计模式之单例模式

    全面解析Java设计模式之单例模式

    这篇文章主要帮助大家全面解析Java设计模式之单例模式,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-12-12
  • mybatisplus如何实现排序

    mybatisplus如何实现排序

    这篇文章主要介绍了mybatisplus如何实现排序问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-02-02
  • RabbitMQ消息有效期与死信的处理过程

    RabbitMQ消息有效期与死信的处理过程

    利用DLX,当消息在一个队列中变成死信 (dead message) 之后,它能被重新publish到另一个Exchange,这个Exchange就是DLX,本文重点给大家介绍RabbitMQ消息有效期与死信的相关知识,感兴趣的朋友跟随小编一起看看吧
    2022-03-03
  • 每日六道java新手入门面试题,通往自由的道路

    每日六道java新手入门面试题,通往自由的道路

    这篇文章主要为大家分享了最有价值的6道java面试题,涵盖内容全面,包括数据结构和算法相关的题目、经典面试编程题等,对hashCode方法的设计、垃圾收集的堆和代进行剖析,感兴趣的小伙伴们可以参考一下
    2021-06-06
  • 快速搭建SSM框架(Maven)五步曲的方法步骤

    快速搭建SSM框架(Maven)五步曲的方法步骤

    这篇文章主要介绍了快速搭建SSM框架(Maven)五步曲的方法步骤,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-10-10
  • Java RSA加密解密实现方法分析【附BASE64 jar包下载】

    Java RSA加密解密实现方法分析【附BASE64 jar包下载】

    这篇文章主要介绍了Java RSA加密解密实现方法,结合实例形式分析了java基于第三方类库javabase64-1.3.1.jar实现RSA加密解密功能的具体步骤与相关操作技巧,需要的朋友可以参考下
    2017-10-10
  • Java经典算法汇总之选择排序(SelectionSort)

    Java经典算法汇总之选择排序(SelectionSort)

    选择排序也是比较简单的一种排序方法,原理也比较容易理解,选择排序在每次遍历过程中只记录下来最小的一个元素的下标,待全部比较结束之后,将最小的元素与未排序的那部分序列的最前面一个元素交换,这样就降低了交换的次数,提高了排序效率。
    2016-04-04
  • 解决程序包org.springframework.test.context不存在

    解决程序包org.springframework.test.context不存在

    这篇文章主要介绍了解决程序包org.springframework.test.context不存在的问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-09-09
  • log4j2异步Logger(详解)

    log4j2异步Logger(详解)

    下面小编就为大家带来一篇log4j2异步Logger(详解)。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-10-10

最新评论