转自:https://www.jianshu.com/p/d08e255312f9
简述:Builder 使用创建者模式又叫建造者模式。简单来说,就是一步步创建一个对象,它对用户屏蔽了里面构建的细节,但却可以精细地控制对象的构造过程。
基础使用
@Builder
注释为你的类生成相对略微复杂的构建器API。@Builder
可以让你以下面显示的那样调用你的代码,来初始化你的实例对象:
Student.builder()
.sno( "001" )
.sname( "admin" )
.sage( 18 )
.sphone( "110" )
.build();
@Builder
可以放在类,构造函数或方法上。 虽然放在类上和放在构造函数上这两种模式是最常见的用例,但@Builder
最容易用放在方法的用例来解释。
那么@Builder内部帮我们做了什么?
- 创建一个名为
ThisClassBuilder
的内部静态类,并具有和实体类形同的属性(称为构建器)。 - 在构建器中:对于目标类中的所有的属性和未初始化的
final
字段,都会在构建器中创建对应属性。 - 在构建器中:创建一个无参的
default
构造函数。 - 在构建器中:对于实体类中的每个参数,都会对应创建类似于
setter
的方法,只不过方法名与该参数名相同。 并且返回值是构建器本身(便于链式调用),如上例所示。 - 在构建器中:一个
build()
方法,调用此方法,就会根据设置的值进行创建实体对象。 - 在构建器中:同时也会生成一个
toString()
方法。 - 在实体类中:会创建一个
builder()
方法,它的目的是用来创建构建器。
说这么多,不如让我们通过下面这个例子来理解:
@Builder
public class User {
private final Integer code = 200;
private String username;
private String password;
}
// 编译后:
public class User {
private String username;
private String password;
User(String username, String password) {
this.username = username; this.password = password;
}
public static User.UserBuilder builder() {
return new User.UserBuilder();
}
public static class UserBuilder {
private String username;
private String password;
UserBuilder() {}
public User.UserBuilder username(String username) {
this.username = username;
return this;
}
public User.UserBuilder password(String password) {
this.password = password;
return this;
}
public User build() {
return new User(this.username, this.password);
}
public String toString() {
return "User.UserBuilder(username=" + this.username + ", password=" + this.password + ")";
}
}
}
组合用法
1. @Builder中使用 @Singular 注释集合
@Builder
也可以为集合类型的参数或字段生成一种特殊的方法。 它采用修改列表中一个元素而不是整个列表的方式,可以是增加一个元素,也可以是删除一个元素。
Student.builder()
.sno( "001" )
.sname( "admin" )
.sage( 18 )
.sphone( "110" ).sphone( "112" )
.build();
这样就可以轻松地将List <String>
字段中包含2个字符串。 但是想要这样来操作集合,你需要使用@Singular
来注释字段或参数。
在使用@Singular
注释注释一个集合字段(使用@Builder
注释类),lombok
会将该构建器节点视为一个集合,并生成两个adder
方法而不是setter
方法。
- 一个向集合添加单个元素
- 一个将另一个集合的所有元素添加到集合中
将不生成仅设置集合(替换已添加的任何内容)的setter。 还生成了clear方法。 这些singular构建器相对而言是有些复杂的,主要是来保证以下特性:
- 在调用
build()
时,生成的集合将是不可变的。 - 在调用
build()
之后调用其中一个adder
方法或clear
方法不会修改任何已经生成的对象。如果对集合修改之后,再调用build()
,则会创建一个基于上一个对象创建的对象实体。 - 生成的集合将被压缩到最小的可行格式,同时保持高效。
@Singular
只能应用于lombok
已知的集合类型。目前,支持的类型有:
-
java.util:
Iterable
,Collection
, 和List
(一般情况下,由压缩的不可修改的ArrayList
支持).Set
,SortedSet
, andNavigableSet
(一般情况下,生成可变大小不可修改的HashSet
或者TreeSet
).Map
,SortedMap
, andNavigableMap
(一般情况下,生成可变大小不可修改的HashMap
或者TreeMap
).
-
Guava’s com.google.common.collect:
ImmutableCollection
andImmutableList
ImmutableSet
andImmutableSortedSet
ImmutableMap
,ImmutableBiMap
, andImmutableSortedMap
ImmutableTable
来看看使用了@Singular注解之后的编译情况:
@Builder
public class User {
private final Integer id;
private final String zipCode = "123456";
private String username;
private String password;
@Singular
private List<String> hobbies;
}
// 编译后:
public class User {
private final Integer id;
private final String zipCode = "123456";
private String username;
private String password;
private List<String> hobbies;
User(Integer id, String username, String password, List<String> hobbies) {
this.id = id; this.username = username;
this.password = password; this.hobbies = hobbies;
}
public static User.UserBuilder builder() {return new User.UserBuilder();}
public static class UserBuilder {
private Integer id;
private String username;
private String password;
private ArrayList<String> hobbies;
UserBuilder() {}
public User.UserBuilder id(Integer id) { this.id = id; return this; }
public User.UserBuilder username(String username) { this.username = username; return this; }
public User.UserBuilder password(String password) { this.password = password; return this; }
public User.UserBuilder hobby(String hobby) {
if (this.hobbies == null) {
this.hobbies = new ArrayList();
}
this.hobbies.add(hobby);
return this;
}
public User.UserBuilder hobbies(Collection<? extends String> hobbies) {
if (this.hobbies == null) {
this