Lombok常用注解

1、Lombok简介

Lombok是一个可以通过简单的注解形式来帮助我们简化消除一些必须有但显得很臃肿的Java代码的工具，通过使用对应的注解，可以在编译源码的时候生成对应的方法。

官方地址：https://projectlombok.org/
github地址：https://github.com/rzwitserloot/lombok

2、Maven引入

除了引入maven，还需要安装Lombok插件

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

3、注解介绍

• @Getter /@Setter
  作用在字段上，会自动生成字段的Getter；作用在类上，会自动生成该类所有非静态字段的Getter，还能控制Getter的访问级别

• @ToString
  类注解，自动生成类的toString方法，可以做一些定制，比如不使用某个字段，不调用Getters等

• @EqualsAndHashCode
  自动生成 equals(Object other) 和 hashcode() 方法，包括所有非静态变量和非 transient 的变量，如果某些变量不想要加进判断，可以透过 exclude 排除，也可以使用 of 指定某些字段

• @NoArgsConstructor, @AllArgsConstructor, @RequiredArgsConstructor
  @NoArgsConstructor 类注解，自动生成一个无参构造函数。
  @AllArgsConstructor 类注解，生成一个初始化所有字段的构造函数(在加上 @AllArgsConstructor 时，一定要补上 @NoArgsConstrcutor)
  @RequiredArgsConstructor : 生成一个包含 “特定参数” 的构造器，特定参数指的是那些有加上 final 修饰词的变量们.

• @Data
  相当于同时应用了@Getter、@Setter、@ToString、@EqualsAndHashCode、@RequiredArgsConstructor。如果已经定义了一个构造方法，就不会再自动生成构造方法了。

• @Value
  和@Data类似，但是用于不可变类型。生成的类和所有字段都设置为final，所有字段都为private，自动生成Getter但是没有Setter，会生成初始化所有字段的构造函数。相当于同时应用了final @ToString、 @EqualsAndHashCode、 @AllArgsConstructor 、@FieldDefaults(makeFinal = true, level = AccessLevel.PRIVATE)和 @Getter

• @Builder
  自动生成流式 set 值写法，从此之后再也不用写一堆 setter 了。注意，虽然只要加上 @Builder 注解，我们就能够用流式写法快速设定对象的值，但是 setter 还是必须要写不能省略的，因为 Spring 或是其他框架有很多地方都会用到对象的 getter/setter 对他们取值/赋值。
  所以通常是 @Data 和 @Builder 会一起用在同个类上，既方便我们流式写代码，也方便框架做事

• @NotNull
  作用在方法参数上的注解，用于自动生成空值参数检查。

• @Slf4j
  自动生成该类的 log 静态常量，要打日志就可以直接打，不用再手动 new log 静态常量了

---

实际开发中一般常用到的:
@Data
@NoArgsConstructor
@AllArgsConstructor

@Data         // 生成 getter/setter/equals/canEqual/hashCode/toString        
@NoArgsConstructor     // 为类提供一个无参的构造方法 
@AllArgsConstructor    // 为类提供一个全参的构造方法
public class Stu {
    String name;
    int weigh;
    int high;
}

如果要链式调用，增加注解@Accessor(chain = true)后即可链式。同时注意Lombok可能会产生一定问题

---

参考文章：
https://www.cnblogs.com/ooo0/p/12448096.html