在项目中使用Lombok可以减少很多重复代码的书写。比如说getter/setter/toString等方法的编写。
很简单,三步使用lombok eclipse 安装插件,引入maven依赖,使用注解
1.安装插件
- 下载 lombok.jar
(https://projectlombok.org/download.html)
下载后放到eclipse 的安装目录,
在eclipse.ini 文件中加入
-Xbootclasspath/a:lombok.jar
-javaagent:lombok.jar
重启eclipse 生效,如果仍然不行的话,cmd 进入安装目录输入命令:eclipse clean
注意:javaagent:lombok.jar 中的lombok.jar 要和jar包名字一致
2.引入依赖
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.16.10</version>
</dependency>
3.使用注解
- @Setter
- @Getter
- @Data
- @Log(这是一个泛型注解,具体有很多种形式)
- @AllArgsConstructor
- @NoArgsConstructor
- @EqualsAndHashCode
- @NonNull
- @Cleanup
- @ToString
- @RequiredArgsConstructor
- @Value
- @SneakyThrows
- @Synchronized
@Getter 和 @Setter
该注解使用在类或者属性上,该注解可以使用在类上也可以使用在属性上。生成的getter遵循布尔属性的约定。例如:boolean类型的sex,getter方法为isSex而不是getSex
在使用该注解时,会默认生成一个无参构造。和对应的getterhe setter方法
@Data
该注解使用在类上,该注解会提供getter、setter、equals、canEqual、hashCode、toString方法。
@NonNull
该注解使用在属性上,该注解用于属的非空检查,当放在setter方法的字段上,将生成一个空检查,如果为空,则抛出NullPointerException。
该注解会默认是生成一个无参构造。
@toString
该注解使用在类上,该注解默认生成任何非讲台字段以名称-值的形式输出。
1、如果需要可以通过注释参数includeFieldNames来控制输出中是否包含的属性名称。
2、可以通过exclude参数中包含字段名称,可以从生成的方法中排除特定字段。
3、可以通过callSuper参数控制父类的输出。
@AllArgsConstructor
该注解使用在类上,该注解提供一个全参数的构造方法,默认不提供无参构造。
以上为实体类比较常用的注解,如果需要更深入的话可参见官方文档https://projectlombok.org/features/log