使用Lombok简化开发

引言

在平时开发过程中,我们其实很多时候都做了重复的事情,向普通java类的各种get和set方法,构造方法什么的,虽然使用idea的自动生成能极大的简化开发,虽差强人意,但对于能偷懒就偷懒的我们来说还有更简单的办法,例如使用Lombok插件。

引入依赖与插件安装

在pom.xml文件里面添加依赖

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
</dependency>

如果使用springboot项目开发,springboot已经统一管理Lombok版本信息了,所有我能不用填写version。

接着安装插件Lombok

image-20210116001007837

Lombok注解一览

  • @Data
  • @Setter
  • @Getter
  • @Log4j
  • @AllArgsConstructor
  • @NoArgsConstructor
  • @EqualsAndHashCode
  • @NonNull
  • @Cleanup
  • @ToString
  • @RequiredArgsConstructor
  • @Value
  • @SneakyThrows
  • @Synchronized
  • @Builder

@Data

注解在上;

提供类所有属性的 get 和 set 方法,此外还提供了equals、canEqual、hashCode、toString 方法。

image-20210116002315047

@Setter

注解在 属性 上;

为单个属性提供 set 方法。

注解在 上;

为该类所有的属性提供 set 方法, 都提供默认构造方法。

image-20210116002542077

image-20210116003317047

@Getter

注解在 属性 上;

为单个属性提供 get 方法。

注解在 上;

为该类所有的属性提供 get 方法,都提供默认构造方法。

image-20210116002715803

image-20210116002933985

@Slf4j

注解在 上;

为类提供一个 属性名为 log 的 Slf4j 日志对象,提供默认构造方法。

image-20210116004210706

@AllArgsConstructor

注解在 上;

为类提供一个全参的构造方法,加了这个注解后,类中不提供默认构造方法了。

image-20210116004350329

@NoArgsConstructor

注解在 上;

为类提供一个无参的构造方法。

image-20210116004555995

@EqualsAndHashCode

注解在 上;

可以生成 equals、canEqual、hashCode 方法。

image-20210116004724731

@NonNull

注解在 属性 上;

会自动产生一个关于此参数的非空检查,如果参数为空,则抛出一个空指针异常,也会有一个默认的无参构造方法。

image-20210116004841000

@Cleanup

这个注解用在 变量 上;

可以保证此变量代表的资源会被自动关闭,默认是调用资源的 close() 方法,如果该资源有其它关闭方法,可使用 @Cleanup(“methodName”) 来指定要调用的方法,也会生成默认的构造方法

image-20210116005456473

@ToString

这个注解用在 上;

可以生成所有参数的 toString 方法,还会生成默认的构造方法。

image-20210116005631898

@RequiredArgsConstructor

这个注解用在 上;

使用类中所有带有 @NonNull 注解的或者带有 final 修饰的成员变量生成对应的构造方法。

image-20210116010008180

@Value

这个注解用在 上;

会生成含所有参数的构造方法,get 方法,此外还提供了equals、hashCode、toString 方法。

image-20210116010320834

@SneakyThrows

这个注解用在 方法 上;

可以将方法中的代码用 try-catch 语句包裹起来,捕获异常并在 catch 中用 Lombok.sneakyThrow(e) 把异常抛出,可以使用 @SneakyThrows(Exception.class) 的形式指定抛出哪种异常,也会生成默认的构造方法。

image-20210116010609407

@Synchronized

这个注解用在 类方法 或者 实例方法 上;

效果和 synchronized 关键字相同,区别在于锁对象不同,对于类方法和实例方法,synchronized 关键字的锁对象分别是类的 class 对象和 this 对象,而 @Synchronized 的锁对象分别是 私有静态 final 对象 lock 和 私有 final 对象 lock,当然,也可以自己指定锁对象,此外也提供默认的构造方法。

image-20210116011238762

@Builder

这个注解用在或者构造方法上;

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

在构建器中,对于目标类中的所有的属性和未初始化的final字段,都会在构建器中创建对应属性对于实体类中的每个参数,都会对应创建类似于setter的方法,只不过方法名与该参数名相同。 并且返回值是构建器本身(便于链式调用),一个build()方法,会根据设置的值进行创建实体对象,同时也会生成toString和默认构造方法。

在实体类中,会创建一个builder()方法,它的目的是用来创建构建器,同时也会生成全参构造方法。

image-20210116012238533

image-20210116013006967


一个好奇的人