目录
一、简介
Lombok是一个Java库,能自动插入编辑器并构建工具,简化Java开发。通过添加注解的方式,不需要为类编写getter或eques方法,同时可以自动化日志变量。
简而言之:以注解的形式简化java代码,提高开发效率。
二、安装
1、在idea插件商店中找到Lombok下载,下载完成后重启idea,插件才会生效。
2、项目中引入Lombok依赖
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.24</version>
<scope>provided</scope>
</dependency>
scope
是 provided
状态,此状态表示此依赖只在编译与测试时有效,当我们项目打包成 *.jar
的时候并不会打入进去。
三、Lombok使用
注解说明:
@Getter :添加在类或属性上,生成对应的 get方法。
@Setter :添加在类或属性上,生成对应的 set 方法。
@ToString:添加在类上,生成 toString 方法。
@EqualsAndHashCode:添加在类上,生成 equals 和 hashCode 方法。
@NoArgsConstructor、 @RequiredArgsConstructor 、@AllArgsConstructor :添加在类上,为类自动生成对应参数的构造方法。
@Data :添加在类上,是 5 个 Lombok 注解(@Getter、@Setter、@ToString、 @EqualsAndHashCode 和 @RequiredArgsConstructor )的组合。
- 为所有属性,添加
@Getter
、@ToString
、@EqualsAndHashCode
注解的效果 - 为非
final
修饰的属性,添加@Setter
注解的效果 - 为
final
修改的属性,添加@RequiredArgsConstructor
注解的效果
@Value :添加在类上,和 @Data
注解类似,区别在于它会把所有属性默认定义为 private final
修饰,所以不会生成 set 方法。
@CommonsLog、@Log、@Log4j、@Log4j2、@Slf4j、@XSlf4j :添加在类上,自动为类添加对应的日志支持。
@NonNull:添加在方法参数、类属性上,用于方法、属性空值校验。若为 null
时,抛出 NullPointerException 异常。
@Cleanup:添加在方法中的局部变量上,在作用域结束时会自动调用 #close()
方法,来释放资源。例如说,使用在 Java IO 流操作的时候。
@Builder:添加在类、构造器、方法上,给该类加个构造者模式 Builder 内部类。
@Synchronized:添加在方法上,添加同步锁。
@SneakyThrows:添加在方法上,给该方法添加 try catch
代码块。
@Accessors:添加在方法或属性上,下有三大属性,fluent、chain、prefix,并设置 chain = true
,实现链式编程。
1、@Data
右侧为已编译的class文件,可以看见生成了对应的getter\setter\toString\hashcode等方法。
2、@Value
与@Data的区别就是,属性是private final修饰,没有提供setter方法,只提供了有参构造、getter方法等。
3、@AllArgsConstructor
相当于生成所有字段的有参构造
4、@NoArgsConstructor
相当于无参构造
5、@RequiredArgsConstructor
会给有final修饰的属性和@NonNull注解修饰的属性生成构造器。
6、@Slf4j
生成对应的日志
7、@NonNull
8、@Cleanup
9、@Builder
在类上加上了该注解,在创建类的时候就可以进行属性链式赋值,不用在一个一个的set进实体类。
10、@Synchronized
会添加同步锁
11、@SneakyThrows
会为方法添加try...catch进行包裹。
12、@Accessors
@Accessors下有三个属性:fluent、chain、prefix
12-1 fluent 属性(默认为false)
当fluent属性为true时,给对象的属性赋值,会省略get和set。
12-2 chain 属性(默认为false)
当chain属性为true时,给对象赋值可以链式赋值,并且会返回当前对象。
12-3 prefix 属性
prefix属性中值是字符数组,设置了该属性。在set/get的时候会根据设置的值去掉属性的前缀进行使用。