Lombok及注解

Lombok

什么是Lombok

在Java中,封装是一个非常好的机制,最常见的封装莫过于get,set方法了,在Intellij idea中提供了快速生成get和set方法的快捷键(鼠标右键，选择generate)，其实,我们还有更方便的办法,就是今天的主角-Lombok。

Lombok是一个通过注解以达到减少代码的Java库,如通过注解的方式减少get,set方法,构造方法等。

Lombok安装

• 在pom.xml文件中添加下面的依赖就

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

• 但是Intelij idea在默认情况下是无法识别Lombok的API的，想让Intelij idea识别就要在插件中安Lombok。

不过在ideidea2020.2后面的版本中已经集成了Lombok插件，不用手动下载安装，2020.2之前的版本还是需要手动安装的。

Lombok的几个注解

Lombok提供注解方式来提高代码的简洁性,常用注解有:

• @Data
• @Setter @Getter 作用于属性上,自动生成get,set方法.
• @NonNull 快速判断是否为空,如果为空,则抛出java.lang.NullPointerException
• @Synchronized 自动添加到同步机制,生成的代码并不是直接锁方法,而是锁代码块,作用范围是方法上
• @ToString 转化为字符串，@ToString有多个属性可以进一步设置：callSuper 是否输出父类的toString方法,默认为false;includeFieldNames 是否包含字段名称,默认为true;exclude 排除生成tostring的字段
• @EqualsAndHashCode
• @Cleanup 用于确保已分配的资源被释放,如IO的连接关闭。
• @SneakyThrows

@Data注解

@Data注解的主要作用是提高代码的简洁，使用这个注解可以省去实体类中大量的get()、 set()、 toString()等方法。

在类上添加@Data注解之后，Lombok 会自动生成以下方法：

• 所有字段的 getter 和 setter 方法。
• equals 和 hashCode 方法，用于比较两个对象是否相等。
• toString 方法，用于将对象转换为字符串表示形式。

例如在下面这个student类上添加@Data注解

@Data
public class Student {
    private String name;
    private int age;
}

等价于生成其对应的get、set、equals 、hashCode 、toString 方法。

public class Student {
    private String name;
    private int age;
    
    public String getName() {
        return this.name;
    }
    
    public void setName(String name) {
        this.name = name;
    }
    
    public int getAge() {
        return this.age;
    }
    
    public void setAge(int age) {
        this.age = age;
    }
    
    @Override
    public boolean equals(Object obj) {
        
    }
    
    @Override
    public int hashCode() {
        
    }
    
    @Override
    public String toString() {
        
    }
}

不难看出@Data相当于@Getter @Setter @RequiredArgsConstructor @ToString @EqualsAndHashCode这5个注解的合集, @EqualsAndHashCode默认是false

@EqualsAndHashCode

@EqualsAndHashCode注解的作用就是自动生成类的equals方法和hashcode方法。

在使用@Data的时候会出现这么一个问题，子类在继承父类的时候新增了属性并且使用@Data注解，在子类的实体类进行equals的时候，只要子类的属性相同就会返回true，而不会去比较父类的属性。例子如下：

/**
 * 定义一个父类，人
 */
@Data
public class Person {
    private String name;
    private int age;
}

/**
 * 定义一个子类，学生
 */
@Data
public class Student extends Person {
    //子类新增的属性性别
    private String sex;
}

/**
 * 生成子类的对象并且equals
 */
public class EqualsAndHashCodeTest {
 
    public static void main(String[] args) {
        Student student1 = new Student();
        student.setSex("男");
        student.setName("张三");
        student.setAge(18);
 
        Student student2 = new Student();
        student.setSex("男");
        student.setName("李四");
        student.setAge(19);
 
        System.out.println("比较结果:" + student1.equals(student2));
    }
 
}

可以看到两个对象的名字和年龄并不相同但是返回结果却为true，原因就是是它没有比较父类的中属性，而是直接根据子类中的属性来生成hashcode，所以当子类中的属性参数一样时，使用equals比较结果的为true。

解决方法：

• 添加@EqualsAndHashCode(callSuper = true)注解
• 不使用@Data注解

@EqualsAndHashCode(callSuper = true)，就是用自己的属性和从父类继承的属性来生成hashcode；

@EqualsAndHashCode(callSuper = false)，就是只用自己的属性来生成hashcode；