博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
使用Lombok插件需要注意的问题
阅读量:6278 次
发布时间:2019-06-22

本文共 15713 字,大约阅读时间需要 52 分钟。

一、@Data注解

@Data注解相当于@Getter @Setter @RequiredArgsConstructor @ToString @EqualsAndHashCode这5个注解的合集。

通过官方文档,可以得知,当使用@Data注解时,则有了@EqualsAndHashCode注解,那么就会在此类中存在equals(Object other) 和 hashCode()方法,且不会使用父类的属性。

如果两个对象的属性相同,就会认为这两个对象相等,即重写了hashCode和equls方法。

解决:

  使用@Getter @Setter 代替@Data 或者在该类中重写equals与hashcode方法。

  需要注意的是:如果使用@Data 注解,那么使用Set集合去重机制也会受到影响。因为Set集合去重原理底层就是用的hashmap集合。由于hashcode与equals方法已经被重写,所以会即使是两个new出来的不同的对象,但是属性相同的情况下也会返回true。

SysUserEntity user1 = new SysUserEntity(1,"张三",0);SysUserEntity user2 = new SysUserEntity(1,"张三",0);

二、@Builder注解的使用

1、初入认识

如果对建造者设计模式不太清楚的,可以先了解一下:建造者模式

@Builder注释为你的类生成相对略微复杂的构建器API。@Builder可以让你以下面显示的那样调用你的代码,来初始化你的实例对象:

Person.builder()    .name("Adam Savage")    .city("San Francisco")    .job("Mythbusters")    .job("Unchained Reaction")    .build();

@Builder可以放在类,构造函数或方法上。 虽然放在类上和放在构造函数上这两种模式是最常见的用例,但@Builder最容易用放在方法的用例来解释。

使用@Builder注释的方法可以帮助我们完成一下一些事情:

  • 一个名为xxxBuilder的内部静态类,并具有和实体类形同的属性(称为构建器)。

  • 在构建器中:对于目标类中的所有的属性和未初始化的final字段,都会在构建器中创建对应属性;

  • 在构建器中:创建一个无参的default构造函数。

  • 在构建器中:对于实体类中的每个参数,都会对应创建类似于“setter”的方法,只不多方法名与该参数名相同。 并且返回值是构建器本身(便于链式调用),如上例所示。

  • 在构建器中:一个build()方法,调用此方法,就会根据设置的值进行创建实体对象。

  • 在构建器中:同时也会生成一个toString()方法。

  • 在实体类中:会创建一个builder()方法,它的目的是用来创建构建器。

@Builderpublic class User {    private String username;    private String password;}// 编译后:public class User {    private String username;    private String password;    User(String username, String password) {        this.username = username; this.password = password;    }    public static User.UserBuilder builder() {        return new User.UserBuilder();    }    public static class UserBuilder {        private String username;        private String password;        UserBuilder() {}        public User.UserBuilder username(String username) {            this.username = username;            return this;        }        public User.UserBuilder password(String password) {            this.password = password;            return this;        }        public User build() {            return new User(this.username, this.password);        }        public String toString() {            return "User.UserBuilder(username=" + this.username + ", password=" + this.password + ")";        }    }}

2、@Builder 中使用 @Singular 注释集合

@Builder也可以为集合类型的参数或字段生成一种特殊的方法。 它采用修改列表中一个元素而不是整个列表的方式,可以是增加一个元素,也可以是删除一个元素。 例如:

Person.builder()    .job("Mythbusters")    .job("Unchained Reaction")    .build();

这样就可以轻松地将List <String>字段中包含2个字符串。 但是想要这样来操作集合,你需要使用@Singular来注释字段或参数。

在使用@Singular注释注释一个集合字段(使用@Builder注释类),lombok会将该构建器节点视为一个集合,并生成两个adder方法而不是setter方法。

  • 一个向集合添加单个元素,

  • 一个将另一个集合的所有元素添加到集合中。

