Lombok使用教程

基于工作当中的使用以及对网上相关教程的总结，写出此篇文章，假若有不全的地方，请多多留言告知

一、Lombok注解

@Getter、@Setter

• 作⽤类上，⽣成所有成员变量的getter/setter⽅法

• 作⽤于成员变量上，⽣成该成员变量的getter/setter⽅法
  

• 被final修饰的变量，只能生成getter方法
• 被static修饰的变量，无法生成getter/setter方法

默认情况下，生成的getter、setter方法都是public，如果想让方法的修饰符为其他的，那么可以这样设置

@Setter
@Getter
public class UserDO {
     /**
     * 不想⽣成 get⽅法
     */
     @Getter(AccessLevel.NONE)
     private int age;

     // 让 getSalary 方法的访问权限为 protected
     @Getter(AccessLevel.PROTECTED)
     private int salary;

     /**
     * final 只会⽣成get
     */
     private final String name="⼆当家⼩D";

     /**
     * 下⾯两个静态成员变量不会⽣成set/get⽅法
     */
     static Date createTime = new Date();
     private static final String address = "⼴东
    省⼴州市";
}

• AccessLevel枚举类中的枚举字段有：、
  • PUBLIC：public
  • MODULE：default
  • PROTECTED：protected
  • PACKAGE：package
  • PRIVATE：private
  • NONE：不生成getter/setter方法
    

@NonNull

• 作用于方法或者属性，用于非空判断，如果未空则抛出异常
  

@XXXConstructor

• @AllArgsConstructor：生成全参构造函数。
• @NoArgsConstructor：生成无参构造函数。
• @RequiredArgsConstructor：生成指定参数的构造函数，其中的指定参数是：final类型未被初始化的属性或者标记了@NonNull的属性。
  

@ToString

作⽤于类，覆盖默认的toString()⽅法，用于打印对象的属性

• 不包括某个字段 @ToString(exclude = {"age"})
• 只输出某个字段 @ToString(of = {"name"})

@EqualsAndHashCode

作⽤于类，覆盖默认的equals和hashCode, 作⽤于全部属性

• 不包括某个属性：@EqualsAndHashCode(exclude = {"age"})
• 只输出某个属性：@EqualsAndHashCode(of = {"name"})

在讲解这个注解之后，我们来讲解下java对象中默认的hashcode、equal方法。
为什么对象要重写hashcode和equal⽅法？

• HashCode⽅法
  顶级类Object⾥⾯的⽅法，所有类都是继承Object的，返回值int类型根据⼀定的hash规则(存储地址，字段，或者⻓度等)，映射成⼀个数值，即散列值
• Equals⽅法
  顶级类Object⾥⾯的⽅法，所有类都是继承Object的，返回值boolean类型根据⾃定义的匹配规则，⽤于匹配两个对象是否⼀样, ⼀般逻辑是如下：

 //判断地址是否⼀样

 //⾮空判断和class类型判断

 //强转

 //对象⾥⾯的字段⼀⼀匹配

解析如果两个对象相等，那么它们的hashCode()值⼀定相同（这⾥的相等是指，通过equals()⽐较两个对象时返回true）如果两个对象hashCode()相等，它们并不⼀定相等。在散列表中hashCode()相等，即两个键值对的哈希值相等。然⽽哈希值相等，并不⼀定能得出键值对相等，就出现所谓的哈希冲突场景，还需判断equals⽅法判断对象是否相等

• 应⽤场景：
  当向集合中插⼊对象时，如何判别在集合中是否已经存在该对象，⽐如Set确保存储对象的 唯⼀，并判断是不是同个对象呢？

依据hashCode和equals进⾏判断；所以Set存储的对象必须重写这两个⽅法判断两个对象是否⼀样，⾸先判断插⼊obj的hashcode值是否存在，hashcode值不存在则直接插⼊集合，值存在则还需判断equals⽅法判断对象是否相等。

class User {

   private int age;

   private String name;

   private Date time;

   //省略setter和getter⽅法 @Override

   public boolean equals(Object o) {
 			if (this == o) return true;
 			if (o == null || getClass() != o.getClass()) return false;
 			Student student = (Student) o;
 			return age == student.age && Objects.equals(name, student.name) &&Objects.equals(time, student.time);
 }

   @Override
   public int hashCode() {
      return Objects.hash(age, name, time);
   }
}

@Data

