一次 lombok 默认值为 null 的排查实践

背景

这周的某个晚上,同事喊我过去看个问题,大概是这样的:为了满足新的业务需求,对于A、B两种不同的内容,在页面呈现上必须区分出两套规则,一套是用户可以进行修改和删除的,一套是用户只能查看的。

很容易想到一种做法就是:VO(View Object) 新增 Boolean 字段,对于 A、B 两种内容,组装 VO 的时候 A 的该字段设为 false,B 的该字段设为 true,通过 MVC 的 model 和 view 交互时对它作个判断,页面的区分渲染就可以实现了。

但是,在测试的时候,他发现一个奇怪的现象,就是这个新增的字段值竟然是 null,以致于根本无法作判断了。我们先看下 VO 的代码:

@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
public class CommonVo {
    private Long id;
    private Integer status;
    @Builder.Default private Boolean readOnly = false; // 是否只读
}    

可以看到,在 CommonVO 中新增了名为 readOnly 的字段,并通过 lombok 注解 @Builder.Default 给它设置默认值为 false,而且这个 VO 类上也加了 lombok 注解,可以说一应俱全,乍一看没有任何问题,可为什么不行呢?

我们再看看组装 VO 的时候,是怎么实例化对象的:

CommonVO vo = new CommonVO();

哦,原来是用这种传统的实例化方式啊,那 new 一个无参构造函数,默认值就丢失了?

原因

我们直接编译一下 java 文件,看看 CommonVO 的 class 文件里面的无参构造函数是怎样的:

public CommonVo() {
}

无参构造函数体内竟然没有 this.readOnly = false; 这一行代码,那显而易见地,默认值根本就不会生效嘛。

然后再往下看,肯定是有一个 Builder 的构建器,没错在这里。为了划重点,我把 class 内容拷贝成文本后加了三个注解,代码如下:

public static class CommonVOBuilder {
    private Long id;
    private Integer status;
    private boolean readOnly$set;  // 重点关注①
    private Boolean readOnly;

    CommonVOBuilder() {
    }

    public CommonVO.CommonVOBuilder id(final Long id) {
        this.id = id;
        return this;
    }

    public CommonVO.CommonVOBuilder status(final Integer status) {
        this.status = status;
        return this;
    }

    public CommonVO.CommonVOBuilder readOnly(final Boolean readOnly) {
        this.readOnly = readOnly;
        this.readOnly$set = true;  // 重点关注②
        return this;
    }
    // 重点关注③
    public CommonVO build() {
        return new CommonVO(this.id, this.status, this.readOnly$set ? this.readOnly : CommonVO.$default$readOnly());
    }

    public String toString() {
        return "CommonVO.CommonVOBuilder(id=" + this.id + ", status=" + this.status + ", readOnly=" + this.readOnly + ")";
    }
}

可以看到,通过 lombok 编译后生成的 CommonVOBuilder 类会多出一个 readOnly$set 字段,这个字段的作用就是用来判断是否设置成默认值。譬如,在对象实例化的时候,如果设置了 readOnly 的值为 true,那么readOnly$set 就会被设为 true,调用 build() 方法之后,就会有一个三目运算符运算来决定它应该为 true 而不是默认值 false。这里的 CommonVO.$default$readOnly() 方法体内就一行代码,返回默认值:

private static Boolean $default$readOnly() {
    return false; // 这个false就是定义readOnly设置的默认值
}

如果我们从 POJO 的定义加上 lombok 注解,到对象实例化都用 lombok 的同一套风格来行事,肯定就不会出这岔子。

解决方案

那就直接把

CommonVO vo = new CommonVO();

改为

CommonVO vo = CommonVO().builder().build();

嗯,非常好!这是最规范的写法,lombok 官网也推荐。

但是现实情况是:由于历史原因,项目中好多处都是直接 new 的形式来创建的,如果都按这种方式改,一是怕改漏了,二是怕改出问题。

有没有一种折中的办法,默认值无论是通过 new 方式还是 Builder().build() 方式都能正常使用呢?

好吧,既然要这种骚操作,那就再来一波探索。

首先一个问题就是:为什么 lombok 的无参构造函数没有帮我们设置默认值?

我看了下项目的 pom.xml 里面 lombok 的 dependency 是这样的:

image

没指定 version,再往父依赖找:

image

原来依赖的是 spring boot,在这个 pox 文件往上翻找查到具体版本:

image

然后我搜索了一下 maven 仓库,目前最高的是 1.18.8,抱着尝试的心态直接指定 lombok 的 version 为最新版,编译:

package com.example.demo.mock;
import com.example.demo.vo.CommonVO;
/**
 * @author Jessehuang
 */
public class LombokDefaultValTest {
    public static void main(String[] args) {
        CommonVO vo = new CommonVO();
        System.out.println(vo);
        CommonVO vo2 = CommonVO.builder().build();
        System.out.println(vo2);
    }
}

结果:

CommonVO(id=null, status=null, readOnly=false)
CommonVO(id=null, status=null, readOnly=false)

OK,可行!然后出于好奇心,我想知道到底是哪个版本开始支持的。多尝试了几个,发现 1.18.2 这个版本修正了这个问题,如果不信你可以把 lombok 的依赖指定为 1.18.2,再编译看看 class 文件就知道了。

另外,lombok 的 GitHub 的 issues 在2017年就有人提出这个问题,一年之后才得以修正。

如果不给 lombok 指定版本,还是依赖 spring boot 帮你指定,那必须把 spring boot 升级到 v2.1.0.M2 版本及以上才行,你可以在 spring boot 的 GitHub Releases 发版流水线的 Dependency upgrades 看到这个升级。

总结

总而言之,我们通过升级 lombok 版本的方式解决了默认值为 null 的问题。

其实 lombok 在帮我们减少 POJO 冗余编码的同时,也给我们带来了一些困扰。比如首字母小写第二个字母大写的命名方式就会造成 Jackson 失败问题、低版本默认值通过 new 方式初始化会为 null 的问题。

建议在编码的时候,不要交叉着使用上面两种实例化方式,这个必须要在团队中达成共识。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 196,165评论 5 462
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 82,503评论 2 373
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 143,295评论 0 325
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,589评论 1 267
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,439评论 5 358
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,342评论 1 273
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,749评论 3 387
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,397评论 0 255
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,700评论 1 295
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,740评论 2 313
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,523评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,364评论 3 314
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,755评论 3 300
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,024评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,297评论 1 251
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,721评论 2 342
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,918评论 2 336

推荐阅读更多精彩内容