将不生成仅设置集合(替换已添加的任何内容)的setter。 还生成了clear方法。 这些singular构建器相对而言是有些复杂的,主要是来保证以下特性:

  • 在调用build()时,生成的集合将是不可变的。

  • 在调用build()之后调用其中一个adder方法或clear方法不会修改任何已经生成的对象。如果对集合修改之后,再调用build(),则会创建一个基于上一个对象创建的对象实体。

  • 生成的集合将被压缩到最小的可行格式,同时保持高效。

@Singular只能应用于lombok已知的集合类型。目前,支持的类型有:

  • java.util:

    Iterable, Collection, 和List (一般情况下,由压缩的不可修改的ArrayList支持).

    Set, SortedSet, and NavigableSet (一般情况下,生成可变大小不可修改的HashSet或者TreeSet).
    Map, SortedMap, and NavigableMap (一般情况下,生成可变大小不可修改的HashMap或者TreeMap).

  • Guava’s com.google.common.collect:

    ImmutableCollection and ImmutableList

    ImmutableSet and ImmutableSortedSet
    ImmutableMap, ImmutableBiMap, and ImmutableSortedMap
    ImmutableTable
再来看看使用了@Singular注解之后的编译情况:

@Builderpublic class User {    private final Integer id;    private final String zipCode = "215500";    private String username;    private String password;    @Singular    private List
hobbies;}// 编译后:public class User { private final Integer id; private final String zipCode = "215500"; private String username; private String password; private List
hobbies; User(Integer id, String username, String password, List
hobbies) { this.id = id; this.username = username; this.password = password; this.hobbies = hobbies; } public static User.UserBuilder builder() {
return new User.UserBuilder();} public static class UserBuilder { private Integer id; private String username; private String password; private ArrayList
hobbies; UserBuilder() {} public User.UserBuilder id(Integer id) { this.id = id; return this; } public User.UserBuilder username(String username) { this.username = username; return this; } public User.UserBuilder password(String password) { this.password = password; return this; } public User.UserBuilder hobby(String hobby) { if (this.hobbies == null) { this.hobbies = new ArrayList(); } this.hobbies.add(hobby); return this; } public User.UserBuilder hobbies(Collection
hobbies) { if (this.hobbies == null) { this.hobbies = new ArrayList(); } this.hobbies.addAll(hobbies); return this; } public User.UserBuilder clearHobbies() { if (this.hobbies != null) { this.hobbies.clear(); } return this; } public User build() { List hobbies; switch(this.hobbies == null ? 0 : this.hobbies.size()) { case 0: hobbies = Collections.emptyList(); break; case 1: hobbies = Collections.singletonList(this.hobbies.get(0)); break; default: hobbies = Collections.unmodifiableList(new ArrayList(this.hobbies)); } return new User(this.id, this.username, this.password, hobbies); } public String toString() { return "User.UserBuilder(id=" + this.id + ", username=" + this.username + ", password=" + this.password + ", hobbies=" + this.hobbies + ")"; } }}

其实,lombok的创作者还是很用心的,在进行build()来床建实例对象时,并没有直接使用Collections.unmodifiableList(Collection)此方法来床架实例,而是分为三种情况:

  • 第一种,当集合中没有元素时,创建一个空list;

  • 第二种情况,当集合中存在一个元素时,创建一个不可变的单元素list;

  • 第三种情况,根据当前集合的元素数量创建对应合适大小的list;

当然我们看编译生成的代码,创建了三个关于集合操作的方法:

  • hobby(String hobby):向集合中添加一个元素

  • hobbies(Collection<? extends String> hobbies):添加一个集合所有的元素

  • clearHobbies():清空当前集合数据

3、@Singular 注解配置详解

我们先来看看 @Singular 注解的详情:

