Lombok你也许不知道的 Builder 坑坑！

发表于

这是我参与11月更文挑战的第17天，活动详情查看：2021最后一次更文挑战

🤞 个人主页：@青Cheng序员石头

🤞 粉丝福利：加粉丝群 一对一问题解答，获取免费的丰富简历模板、提高学习资料等，做好新时代的卷卷王！

Lombok，使我们提供我们生产效率的一个强大的利器，其通过简单的注解来实现精简代码，消除冗长代码和提高开发效率的目的。我很喜欢使用的一个注解是@Builder，这个注解能让我很轻松的使用构造器模式，这篇文章记录如何在子类中使用@Builder避免一个常见的坑坑。

一、问题

对于下面这两个类，一个父类，一个子类。两个类都想使用@Builder注解，用于使用构造器模式去构造一个对象。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
java复制代码@Getter
@ToString
public class Parent {

    private long id;

    private String name;

    @Builder
    @Getter
    @ToString
    static class Child extends  Parent{
        private String value;
    }


}

当我们尝试编译上面的代码时，会报错，报错的内容如下。

1
ini复制代码无法将类 <包路径>.Parent中的构造器 Parent应用到给定类型;

这个原因是，这是由于Lombok未考虑父类的字段，而只考虑到当前子类的字段。

二、解决方案

解决办法有很多种，最简单的一种是我们在子类的构造函数中包含父类的字段，并且对构造函数使用@Builder的注解。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
java复制代码@Getter
@AllArgsConstructor
@ToString
public class Parent {

    private long id;

    private String name;

    @Getter
    @ToString
    static class Child extends  Parent{

        private String value;

        @Builder
        public Child(long id,String name,String value){
            super(id,name);
            this.value = value;
        }
    }
}

这种方式能解决上面的问题，但是如果我们想对父类使用@Builder的注解，如下面的代码所示。

1
2
3
4
5
6
7
java复制代码@Getter
@AllArgsConstructor
@ToString
@Builder
public class Parent {
...
}

编译的时候又会报另一个错误。

1
scss复制代码<包路径>.Child()无法覆盖<包路径>.Parent中的builder()

这个原因是，子类尝试申明具有跟父类相同名称的builder，说的通俗一定就是builder重名了。我们可以为子类替换一个构造器名字去解决这个问题,如下面的代码所示，为子类的Builder自定义一个名称。

1
2
3
4
5
java复制代码@Builder(builderMethodName = "childBuilder")
public Child(long id,String name,String value){
    super(id,name);
    this.value = value;
}

这个问题是解决了，机智的同学又会问了，那么如果我继承更深的层次呢，比如还有另外的类要继承Child类，也想使用Builder模式，怎么办呢？能想到最简单的办法就是像上面一样，将继承类的构造函数改写，支持父类所有的字段。

除了这个办法，还有什么简单快捷的方法呢？答案是Lombok本身提供了行之有效的解决办法。

三、更好的解决方案

Lombok1.18版引入了@SuperBuilder注解，使用这个注解同时注解父类和子类可以解决我们上面遇到的问题。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
scala复制代码@Getter
@AllArgsConstructor
@ToString
@SuperBuilder
public class Parent {

    private long id;

    private String name;

    @Getter
    @ToString
    @SuperBuilder
    static class Child extends  Parent{

        private String value;

    }

    @Getter
    @ToString
    @SuperBuilder
    static class ChildSChild extends  Child{

        private String personality;
    }
}

需要注意两点：

  1. @SuperBuilder 和@Builder在父类和子类中不能混用
  2. @SuperBuilder在所有的父类和子类中都必须使用上，缺一不可。

四、总结

使用Lombok的目的是为了提供我们工作效率，建议在使用这些便捷工具时，要仔细理解一下官方的解释说明，其实很多使用技巧和避坑指南都写在了官方文档上。

少年，没看够？点击石头的详情介绍，随便点点看看，说不定有惊喜呢？欢迎支持点赞/关注/评论，有你们的支持是我更文最大的动力，多谢啦！

本文转载自: 掘金

开发者博客 – 和开发相关的 这里全都有

0%