IDEA的lombok插件

简介

Lombok项目是一种自动接通你的编辑器和构建工具的一个Java库。

在Java编程时，写完字段后，需要一个一个去写getter和setter方法。在使用Idea编程时，可以按住ALT+INSERT键，让IDE自动生成getter, setter, toString等方法。然而，当一个类的字段特别多时，整个文件看起来将非常不简洁。所幸IDEA提供了一款lombok插件，可以在代码阶段，通过添加注解的形式，省去手写getter, setter的麻烦。

而且，当我们的变量发生改变时，不再需要修改对应的getter、setter方法，lombok帮我们在运行的过程中自动生成上述方法，编码更灵活。

使用

首先，在IDEA安装 lombok 插件

接着，在项目的pom文件中添加lombok依赖（版本自行选择），注意此处scope填写provided，代表这个包不需要打包发布，仅编译时需要用到，且已有提供方。

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.16.18</version>
    <scope>provided</scope>
</dependency>

然后，在模型类上，添加注解 @Data，即可省去手写getter, setter, toString的麻烦。

需要注意的是，一旦启用lombok插件，那么团队中其他成员也必须安装此插件，否则会编译报错。

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方法；
- 此注解会生成equals(Object other) 和 hashCode()方法。
- 它默认使用非静态，非瞬态的属性
- 可通过参数exclude排除一些属性
- 可通过参数of指定仅使用哪些属性
- 它默认仅使用该类中定义的属性且不调用父类的方法
- 可通过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()方法判定为相等，从而导致出错。

修复此问题的方法很简单：

使用@Getter @Setter @ToString代替@Data并且自定义equals(Object other) 和 hashCode()方法，比如有些类只需要判断主键id是否相等即足矣。
或者使用在使用@Data时同时加上@EqualsAndHashCode(callSuper=true)注解。

IDEA的lombok插件

简介

使用

更多