@Target({FIELD, PARAMETER})@Retention(SOURCE)public @interface Singular {    // 修改添加集合元素的方法名    String value() default "";}

测试如何使用注解属性vlaue

@Builderpublic class User {    private final Integer id;    private final String zipCode = "215500";    private String username;    private String password;    @Singular(value = "testHobbies")    private List
hobbies;}// 测试类public class BuilderTest { public static void main(String[] args) { User user = User.builder() .testHobbies("reading") .testHobbies("chatting") .id(1) .password("jdkong") .username("jdkong") .build(); System.out.println(user); }}

说明,当我们使用了注解属性value之后,我们在使用添加集合元素时的方法名发生相应的改变。但是,同时生成的添加整个集合的方法名发生改变了吗?我们再来看看编译后的代码:

// 编译后:public class User {    // 省略部分代码,只看关键部分    public static class UserBuilder {        public User.UserBuilder testHobbies(String testHobbies) {            if (this.hobbies == null) {                this.hobbies = new ArrayList();            }            this.hobbies.add(testHobbies);            return this;        }        public User.UserBuilder hobbies(Collection
hobbies) { if (this.hobbies == null) { this.hobbies = new ArrayList(); } this.hobbies.addAll(hobbies); return this; } public User.UserBuilder clearHobbies() { if (this.hobbies != null) { this.hobbies.clear(); } return this; } }}

可以看到,只有添加一个元素的方法名发生了改变。

4、@Builder.Default 使用

比如有这样一个实体类:

@Builder@ToStringpublic class User {    @Builder.Default    private final String id = UUID.randomUUID().toString();    private String username;    private String password;    @Builder.Default    private long insertTime = System.currentTimeMillis();}

 在类中我在idinsertTime上都添加注解@Builder.Default,当我在使用这个实体对象时,我就不需要在为这两个字段进行初始化值,如下面这样:

public class BuilderTest {    public static void main(String[] args) {        User user = User.builder()                .password("jdkong")                .username("jdkong")                .build();        System.out.println(user);    }}// 输出内容:User(id=416219e1-bc64-43fd-b2c3-9f8dc109c2e8, username=jdkong, password=jdkong, insertTime=1546869309868)

lombok在实例化对象时就为我们初始化了这两个字段值。

当然,你如果再对这两个字段进行设值的话,那么默认定义的值将会被覆盖掉,如下面这样:

public class BuilderTest {    public static void main(String[] args) {        User user = User.builder()                .id("jdkong")                .password("jdkong")                .username("jdkong")                .build();        System.out.println(user);    }}// 输出内容User(id=jdkong, username=jdkong, password=jdkong, insertTime=1546869642151)

5、@Builder 详细配置

下面我们再来详细看看@Builder这个注解类地详细实现:

