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(