問題概述

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

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

現(xiàn)象：當一個類同時使用 @Data 和 @Builder 后，原本可用的無參構(gòu)造函數(shù) new Entity() 突然不可用，編譯報錯。

陷阱二：字段默認值（初始化）失效

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

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

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

編寫一個同時使用 @Data 和 @Builder 的類。

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

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

User user = new User(); // 編譯錯誤：找不到符號 User()

原因分析

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

解決方案

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

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

陷阱二：字段默認值（初始化）失效

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

編寫一個帶有字段默認值的類并使用 Builder。

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

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

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

原因分析

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

解決方案

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

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

@Builder.Default 的原理：

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

總結(jié)

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

最新評論