作⽤于类上，是以下注解的集合
@ToString
@EqualsAndHashCode
@Getter
@Setter
@RequiredArgsConstructor

@Builder

作用于类，将其变成建造者模式；可以以链的形式调用；初始化实例对象生成的对象是不可以变的，可以在创建对象的时候进行赋值，如果需要在原来的基础上修改可以加 set 方法，final 字段可以不需要初始化。它会生成一个全参的构造函数。

属性

• @Builder.Default：非 final 的字段可以有默认值

• builderMethodName：指定创建内部静态类的方法名，默认值为 builder

• buildMethodName：指定创建实体类的方法名，默认值为 build

• builderClassName：指定内部静态的类名，默认值为 “”，默认创建的类名为 thisclassBuilder

• toBuilder：设置为 true 可以对这个对象进行拷贝生成新的对象，可以再修改，默认为 false

• access：设置 builderMethodName 的访问权限修饰符，默认为 public
  共有 PUBLIC、MODULE、PROTECTED、PACKAGE、PRIVATE，其中 MODULE 是 Java 9 的新特性

• setterPrefix：设置 setter 方法的前缀，默认为 “”

• @Builder.ObtainVia：表示变量从什么地方获取值，只有当 toBuilder = true 时才生效

  • field：表示字段赋值时从某个字段上取值，对应的字段必须存在
  • method：表示字段赋值时从某个方法上取值，对应的方法必须存在
  • isStatic：表示 method 是否静态

  @Builder(toBuilder = true)
  public class Rita {
  	private String name;
    
  	// 对应方法 init，方法返回类型和字段类型必须统一
  	@Builder.ObtainVia(method = "init")	
  	private String identity;
  	
  	private String init() {
  		return "Rita";
  	}
  	
  	public static void main(String[] args) {
  		Rita rita = Rita.builder().name("Rita").build();
  		rita = rita.toBuilder().build();	// 此时变量 identity 从 init 方法中取值
  		System.out.println(rita);
  	}
  }
  

@Builder 会生成一个全参构造方法，因此就没有了无参构造方法，但当我们遇到需要无参构造方法时就会发生问题，这个时候手写或者加上 @NoArgsConstructor都会报错，两种解决方案

• 加上 @AllArgsConstructor
• 使用@Tolerate注解

@Builder 内部做了什么

• 创建一个名为 ThisClassBuilder 的内部静态类，并具有和实体类相同的属性（称为构建器）
• 在构建器中：对于目标类中的所有的属性和未初始化的 final 字段，都会在构建器中创建对应属性
• 在构建器中：创建一个无参的 default 构造函数
• 在构建器中：实体类中的每个参数，都会对应创建类似于 setter 的方法，方法名与该参数名相同。 并且返回值是构建器本身（便于链式调用）
• 在构建器中：会创建一个 build 方法，调用 build 方法，就会根据设置的值进行创建实体对象
• 在构建器中：会生成一个 toString 方法
• 在实体类中：会创建一个 builder 方法，它的目的是用来创建构建器
  

@Log / @Slf4j

• 作用在类上，生成日志变量，用于记录日志
  

二、Lombok优缺点

缺点：

• Lombok的使⽤要求⼀定要在IDE中安装对应的插件，如果项⽬组中有⼀个⼈使⽤了Lombok则都要⽤

• 代码可读性，可调试性低，⽐如想知道某个类中的某个属性的getter⽅法都被哪些类引⽤

• 影响升级，如果升级到某个新版本的JDK的时候，如果其中的特性在Lombok中不⽀持的话就会受到影响

• 注意常⻅的细节点：⽐如只使⽤了@Data，⽽不使⽤@EqualsAndHashCode(callSuper=true)的话，会默认是@EqualsAndHashCode(callSuper=false),这时候⽣成的equals()⽅法只会⽐较⼦类的属性，不会考虑从⽗类继承的属性，⽆论⽗类属性访问权限是否开放,只要知道是否需要使⽤⽗类的属性即可，也提供定制化配置，所以不⽤过多担⼼

优点：

• 使⽤注解即可帮忙⾃动⽣成代码
• ⼤⼤减少了代码量，使代码⾮常简洁
• 部分注解在业务项⽬中开发能⼤⼤提⾼效率

项⽬中应该⽤还是不⽤呢

• 不建议开发中间件的项⽬使⽤，中间件设计的要求是解耦少依赖
• 业务项⽬实体类可以⽤，且⽤的时候知道对应的常⻅的注解原理