使用Lombok @Builder註解導致默認值無效的問題

Posted on by

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

2. 默認值問題

註意：默認值的情況。

如果原來的model bean 的屬性是設置有默認值的，比如下面的age屬性

然後，運行結果

@Builder默認是不支持默認值設置，或者說，自動忽略瞭model裡面設置的默認值。

怎麼讓他支持默認值的設置。

在有默認值的屬性上使用這個註解：@Builder.Default 

要是你的這個default不存在，那是因為你使用的這個Lombok的版本太低瞭，試著升級到1.18.4及以上。我使用的是1.18.8版本。

3. 修改屬性值

在model上加上這個註解參數：@Builder(toBuilder = true)

然後使用的時候，使用toBuilder()方法拿到builder

這個給人的感覺，類似String的replace()方法，他不是直接修改原來的對象，而是將結果以新的對象返回，所以，我們這兒需要個對象接收修改之後的返回值。

上面的執行結果，也可以看出來，修改過之後，原來的對象的值並沒有變化，但是新接收的這個對象是修改後的值

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

推薦閱讀：