最近做一个项目,发现实体类中仅仅只是定义了变量,没有任何setter,getter,方法,也没有构造函数,但是却可以正常的调用,仔细查看后发现类上比之前所见的类多了一些注解,@Date,@EqualsAndHashCode.经过多方查找,终于大概弄明白了,现在写出来一方面巩固自己所学,顺便供大家参考,有说的不好的地方,欢迎大家指出,共同进步...
一、Lombok是什么
现在看一下Lombok官方对其进行的解释：Lombok官网：https://projectlombok.org
Lombok项目是一种自动接通你的编辑器和构建工具的一个Java库。不用再一次写额外的getter或者equals方法。由此可以看出，lombok会帮我们自动生成getter和euqals方法,但是更有意思的是,当我们的变量发生改变时,我们不再需要修改对的getter、setter方法,lombok帮我们在运行的过程中自动生成上述方法,编码更灵活.
所以,使用lombok的优点: 1、简化long冗余的javabean代码;
2、提高执行效率
二、如何使用Lombok
1、引入依赖：（版本自行选择）
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.16.18</version>
<scope>provided</scope>
</dependency>有些情况下引入依赖还是不能使用（不能调用getter、setter），此时可以通过安装插件解决：
三、lombok中的常用注解
- @Setter ：在JavaBean或类JavaBean中使用，使用此注解会生成对应的setter方法；
- @Getter：在JavaBean或类JavaBean中使用，使用此注解会生成对应的getter方法；
- @ToString：在JavaBean或类JavaBean中使用，使用此注解会自动重写对应的toStirng方法；
- @NoArgsConstructor：在JavaBean或类JavaBean中使用，使用此注解会生成对应的无参构造方法；
- @HashCode：
- @Equals：
- @CanEqual：
- @Data：在JavaBean或类JavaBean中使用，这个注解包含范围最广，它包含上述注解，即当使用当前注解时，会自动生成包含的所有方法；
- @AllArgsConstructor：在JavaBean或类JavaBean中使用，使用此注解会生成对应的有参构造方法；
- @Log(这是一个泛型注解，具体有很多种形式)
- @EqualsAndHashCode：在JavaBean或类JavaBean中使用，使用此注解会自动重写对应的equals方法和hashCode方法；
1. 此注解会生成equals(Object other) 和 hashCode()方法。
2. 它默认使用非静态，非瞬态的属性
3. 可通过参数exclude排除一些属性
4. 可通过参数of指定仅使用哪些属性
5. 它默认仅使用该类中定义的属性且不调用父类的方法
6. 可通过callSuper=true解决上一点问题。让其生成的方法中调用父类的方法。
-
@Slf4j：在需要打印日志的类中使用，当项目中使用了slf4j打印日志框架时使用该注解，会简化日志的打印流程，只需调用info方法即可；
-
@Log4j：在需要打印日志的类中使用，当项目中使用了log4j打印日志框架时使用该注解，会简化日志的打印流程，只需调用info方法即可；
在使用以上注解需要处理参数时，处理方法如下（以@ToString注解为例，其他注解同@ToString注解）：
@ToString(exclude="column")
意义：排除column列所对应的元素，即在生成toString方法时不包含column参数；
@ToString(exclude={"column1","column2"})
意义：排除多个column列所对应的元素，其中间用英文状态下的逗号进行分割，即在生成toString方法时不包含多个column参数；
@ToString(of="column")
意义：只生成包含column列所对应的元素的参数的toString方法，即在生成toString方法时只包含column参数；；
@ToString(of={"column1","column2"})
意义：只生成包含多个column列所对应的元素的参数的toString方法，其中间用英文状态下的逗号进行分割，即在生成toString方法时只包含多个column参数；
@Date一般和@EqualsAndHashCode同时使用，因为：
通过官方文档，可以得知，当使用@Data注解时，则有了@EqualsAndHashCode注解，那么就会在此类中存在equals(Object other) 和 hashCode()方法，且不会使用父类的属性，这就导致了可能的问题。
比如，有多个类有相同的部分属性，把它们定义到父类中，恰好id（数据库主键）也在父类中，那么就会存在部分对象在比较时，它们并不相等，却因为lombok自动生成的equals(Object other) 和 hashCode()方法判定为相等，从而导致出错。
修复此问题的方法很简单：
1. 使用@Getter @Setter @ToString代替@Data并且自定义equals(Object other) 和 hashCode()方法，比如有些类只需要判断主键id是否相等即足矣。
2. 或者使用在使用@Data时同时加上@EqualsAndHashCode(callSuper=true)注解。