当你在使用 Lombok 的 @Data 注解时,其实会有一些坑需要关注,今天就让我们来见识一下。
Lombok
先来简单介绍一下 Lombok ,其官方介绍如下:
Project Lombok makes java a spicier language by adding 'handlers' that know how to build and compile simple, boilerplate-free, not-quite-java code.
大致意思是 Lombok 通过增加一些"处理程序",可以让 Java 代码变得简洁、快速。
Lombok 提供了一系列的注解帮助我们简化代码,比如:
注解名称功能
@Setter自动添加类中所有属性相关的 set 方法
@Getter自动添加类中所有属性相关的 get 方法
@Builder使得该类可以通过 builder (建造者模式)构建对象
@RequiredArgsConstructor生成一个该类的构造方法,禁止无参构造
@ToString重写该类的toString()方法
@EqualsAndHashCode重写该类的equals()和hashCode()方法
@Data等价于上面的@Setter、@Getter、@RequiredArgsConstructor、@ToString、@EqualsAndHashCode
看起来似乎这些注解都很正常,并且对我们的代码也有一定的优化,那为什么说@Data注解存在坑呢?
@Data注解
内部实现
由上面的表格我们可以知道,@Data是包含了@EqualsAndHashCode的功能,那么它究竟是如何重写equals()和hashCode()方法的呢?
问题总结
对于父类是Object且使用了@EqualsAndHashCode(callSuper = true)注解的类,这个类由 Lombok 生成的equals()方法只有在两个对象是同一个对象时,才会返回 true ,否则总为 false ,无论它们的属性是否相同。
这个行为在大部分时间是不符合预期的,equals()失去了其意义。即使我们期望equals()是这样工作的,那么其余的属性比较代码便是累赘,会大幅度降低代码的分支覆盖率。
解决方法
1、用了@Data就不要有继承关系,类似 Kotlin 的做法。
2、自己重写equals(), Lombok 不会对显式重写的方法进行生成。
3、显式使用@EqualsAndHashCode(callSuper = true), Lombok 会以显式指定的为准。
总结
以上便是我在使用@Data时碰到的问题以及自己的一些思考,在现在的项目,我干脆不再使用该注解。如果你有什么想法,欢迎在下方留言。