使用Lombok @Builder注解導(dǎo)致默認(rèn)值無(wú)效的問(wèn)題

更新時(shí)間：2022年08月27日 15:21:08 作者：涼茶方便面

這篇文章主要介紹了使用Lombok @Builder注解導(dǎo)致默認(rèn)值無(wú)效的問(wèn)題，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教

@Builder注解導(dǎo)致默認(rèn)值無(wú)效

使用Lombok注解可以極高的簡(jiǎn)化代碼量，比較好用的注解除了@Data之外，還有@Builder這個(gè)注解，它可以讓你很方便的使用builder模式構(gòu)建對(duì)象，但是今天發(fā)現(xiàn)@Builder注解會(huì)把對(duì)象的默認(rèn)值清掉。

像下面這段代碼，會(huì)導(dǎo)致對(duì)象的name屬性變?yōu)閚ull：

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());
? ? }
}
---打印結(jié)果---
null

那么不想讓這個(gè)默認(rèn)值被清除，就只能用另外一個(gè)注解來(lái)對(duì)屬性進(jìn)行設(shè)置：@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());
? ? }
}
---打印結(jié)果---
1232

需要注意的是@lombok.Builder.Default這個(gè)注解是后來(lái)才有的，目前已知的是1.2.X沒有，1.6.X中有這個(gè)注解。

原因分析

使用@Builder注解的代碼如下：

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

Lombok會(huì)生成如下代碼：

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沒有默認(rèn)值，導(dǎo)致build之后的Example的name是Null值。

lombok@Builder忽略屬性默認(rèn)值的坑點(diǎn)

1. 簡(jiǎn)單使用

他這個(gè)@Builder注解，相比之前的編輯器自動(dòng)生成的getter setter的優(yōu)點(diǎn)在哪呢？

看下面的使用例子

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

運(yùn)行結(jié)果：

它相比編輯器生成的getter setter的優(yōu)點(diǎn)：

1，代碼很清晰，可讀。可以很明確的知道，你的每一個(gè)屬性的設(shè)置，

2，還有就是鏈?zhǔn)奖磉_(dá)式，一串的就給set屬性了，不需要寫n行代碼，之前自動(dòng)生成的getter和setter，都需要寫一個(gè)對(duì)象，然后再一個(gè)個(gè)的去點(diǎn)每一個(gè)屬性的設(shè)置方法，

我例子里面的那個(gè)全參數(shù)構(gòu)造方法，乍一看，看不出來(lái)每個(gè)參數(shù)是啥意思，但是下面的builder就很清楚的知道設(shè)置的都是啥。

代碼使用的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 = "內(nèi)容是json字符串的屬性", jsonDirect = true)    
private String dog1;     
@JSONField(ordinal = 5, name = "內(nèi)容是json字符串的屬性,對(duì)比下差異")    
private String dog2;     
/**     * ordinal，默認(rèn)值為0，不用設(shè)置啦。     */    
@JSONField(ordinal = 4, name = "生產(chǎn)日期", format = "yyyy年MM月dd日 HH時(shí)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，那么在反序列化的時(shí)候，就不會(huì)把json的值轉(zhuǎn)給對(duì)象的這個(gè)屬性。     */    
@JSONField(name = "名稱", deserialize = false)    
private String name;    
/**     * 不序列化此屬性字段，那么在轉(zhuǎn)json的時(shí)候，就不會(huì)在json中出現(xiàn)     */    
@JSONField(ordinal = 7, name = "不序列化的屬性字段", serialize = false)    
private String deserialize;  
}