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

 更新时间:2022年08月27日 15:21:08   作者:凉茶方便面  
这篇文章主要介绍了使用Lombok @Builder注解导致默认值无效的问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教

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

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

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • JAVA回顾:封装,继承,多态

    JAVA回顾:封装,继承,多态

    这篇文章主要介绍了java封装继承多态,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2021-08-08
  • java中的日期时间类Date和SimpleDateFormat

    java中的日期时间类Date和SimpleDateFormat

    这篇文章主要介绍了java中的日期时间类Date和SimpleDateFormat,Date类的对象在Java中代表的是当前所在系统的此刻日期时间,说白了就是你计算机上现实的时间,需要的朋友可以参考下
    2023-09-09
  • Spring框架生成图片验证码实例

    Spring框架生成图片验证码实例

    验证码在很多地方都会遇到,实现的方法和形式也有很多,主要的目的就是为了安全,防止一些恶意的攻击等。今天在之前搭建好的一个spring框架上写了一个验证码的生成demo,我会贴出细节代码,但是spring的配置就不在介绍了,有需要的可以参考借鉴。
    2016-08-08
  • Java 反射类型Type的用法说明

    Java 反射类型Type的用法说明

    这篇文章主要介绍了Java 反射类型Type的用法说明,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-05-05
  • 详解如何使用Jersey客户端请求Spring Boot(RESTFul)服务

    详解如何使用Jersey客户端请求Spring Boot(RESTFul)服务

    本篇文章主要介绍了详解如何使用Jersey客户端请求Spring Boot(RESTFul)服务,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-01-01
  • Java如果在try里面执行return还会不会执行finally

    Java如果在try里面执行return还会不会执行finally

    这篇文章主要介绍了Java如果在try里面执行return,那么还会不会执行finally,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2021-01-01
  • Spring Boot如何通过CORS处理跨域问题

    Spring Boot如何通过CORS处理跨域问题

    这篇文章主要介绍了Spring Boot如何通过CORS处理跨域问题,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-04-04
  • springboot项目数据库密码如何加密

    springboot项目数据库密码如何加密

    在我们日常开发中,我们可能很随意把数据库密码直接明文暴露在配置文件中,今天就来聊聊在springboot项目中如何对数据库密码进行加密,感兴趣的可以了解一下
    2021-07-07
  • Java StringBuilder类原理及常用方法

    Java StringBuilder类原理及常用方法

    这篇文章主要介绍了Java StringBuilder类原理及常用方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-12-12
  • Java编程中最基础的文件和目录操作方法详解

    Java编程中最基础的文件和目录操作方法详解

    这篇文章主要介绍了Java编程中最基础的文件和目录操作方法详解,是Java入门学习中的基础知识,需要的朋友可以参考下
    2015-11-11

最新评论