使用Lombok @Builder注解导致默认值无效的问题

目录

• @Builder注解导致默认值无效
• 原因分析
• lombok@Builder忽略属性默认值的坑点
• 1. 简单使用
• 2. 默认值问题
• 3. 修改属性值

@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()方法，他不是直接修改原来的对象，而是将结果以新的对象返回，所以，我们这儿需要个对象接收修改之后的返回值。

上面的执行结果，也可以看出来，修改过之后，原来的对象的值并没有变化，但是新接收的这个对象是修改后的值

以上为个人经验，希望能给大家一个参考，也希望大家多多支持我们。