使用Lombok @Builder註解導致預設值無效的問題

2022-08-27 22:07:12

@Builder註解導致預設值無效

使用Lombok註解可以極高的簡化程式碼量，比較好用的註解除了@Data之外，還有@Builder這個註解，它可以讓你很方便的使用builder模式構建物件，但是今天發現@Builder註解會把物件的預設值清掉。

像下面這段程式碼，會導致物件的name屬性變為null：

public class BuilderTest {
    @lombok.Builder
    @lombok.Data
    private static class Builder {
        private String name = "1232";
    }
    @Test
    public void test() {
        Builder builder = Builder.builder().build();
        System.out.println(builder.getName());
    }
}
---列印結果---
null

那麼不想讓這個預設值被清除，就只能用另外一個註解來對屬性進行設定：@lombok.Builder.Default

範例程式碼如下：

public class BuilderTest {
    @lombok.Builder
    @lombok.Data
    private static class Builder {
        @lombok.Builder.Default
        private String name = "1232";
    }
    @Test
    public void test() {
        Builder builder = Builder.builder().build();
        System.out.println(builder.getName());
    }
}
---列印結果---
1232

需要注意的是@lombok.Builder.Default這個註解是後來才有的，目前已知的是1.2.X沒有，1.6.X中有這個註解。

原因分析

使用@Builder註解的程式碼如下：

@lombok.Builder
class Example {
    private String name = "123";
}

Lombok會生成如下程式碼：

class Example {
    private String name;
    private Example(String name) {
        this.name = name;
    }
    public static ExampleBuilder builder() {
        return new ExampleBuilder();
    }
    public static class ExampleBuilder {
        private String name;
        private ExampleBuilder() {}
        public ExampleBuilder name(String name) {
            this.name = name;
            return this;
        }
        @java.lang.Override public String toString() {
            return "Example(name = " + name + ")";
        }
        public Example build() {
            return new Example(name);
        }
    }
}

很顯然，ExampleBuilder的name沒有預設值，導致build之後的Example的name是Null值。

lombok@Builder忽略屬性預設值的坑點

1. 簡單使用

他這個@Builder註解，相比之前的編輯器自動生成的getter setter的優點在哪呢？

看下面的使用例子

package com.lxk.lombok; import com.lxk.model.Bird; import java.util.Date; 
/** * 測試@Builder * * @author LiXuekai on 2019/5/13 */public class BuilderTest {    
public static void main(String[] args) {        
Bird bird = new Bird("12", "34", new Date(), "紅色面板", "巨大無比", 18, "典韋", "不序列化的欄位，是不會被轉json輸出的");        
Bird build = Bird.builder().dog1("12").dog2("34").birthday(new Date())                
.color("紅色面板").size("巨大無比").age(18)                
.name("典韋").deserialize("不序列化的欄位，是不會被轉json輸出的").build();        
System.out.println(build.toString());        
System.out.println(bird.toString());    
}}

執行結果：

它相比編輯器生成的getter setter的優點：

1，程式碼很清晰，可讀。可以很明確的知道，你的每一個屬性的設定，

2，還有就是鏈式表示式，一串的就給set屬性了，不需要寫n行程式碼，之前自動生成的getter和setter，都需要寫一個物件，然後再一個個的去點每一個屬性的設定方法，

我例子裡面的那個全引數構造方法，乍一看，看不出來每個引數是啥意思，但是下面的builder就很清楚的知道設定的都是啥。

程式碼使用的model bean的程式碼

package com.lxk.model; 
import com.alibaba.fastjson.annotation.JSONField;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;import lombok.NoArgsConstructor; 
import java.io.Serializable;
import java.util.Date; 
/** * 鳥 * * @author LiXuekai on 2018/10/25 */
@Data@NoArgsConstructor@AllArgsConstructor@Builderpublic class Bird implements Serializable {    
    private static final long serialVersionUID = 1L;     
@JSONField(ordinal = 6, name = "內容是json字串的屬性", jsonDirect = true)    
private String dog1;     
@JSONField(ordinal = 5, name = "內容是json字串的屬性,對比下差異")    
private String dog2;     
/**     * ordinal，預設值為0，不用設定啦。     */    
@JSONField(ordinal = 4, name = "生產日期", format = "yyyy年MM月dd日 HH時mm分ss秒")    
private Date birthday;     @JSONField(ordinal = 3, name = "顏色")    
private String color;     @JSONField(ordinal = 2, name = "體型大小")    
private String size;     @JSONField(ordinal = 1, name = "年齡")    
private int age;    
/**     * 反序列化false，那麼在反序列化的時候，就不會把json的值轉給物件的這個屬性。     */    
@JSONField(name = "名稱", deserialize = false)    
private String name;    
/**     * 不序列化此屬性欄位，那麼在轉json的時候，就不會在json中出現     */    
@JSONField(ordinal = 7, name = "不序列化的屬性欄位", serialize = false)    
private String deserialize;  
}