問(wèn)題概述

Lombok 的 @Builder 注解極大地簡(jiǎn)化了“建造者模式”的代碼編寫(xiě)，但其默認(rèn)行為存在兩個(gè)非常隱蔽的陷阱：

陷阱一：無(wú)參構(gòu)造函數(shù)消失

現(xiàn)象：當(dāng)一個(gè)類(lèi)同時(shí)使用 @Data 和 @Builder 后，原本可用的無(wú)參構(gòu)造函數(shù) new Entity() 突然不可用，編譯報(bào)錯(cuò)。

陷阱二：字段默認(rèn)值（初始化）失效

現(xiàn)象：在字段聲明時(shí)設(shè)置的默認(rèn)值（如 String status = “open”;），通過(guò) Builder 創(chuàng)建對(duì)象時(shí)，若未顯式設(shè)置該字段，其值將為 null 而非預(yù)期的 “open”。

陷阱一：無(wú)參構(gòu)造函數(shù)消失

復(fù)現(xiàn)步驟

編寫(xiě)一個(gè)同時(shí)使用 @Data 和 @Builder 的類(lèi)。

@Data
@Builder
public class User {
    private String name;
    private Integer age;
}

嘗試在其他地方使用無(wú)參構(gòu)造

User user = new User(); // 編譯錯(cuò)誤：找不到符號(hào) User()

原因分析

• @Data 會(huì)生成一個(gè) @RequiredArgsConstructor。如果類(lèi)中沒(méi)有 final 或@NonNull 的字段，這個(gè)構(gòu)造器就是無(wú)參的。此時(shí)，單獨(dú)使用 @Data 是完全可以無(wú)參構(gòu)造的。
• @Builder 注解需要基于一個(gè)全參構(gòu)造函數(shù)來(lái)工作。當(dāng)它發(fā)現(xiàn)你沒(méi)有顯式提供任何構(gòu)造器時(shí)，它會(huì)主動(dòng)生成一個(gè)私有的、包含所有字段的全參構(gòu)造函數(shù)。
• @Builder 的生成行為取代了 @Data 生成 @RequiredArgsConstructor 的邏輯。最終，編譯后的類(lèi)中只剩下 @Builder 生成的私有全參構(gòu)造器，導(dǎo)致無(wú)參構(gòu)造器確實(shí)“消失”了。

解決方案

顯式聲明所需的全部構(gòu)造器，避免 Lombok 的默認(rèn)行為產(chǎn)生沖突。

@Data
@Builder
@NoArgsConstructor // 顯式指定：我需要無(wú)參構(gòu)造
@AllArgsConstructor // 顯式指定：我需要全參構(gòu)造（讓Builder直接使用這個(gè)現(xiàn)成的）
public class User {
    private String name;
    private Integer age;
}

陷阱二：字段默認(rèn)值（初始化）失效

復(fù)現(xiàn)步驟

編寫(xiě)一個(gè)帶有字段默認(rèn)值的類(lèi)并使用 Builder。

@Data
@Builder
public class Order {
    private Long id;
    private String status = "open"; // 期望的默認(rèn)值
}

使用 Builder 創(chuàng)建對(duì)象，但不設(shè)置 status 字段。

Order order = Order.builder().id(1L).build();
System.out.println(order.getStatus()); // 輸出：null (預(yù)期是 "open")

原因分析

• 字段的默認(rèn)值 = "open"是在類(lèi)的構(gòu)造函數(shù)內(nèi)部執(zhí)行的。
• @Builder 的 build() 方法本質(zhì)上是調(diào)用了類(lèi)的全參構(gòu)造函數(shù)，并將 Builder 對(duì)象內(nèi)部的字段值作為參數(shù)傳入。關(guān)鍵點(diǎn)在于：構(gòu)造函數(shù)會(huì)無(wú)條件使用傳入的參數(shù)。
• 如果你沒(méi)有調(diào)用 .status(…) 方法，Builder 對(duì)象內(nèi)部的 status 字段值就是 null。在調(diào)用 build() 時(shí)，執(zhí)行的是 new Order(id, status)，這個(gè) null 被傳入了構(gòu)造函數(shù)，完全覆蓋了類(lèi)定義中 = “open” 的初始化操作。

解決方案

使用 Lombok 提供的 @Builder.Default 注解。

@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
public class Order {
    private Long id;
    
    @Builder.Default // 使用此注解標(biāo)記
    private String status = "open";
}

@Builder.Default 的原理：

• 它會(huì)指示 Lombok 在生成的 Builder 類(lèi)中，預(yù)先將這個(gè)字段初始化為指定的默認(rèn)值。
• 如果后續(xù)沒(méi)有顯式設(shè)置該字段，build() 方法就會(huì)使用這個(gè)預(yù)先存在的默認(rèn)值，而不是 null。

總結(jié)

以上為個(gè)人經(jīng)驗(yàn)，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。

最新評(píng)論