還在手寫 Builder 模式？試試 Lombok 中的 @Builder 用法，太強了！

阿新 • • 發佈：2022-05-23

來源：cnblogs.com/ajing2018/p/14281700.html

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 + ")";
        }
    }
}

組合用法

@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, and NavigableSet (一般情況下，生成可變大小不可修改的HashSet或者TreeSet).
Map, SortedMap, and NavigableMap (一般情況下，生成可變大小不可修改的HashMap或者TreeMap).

Guava’s com.google.common.collect:

ImmutableCollection and ImmutableList
ImmutableSet and ImmutableSortedSet
ImmutableMap, ImmutableBiMap, and ImmutableSortedMap
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()：清空當前集合資料

@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;
        }
    }
}

可以看到，只有新增一個元素的方法名發生了改變。

@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)

@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

@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還是很好用的。

近期熱文推薦：

1.1,000+ 道 Java面試題及答案整理(2022最新版)

2.勁爆！Java 協程要來了。。。

3.Spring Boot 2.x 教程，太全了！

4.別再寫滿屏的爆爆爆炸類了，試試裝飾器模式，這才是優雅的方式！！

5.《Java開發手冊（嵩山版）》最新發布，速速下載！

覺得不錯，別忘了隨手點贊+轉發哦！

還在手寫 Builder 模式？試試 Lombok 中的 @Builder 用法，太強了！

基礎使用

那麼@Builder內部幫我們做了什麼？

組合用法

還在手寫 Builder 模式？試試 Lombok 中的 @Builder 用法，太強了！

用 Span 對 C# 程序中三大記憶體區域進行統一訪問，太厲害了！

Lombok中@Builder註解的使用

Lombok中@Builder的使用

太實用了！自己動手寫軟體——GUI程式設計

太實用了！自己動手寫軟體——SSH、FTP和SQL server的密碼破解

太實用了！自己動手寫軟體——我們的密碼PJ器終於完成了

Java進階專題(十一) 想理解JVM看了這篇文章，就知道了！（中）

Android中RecyclerView用法，一步一步教你如何使用RecyclerView以及帶你走過編碼中可能會出現的坑~

Android中RecyclerView用法，一步一步教你如何使用RecyclerView以及帶你走過編碼中可能會出現的坑{皮皮恢復區}

寫的太細了！Spring MVC攔截器的應用，建議收藏再看！

終於逮到了，老公半夜不睡覺竟是在為我寫這份資料結構與演算法的原始碼筆記，我哭了！

牛逼！阿里P7架構師分享出來的MyBatis+設計模式架構指南，太香了

圖解 Spring 迴圈依賴，寫得太好了！

太好了 | 這篇寫的太好了！Spring Boot + Redis 實現介面冪等性

thymeleaf 模板中 th:href 用法，你廢了嗎?

面試官：小夥子，夠了夠了，一個工廠模式你都在這說半個小時了！

ubuntu中的root，你需要了解這些

Pytorch中backward用法，以及gradient引數解析

【Python爬蟲】尺度太大了！爬一個專門看小姐姐的網站，寫一段緊張刺激的程式碼（附原始碼）

還在手寫 Builder 模式？試試 Lombok 中的 @Builder 用法，太強了！

基礎使用

那麼@Builder內部幫我們做了什麼？

組合用法

相關推薦