Lombok的基本使用安装lombok插件及常用注解@Data @Builder @Value @ToString @AllArgsConstructor @Slf4j

Lombok基本使用

一.引入lombok支持

1.导包或引入依赖

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.18.12</version>
    <scope>provided</scope> <!--只在在编译阶段有用-->
</dependency>

2.在IDEA中安装lombok插件

1. 点击File-- Settings设置界面，安装Lombok插件
2. 点击File-- Settings设置界面，点击 Annotation Processors 勾选 Enable annotation Processing
3. 开启该项是为了让Lombok注解在编译阶段起到作用

3.如果只是为了使用可以到此为止

• 只需在实体类上标上如下注解，即可满足基本使用要求

 //生成GET、SET、toString、equals、hashCode、以及只包含 final关键字修饰的属性 的构造方法，如果没有就会生成一个无参构造方法
@Data
@NoArgsConstructor //生成无参构造方法
@AllArgsConstructor //生成包含所有参数的构造方法
@Builder //流式setter方法（选用）
public class User {
    private Long id;
    private String userName;
    private String password;
    private String name;
    private Integer age;
    private String address;
}

二.常用注解

1.lombok的@Get和@Set注解

• 自动产生 getter/setter

2.lombok的@ToString注解

• 自动重写 toString() 方法，默认包含所有属性

3.lombok的@EqualsAndHashCode注解

• 自动生成 equals(Object other) 和 hashcode() 方法，包括所有非静态变量和非临时变量

• 如果有某些变量不想加入进判断，可以透过 exclude属性 排除，也可以使用 of 指定某些字段

为什么@EqualsAndHashCode 注解是 @Equals 和 @HashCode两个注解组成的复合注解？

答：这是由hashCode 的常规协定决定的

hashCode的协定规定： （只摘取有关）

1.如果根据 equals(Object) 方法，两个对象是相等的，那么这两个对象分别调用 hashCode 方法都必须生成相同的整数结果。

2.如果根据 equals(Object) 方法，两个对象不相等，那么这两个对象调用 hashCode 方法 不要求 一定生成不同的整数结果

4.@NoArgsConstructor, @AllArgsConstructor, @RequiredArgsConstructor

• 这三个注解作用相似，都是用于生成类的构造方法，区别仅在于生成的构造方法的参数不同

• 使用如下任意一个注解 @AllArgsConstructor、@RequiredArgsConstructor 就必须使用 @NoArgsConstructor 来生成无参构造方法

  或手动编写一个无参构造方法

4-1：@NoArgsConstructor : 生成一个没有参数的构造方法

4-2: @AllArgsConstructor : 生成一个包含所有参数的构造方法

4-3:@RequiredArgsConstructor

• 生成一个包含 “特定参数” 的构造方法，特定参数指的是那些有加上 final 修饰词的变量们

如果所有的变量都是正常的，都没有用 final 修饰的话，那就会生成一个没有参数的构造方法

5.@Data

• 整合包，只要加了 @Data 这个注解，等于同时加了以下注解
  • @Getter/@Setter
  • @ToString
  • @EqualsAndHashCode
  • @RequiredArgsConstructor （如果没有final关键字修饰的属性，就会生成一个无参构造方法）

@Data注解推荐使用在一个值可以被更新的类上，如POJO、DTO、JPA中的Entity等

6. @Value

• 也是整合包，但是他会把所有的成员变量都设成 final关键字修饰的，其他功能与 @Data 相同，作用等同于如下注解：
  • @Getter (注意没有setter)
  • @ToString
  • @EqualsAndHashCode
  • @RequiredArgsConstructor

@Value被推荐使用在值不可更新的类上

@Value注解与Spring框架存在同名注解，导包时需要注意额

Spring的@Value注解导包： org.springframework.beans.factory.annotation.Value;

Lombok的@Value注解导包： lombok.Value;

7.@Builder

• 自动生成流式 set 值写法

使用@Builder注解可以方便的流式的写代码，但并不能省略set方法，在许多框架中默认通过对象的get/set方法进行取值/设值操作

8.@Slf4j

• 自动生成该类的 log 静态常量（SpringBoot默认日志框架就是Slf4j+logback 以INFO级别输出,所以无需做其他配置）

Lombok除了提供@Slf4j以外，也同样提供了其他的日志框架注解，如：@Log、@Log4j…
其作用都是自动生成一个log静态常量，用于直接打印日志，区别仅在于调用的库不同

Log语句示例：

// 注意导包
@Log
import java.util.logging.Logger;
private static final Logger log = Logger.getLogger(LogExample.class.getName());
@Log4j 
import org.apache.log4j.Logger;
private static final Logger log = Logger.getLogger(LogExample.class);