lombok是以注解的形式,大大减少在创建对象过程中的get,set,toString, 空参构造,有参构造等这些动作,简化代码开发减少工作量
如何使用lombok
第一步:在IDEA编辑器中引入lombok插件
打开IDEA的Setting –> 选择Plugins选项 –> 选择Browse repositories –> 搜索lombok –> 点击安装 –> 安装完成重启IDEA –> 安装成功
第二步:在项目的pom文件中映入lombok依赖
<!-- https://mvnrepository.com/artifact/org.projectlombok/lombok -->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.16.18</version>
<scope>provided</scope>
</dependency>
使用时直接在类上添加注解即可
Lombok注解使用
- @NonNull:给方法参数增加这个注解会自动在方法内对该参数进行是否为空的校验,如果为空,则抛出NPE(NullPointerException)
- @Cleanup:自动管理资源,用在局部变量之前,在当前变量范围内即将执行完毕退出之前会自动清理资源,自动生成try-finally这样的代码来关闭流
- @Getter/@Setter:用在属性上,再也不用自己手写setter和getter方法了,还可以指定访问范围
- @ToString:用在类上,可以自动覆写toString方法,当然还可以加其他参数,例如@ToString(exclude=”id”)排除id属性,或者@ToString(callSuper=true,
includeFieldNames=true)调用父类的toString方法,包含所有属性 - @EqualsAndHashCode:用在类上,自动生成equals方法和hashCode方法
- @NoArgsConstructor, @RequiredArgsConstructor and
@AllArgsConstructor:用在类上,自动生成无参构造和使用所有参数的构造函数以及把所有@NonNull属性作为参数的构造函数,如果指定staticName
= “of”参数,同时还会生成一个返回类对象的静态工厂方法,比使用构造函数方便很多 - @Data:注解在类上,相当于同时使用了@ToString、@EqualsAndHashCode、@Getter、@Setter和@RequiredArgsConstrutor这些注解,对于POJO类十分有用
- @Value:用在类上,是@Data的不可变形式,相当于为属性添加final声明,只提供getter方法,而不提供setter方法
- @Builder:用在类、构造器、方法上,为你提供复杂的builder
APIs,让你可以像如下方式一样调用Person.builder().name(“Adam Savage”).city(“San
Francisco”).job(“Mythbusters”).job(“Unchained
Reaction”).build();更多说明参考Builder - @SneakyThrows:注解用在 方法 上,可以将方法中的代码用 try-catch 语句包裹起来,捕获异常并在 catch 中用Lombok.sneakyThrow(e) 把异常抛出,可以使用 @SneakyThrows(Exception.class)的形式指定抛出哪种异常。该注解需要谨慎使用
- @Synchronized:用在方法上,将方法声明为同步的,并自动加锁,而锁对象是一个私有的属性lock或lock或lock或LOCK,而java中的synchronized关键字锁对象是this,锁在this或者自己的类对象上存在副作用,就是你不能阻止非受控代码去锁this或者类对象,这可能会导致竞争条件或者其它线程错误
- @Getter(lazy=true):可以替代经典的Double Check Lock样板代码
- @Log:根据不同的注解生成不同类型的log对象,但是实例名称都是log,有六种可选实现类 @CommonsLog Creates log
= org.apache.commons.logging.LogFactory.getLog(LogExample.class); @Log Creates log =
java.util.logging.Logger.getLogger(LogExample.class.getName());
@Log4j Creates log =
org.apache.log4j.Logger.getLogger(LogExample.class); @Log4j2 Creates
log =
org.apache.logging.log4j.LogManager.getLogger(LogExample.class);
@Slf4j Creates log =
org.slf4j.LoggerFactory.getLogger(LogExample.class); @XSlf4j Creates
log = org.slf4j.ext.XLoggerFactory.getXLogger(LogExample.class);