@Target({TYPE, METHOD, CONSTRUCTOR})@Retention(SOURCE)public @interface Builder {    // 如果@Builder注解在类上,可以使用 @Builder.Default指定初始化表达式    @Target(FIELD)    @Retention(SOURCE)    public @interface Default {}    // 指定实体类中创建 Builder 的方法的名称,默认为: builder (个人觉得没必要修改)    String builderMethodName() default "builder";    // 指定 Builder 中用来构件实体类的方法的名称,默认为:build (个人觉得没必要修改)    String buildMethodName() default "build";    // 指定创建的建造者类的名称,默认为:实体类名+Builder    String builderClassName() default "";    // 使用toBuilder可以实现以一个实例为基础继续创建一个对象。(也就是重用原来对象的值)    boolean toBuilder() default false;        @Target({FIELD, PARAMETER})    @Retention(SOURCE)    public @interface ObtainVia {        // 告诉lombok使用表达式获取值        String field() default "";        // 告诉lombok使用表达式获取值        String method() default "";        boolean isStatic() default false;    }}

  以上注解属性,我只测试一个比较常用的toBuilder,因为我们在对实体对象进行操作时,往往会存在对某些实体对象的某个字段进行二次赋值,这个时候就会用到这一属性。但是,这会创建一个新的对象,而不是原来的对象,原来的对象属性是不可变的,除非你自己想要给这个实体类再添加上@Data或者@setter方法(我是这么干过,哈哈)。下面就来测试一下:

@Builder(toBuilder = true)@ToStringpublic class User {    private String username;    private String password;}// 测试类public class BuilderTest {    public static void main(String[] args) {        User user1 = User.builder()                .password("jdkong")                .username("jdkong")                .build();        System.out.println(user1);        User user2 = user1.toBuilder().username("jdkong2").build();        // 验证user2是否是基于user1的现有属性创建的        System.out.println(user2);        // 验证对象是否是同一对象        System.out.println(user1 == user2);    }}// 输出内容User(username=jdkong, password=jdkong)User(username=jdkong2, password=jdkong)false

6、@Builder注解对初始化的影响

先上结论:

  如果类中用了@Builder注解,而属性没有任何注解话,那么在你初始化这个类的时候,如果你的属性赋值了默认值,则在你初始化该类后,属性的默认值则无效即获取会产生空指针异常。

接下来我们来看看这中间发生了什么

  从上面的例子,可以发现Teacher 的address属性为空,这正是我们很常规初始化操作,获取这个address,接着对它进行操作, 如果此时它是null,则会出现空指针异常;
  比较Student中的address则是我们理想中的正常执行过程,是有一个默认值的对象,同时观察Student中的name 和age两个属性值默认值也出现了如同Teacher中的address现象,默认值消失了;

  从表面来看,Student多了@Builder.Default的注解,这个注解确实就是解决这个问题关键,让你想要赋值的默认值来进行正确的初始化了。知道了这个注解的使用只是做到了知其然,我们要做做知其所以然,所以来看看下他们生成的class有什么区别? 以下代码反编译删除了equal和hashcode方法。

Teacher.class

public class Teacher {private String name;private List
address = new ArrayList();Teacher(String name, List
address) { this.name = name; this.address = address;}public static Teacher.TeacherBuilder builder() { return new Teacher.TeacherBuilder();}public String getName() { return this.name;}public List
getAddress() { return this.address;}public void setName(String name) { this.name = name;}public void setAddress(List
address) { this.address = address;}protected boolean canEqual(Object other) { return other instanceof Teacher;}public String toString() { return "Teacher(name=" + this.getName() + ", address=" + this.getAddress() + ")";}public static class TeacherBuilder { private String name; private List
address; TeacherBuilder() { } public Teacher.TeacherBuilder name(String name) { this.name = name; return this; } public Teacher.TeacherBuilder address(List
address) { this.address = address; return this; } public Teacher build() { return new Teacher(this.name, this.address); } public String toString() { return "Teacher.TeacherBuilder(name=" + this.name + ", address=" + this.address + ")"; }}
View Code

Student.class

public class Student {private String name = "c";private int age = 25;private long num;private List
address;private static List
$default$address() { return new ArrayList();}Student(String name, int age, long num, List
address) { this.name = name; this.age = age; this.num = num; this.address = address;}public static Student.StudentBuilder builder() { return new Student.StudentBuilder();}public String getName() { return this.name;}public int getAge() { return this.age;}public long getNum() { return this.num;}public List
getAddress() { return this.address;}public void setName(String name) { this.name = name;}public void setAge(int age) { this.age = age;}public void setNum(long num) { this.num = num;}public void setAddress(List
address) { this.address = address;}protected boolean canEqual(Object other) { return other instanceof Student;} public String toString() { return "Student(name=" + this.getName() + ", age=" + this.getAge() + ", num=" + this.getNum() + ", address=" + this.getAddress() + ")";}public static class StudentBuilder { private String name; private int age; private long num; private boolean address$set; private List
address; StudentBuilder() { } public Student.StudentBuilder name(String name) { this.name = name; return this; } public Student.StudentBuilder age(int age) { this.age = age; return this; } public Student.StudentBuilder num(long num) { this.num = num; return this; } public Student.StudentBuilder address(List
address) { this.address = address; this.address$set = true; return this; } public Student build() { List address = this.address; if(!this.address$set) { address = Student.$default$address(); } return new Student(this.name, this.age, this.num, address); } public String toString() { return "Student.StudentBuilder(name=" + this.name + ", age=" + this.age + ", num=" + this.num + ", address=" + this.address + ")"; }}
View Code
  看两个类的build方法,Student类在调用builde方法时,会判断this.address$set 这个变量是否为false,如果为false,则为这个address对象进行赋值默认值,这个变量就是由@Builder.Default注解产生的.
  而如果你直接对address方法进行赋值话,则会将这个this.address$set进行赋值,这样调用build方法时,就不会再对address进行赋值了.
  比较Teacher,没有对address属性增加@Builder.Default注解,所以在调用build方法时候,就不会产生判断是否要对address进行默认值的初始化了,所以你获取到的address就是null。

7、lombok 子类中如何使用@Builder

在使用@Builder过程中,有一个问题:子类的Builder对象没有父类的属性。这在使用上造成了一定的问题。

几番搜索,对于这个问题,找到了如下解法,解法的链接会放到文末。 

  1. 对于父类,使用@AllArgsConstructor注解 
  2. 对于子类,手动编写全参数构造器,内部调用父类全参数构造器,在子类全参数构造器上使用@Builder注解。

通过这种方式,子类Builder对象可以使用父类的所有私有属性。

但是这种解法也有两个副作用: 

1. 因为使用AllArgsConstructor注解,父类构造函数字段的顺序由声明字段的顺序决定,如果子类构造函数传参的时候顺序不一致,字段类型还一样的话,出了错不好发现 。
2. 如果父类字段有增减,所有子类的构造器都要修改。

虽然有这两个副作用,但是这种解法是我找到的唯一一种解决子类使用@Builder,能使用父类属性的方式。

参考博客: 

 
副作用见博客评论

8、@Builder 全局配置

# 是否禁止使用@Builderlombok.builder.flagUsage = [warning | error] (default: not set)#是否使用Guaualombok.singular.useGuava = [true | false] (default: false)# 是否自动使用singular,默认是使用lombok.singular.auto = [true | false] (default: true)

 

 

 

参考文章:

 

转载于:https://www.cnblogs.com/java-jun-world2099/articles/11097359.html

你可能感兴趣的文章
Mcad学习笔记之异步编程(AsyncCallback委托,IAsyncResult接口,BeginInvoke方法,EndInvoke方法的使用小总结)...
查看>>
Javascript防冒泡事件与Event对象
查看>>
managed domain与unmanaged domain
查看>>
《设计模式解析(第2版•修订版)》目录—导读
查看>>
Java核心技术卷I基础知识3.5.3 强制类型转换
查看>>
可与Mirai比肩的恶意程序Hajime,竟是为了保护IoT设备?
查看>>
《Spring Data 官方文档》6. Cassandra 存储库
查看>>
聊聊并发(十)生产者消费者模式
查看>>
R语言数据挖掘2.2.4.2 FP-growth算法
查看>>
人工智能概念诞生60年,哪些大牛堪称“一代宗师”?
查看>>
《游戏大师Chris Crawford谈互动叙事》一9.5 真实案例
查看>>
Java Cache系列之Guava Cache实现详解
查看>>
设计模式 - 适配器
查看>>
CSS之可折叠导航
查看>>
淘宝美工设计师细说何为天猫透明背景
查看>>
【B/S学习总结】我的第100篇CSDN博客
查看>>
[Hadoop]chukwa与ganglia的区别
查看>>
数据挖掘工具分析北京房价 (一) 数据爬取采集
查看>>
IOS项目之弹出动画终结篇
查看>>
iOS开发UI篇—ios应用数据存储方式(XML属性列表-plist)
查看>>