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.hobbies = new ArrayList();
}
this.hobbies.addAll(hobbies);
return this;
}
public User.UserBuilder clearHobbies() {
if (this.hobbies != null) {
this.hobbies.clear();
}
return this;
}
public User build() {
List hobbies;
switch(this.hobbies == null ? 0 : this.hobbies.size()) {
case 0:
hobbies = Collections.emptyList();
break;
case 1:
hobbies = Collections.singletonList(this.hobbies.get(0));
break;
default:
hobbies = Collections.unmodifiableList(new ArrayList(this.hobbies));
}
return new User(this.id, this.username, this.password, hobbies);
}
public String toString() {
return "User.UserBuilder(id=" + this.id + ", username=" + this.username + ", password=" + this.password + ", hobbies=" + this.hobbies + ")";
}
}
}
其實,lombok的創作者還是很用心的,在進行build()來創建實例對象時,
並沒有直接使用Collections.unmodifiableList(Collection)
此方法來牀架實例,而是分爲三種情況。
- 第一種,當集合中沒有元素時,創建一個空list
- 第二種情況,當集合中存在一個元素時,創建一個不可變的單元素list
- 第三種情況,根據當前集合的元素數量創建對應合適大小的list
當然我們看編譯生成的代碼,創建了三個關於集合操作的方法:
hobby(String hobby)
:向集合中添加一個元素hobbies(Collection<? extends String> hobbies)
:添加一個集合所有的元素clearHobbies()
:清空當前集合數據
2. @Singular 註解配置value屬性
我們先來看看 @Singular 註解的詳情:
@Target({FIELD, PARAMETER})
@Retention(SOURCE)
public @interface Singular {
// 修改添加集合元素的方法名
String value() default "";
}
- 測試如何使用註解屬性
value
@Builder
public class User {
private final Integer id;
private final String zipCode = "123456";
private String username;
private String password;
@Singular(value = "testHobbies")
private List<String> hobbies;
}
// 測試類
public class BuilderTest {
public static void main(String[] args) {
User user = User.builder()
.testHobbies("reading")
.testHobbies("eat")
.id(1)
.password("admin")
.username("admin")
.build();
System.out.println(user);
}
}
說明,當我們使用了註解屬性value
之後,我們在使用添加集合元素時的方法名發生相應的改變。但是,同時生成的添加整個集合的方法名發生改變了嗎?我們再來看看編譯後的代碼:
/ 編譯後:
public class User {
// 省略部分代碼,只看關鍵部分
public static class UserBuilder {
public User.UserBuilder testHobbies(String testHobbies) {
if (this.hobbies == null) {
this.hobbies = new ArrayList();
}
this.hobbies.add(testHobbies);
return this;
}
public User.UserBuilder hobbies(Collection<? extends String> hobbies) {
if (this.hobbies == null) {
this.hobbies = new ArrayList();
}
this.hobbies.addAll(hobbies);
return this;
}
public User.UserBuilder clearHobbies() {
if (this.hobbies != null) {
this.hobbies.clear();
}
return this;
}
}
}
可以看到,只有添加一個元素的方法名發生了改變。
3. @Builder.Default 的使用
比如有這樣一個實體類:
@Builder
@ToString
public class User {
@Builder.Default
private final String id = UUID.randomUUID().toString();
private String username;
private String password;
@Builder.Default
private long insertTime = System.currentTimeMillis();
}
在類中我在id
和insertTime
上都添加註解@Builder.Default
,當我在使用這個實體對象時,我就不需要在爲這兩個字段進行初始化值,如下面這樣:
public class BuilderTest {
public static void main(String[] args) {
User user = User.builder()
.password("admin")
.username("admin")
.build();
System.out.println(user);
}
}
// 輸出內容:
User(id=416219e1-bc64-43fd-b2c3-9f8dc109c2e8, username=admin, password=admin, insertTime=1546869309868)
lombok
在實例化對象時就爲我們初始化了這兩個字段值。
當然,你如果再對這兩個字段進行設值的話,那麼默認定義的值將會被覆蓋掉,如下面這樣:
public class BuilderTest {
public static void main(String[] args) {
User user = User.builder()
.id("admin")
.password("admin")
.username("admin")
.build();
System.out.println(user);
}
}
// 輸出內容
User(id=admin, username=admin, password=admin, insertTime=1546869642151)
4. @Builder 詳細配置
下面我們再來詳細看看@Builder
這個註解類地詳細實現:
@Target({TYPE, METHOD, CONSTRUCTOR})
@Retention(SOURCE)
public @interface Builder {
// 如果@Builder註解在類上,可以使用 @Builder.Default指定初始化表達式
@Target(FIELD)
@Retention(SOURCE)
public @interface Default {}
// 指定實體類中創建 Builder 的方法的名稱,默認爲: builder (個人覺得沒必要修改)
String builderMethodName() default "builder";
// 指定 Builder 中用來構件實體類的方法的名稱,默認爲:build (個人覺得沒必要修改)
String buildMethodName() default "build";
// 指定創建的建造者類的名稱,默認爲:實體類名+Builder
String builderClassName() default "";
// 使用toBuilder可以實現以一個實例爲基礎繼續創建一個對象。(也就是重用原來對象的值)
boolean toBuilder() default false;
@Target({FIELD, PARAMETER})
@Retention(SOURCE)
public @interface ObtainVia {
// 告訴lombok使用表達式獲取值
String field() default "";
// 告訴lombok使用表達式獲取值
String method() default "";
boolean isStatic() default false;
}
}
以上註解屬性,我只測試一個比較常用的toBuilder
,因爲我們在對實體對象進行操作時,往往會存在對某些實體對象的某個字段進行二次賦值,這個時候就會用到這一屬性。但是,這會創建一個新的對象,而不是原來的對象,原來的對象屬性是不可變的,除非你自己想要給這個實體類再添加上@Data
或者@setter
方法。下面就來測試一下:
@Builder(toBuilder = true)
@ToString
public class User {
private String username;
private String password;
}
// 測試類
public class BuilderTest {
public static void main(String[] args) {
User user1 = User.builder()
.password("admin")
.username("admin")
.build();
System.out.println(user1);
User user2 = user1.toBuilder().username("admin2").build();
// 驗證user2是否是基於user1的現有屬性創建的
System.out.println(user2);
// 驗證對象是否是同一對象
System.out.println(user1 == user2);
}
}
// 輸出內容
User(username=admin, password=admin)
User(username=admin2, password=admin)
false
5. @Builder 全局配置
# 是否禁止使用@Builder
lombok.builder.flagUsage = [warning | error] (default: not set)
# 是否使用Guaua
lombok.singular.useGuava = [true | false] (default: false)
# 是否自動使用singular,默認是使用
lombok.singular.auto = [true | false] (default: true)
- 總的來說
@Builder
還是很好用的。
文章參考自:https://blog.csdn.net/weixin_41540822/article/details/86606562
作者:虹貓日誌
鏈接:https://www.jianshu.com/p/d08e255312f9
來源:簡書
著作權歸作者所有。商業轉載請聯繫作者獲得授權,非商業轉載請註明出處。