Lombok的简单介绍和使用入门

目录

什么是Lombok

安装

如何使用

注解说明

1、@Getter和@Setter

2、@EqualsAndHashCode

3、@ToString

4、@RequiredArgsConstructor

5、@Data

6、@NonNull

7、@NoArgsConstructor和@AllArgsConstructor

8、@Value

9、@Log

10、@SneakyThrows

11、@Synchronized

12、@Cleanup

---

什么是Lombok

lombok是一款减少java开发人员繁杂代码的工具，比如lombok的注解可以替代JavaBean中的getter、setter以及equals的作用。使用lombok可以使代码更加简洁，一目了然。

安装

idea在使用lombok工具时，需要先安装插件，不然在代码编译可能会出现错误。

file -> settings -> plugins，搜索并安装“lombok”，然后重启idea。

如何使用

首先引入依赖：

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

然后相关注解即可使用

注解说明

1、@Getter和@Setter

作用在字段上，为该字段生成getter和setter方法；作用在类上，为该类所有字段生成getter和setter方法。

设置@Getter(lazy = true)，懒加载，在创建对象时该字段不进行初始化，而是在第一次访问时才进行初始化，以后再次访问时，也不会重复初始化。

在编译后的代码中，已经自动加上了getter和setter方法：

 

2、@EqualsAndHashCode

作用在类上，自动生成equals()和hashCode()方法，默认使用所有非静态、非transient字段。可以使用exclude或of来排除或定制使用那些字段。

@EqualsAndHashCode(exclude = {“password”, “phone”})  // 排除字段

@EqualsAndHashCode(of = {“userName”, “phone”}) // 指定字段

在编译后的代码中，会自动生成equals()和hashCode()和canEqual()方法。

3、@ToString

作用在类上，自动生成toString()方法，默认打印类名和全部字段。可以使用exclude属性来排除字段，有继承的情况，可以用callSuper属性来调用父类的toSting()方法。

@ToString(exclude = {"password"}, callSuper = true) 

编译后：

 

4、@RequiredArgsConstructor

作用在类上，自动生成构造函数，可能带参或不带参，带参的话参数只能是以final修饰的未初始化的字段，或者是以@NonNull注解的未初始化的字段。加上staticName属性会生成一个私有的静态方法。

@RequiredArgsConstructor(staticName = “自定义方法名称”)

编译后：

 

5、@Data

作用在类上，包含了@Getter 、@Setter、@ToString、@EqualsAndHashCode和@RequiredArgsConstructor五个注解的功能。

 

6、@NonNull

作用在字段上，不允许该字段赋值为空，否则会抛出NullPointerException。

 

7、@NoArgsConstructor和@AllArgsConstructor

作用在类上，@NoArgsConstructor会生成一个无参的构造方法，但是当类中有被final修饰没有初始化的字段时，会编译出错，可以用force属性解决(@NoArgsConstructor(force = true)：会为final修饰没有初始化的字段设置默认值0/false/null)。

@AllArgsConstructor注解，生成全参构造方法。

编译后：

 

8、@Value

作用在类上，会将所有字段变成被final修饰，并且包含了@Getter、@ToString、@AllArgsConstructor、@EqualsAndHashCode四个注解的功能。

编译后：

 

9、@Log

作用在类上，用于记录日志。

lombok的日志注解有：

@Log

@Log4j

@Log4j2

@Slf4j

@Xslf4j

@CommonsLog

@JBossLog

编译后：

 

10、@SneakyThrows

作用在方法上，用于捕获异常。可以指定异常类型。

编译后：

 

11、@Synchronized

作用于方法上，给方法加上同步锁。

编译后：

 

12、@Cleanup

作用在IO类对象上，会自动关闭资源。

编译后：