Lombok
Lombok使用
idea中安装lombok插件
在maven配置文件中引入依赖
进入maven的中央仓库,搜索lombok依赖:
maven仓库
<!-- https://mvnrepository.com/artifact/org.projectlombok/lombok -->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.10</version>
<scope>provided</scope>
</dependency>
目前最新的版本是1.18.10
Lombok使用
常用的注解
- @Setter
- @Getter
- @Data
- @Log(这是一个泛型注解,具体有很多种形式)
- @AllArgsConstructor
- @NoArgsConstructor
- @EqualsAndHashCode
- @NonNull
- @Cleanup
- @ToString
- @RequiredArgsConstructor
- @Value
- @SneakyThrows
- @Synchronized
@Getter和@Setter
使用@Getter和/或注释任何字段@Setter,以使lombok自动生成默认的getter / setter。
该注解使用在类或者属性上,该注解可以使用在类上也可以使用在属性上。
默认的getter只是返回该字段,并getFoo在调用该字段foo(或isFoo字段的类型为boolean)时命名。setFoo如果该字段名为foo,则返回默认的setter ,返回void,并接受与该字段相同类型的1个参数。它只是将字段设置为此值。
在使用该注解时,会默认生成一个无参构造。和对应的getterhe setter方法。
后缀可以跟AccessLevel.来改变set和get方法的访问权限,例如AccessLevel.PUBIC为公开方法。
同时自己还可以使用@Override的注解来实现方法的重写。
@Data
@Data官方介绍
@Data是捆绑的特征的方便快捷方式注释@ToString,@EqualsAndHashCode,@Getter/@Setter和@RequiredArgsConstructor在一起:即,@Data产生所有其通常与简单的POJO(普通旧式Java对象)和beans相关的样板:为所有非final字段和适当的toString,equals以及hashCode涉及该类字段的实现,以及一个构造函数,该构造函数初始化所有final字段以及所有未使用标记为的初始化程序的非final字段,@NonNull以确保该字段永远不会空值。
内部通过局部的注解来使得部分方法进行重写。
@NonNull
@NonNull官方介绍
该注解使用在属性上,该注解用于属的非空检查,当放在setter方法的字段上,将生成一个空检查,如果为空,则抛出NullPointerException。
该注解会默认是生成一个无参构造。
@toString
@toString官方介绍
该注解使用在类上,该注解默认生成任何非讲台字段以名称-值的形式输出。
1、如果需要可以通过注释参数includeFieldNames来控制输出中是否包含的属性名称。
2、可以通过exclude参数中包含字段名称,可以从生成的方法中排除特定字段。
3、可以通过callSuper参数控制父类的输出。
@EqualsAndHashCode
@EqualsAndHashCode官方介绍
该注解使用在类上,该注解在类级别注释会同时生成equals和hashCode。
@AllArgsConstructor
@AllArgsConstructor官方介绍
该注解使用在类上,该注解提供一个全参数的构造方法,默认不提供无参构造。
@NoArgsConstructor
@NoArgsConstructor官方介绍
该注解使用在类上,该注解提供一个无参构造
@RequiredArgsConstructor
@RequiredArgsConstructor官方介绍
该注解使用在类上,使用类中所有带有 @NonNull 注解的或者带有 final 修饰的成员变量生成对应的构造方法。
@Value
@Value官方介绍
这个注解用在类上,会生成含所有参数的构造方法,get 方法,此外还提供了equals、hashCode、toString 方法。
注意:没有setter
@Cleanup
@Cleanup官方介绍
该注解使用在属性前,该注解是用来保证分配的资源被释放。在本地变量上使用该注解,任何后续代码都将封装在try/finally中,确保当前作用于中的资源被释放。默认@Cleanup清理的方法为close,可以使用value指定不同的方法名称。