Lombok中關於@Data的使用坑

時間 2019-11-11

標籤 lombok 關於 data 使用欄目 Java 简体版

原文原文鏈接

當你在使用 Lombok 的 @Data 註解時，其實會有一些坑須要關注，今天就讓咱們來見識一下。java

Lombok

先來簡單介紹一下 Lombok ，其官方介紹以下：測試

Project Lombok makes java a spicier language by adding 'handlers' that know how to build and compile simple, boilerplate-free, not-quite-java code.

大體意思是 Lombok 經過增長一些"處理程序"，可讓 Java 代碼變得簡潔、快速。優化

Lombok 提供了一系列的註解幫助咱們簡化代碼，好比：ui

註解名稱功能@Setter自動添加類中全部屬性相關的 set 方法@Getter自動添加類中全部屬性相關的 get 方法@Builder使得該類能夠經過 builder (建造者模式)構建對象@RequiredArgsConstructor生成一個該類的構造方法，禁止無參構造@ToString重寫該類的toString()方法@EqualsAndHashCode重寫該類的equals()和hashCode()方法@Data等價於上面的@Setter、@Getter、@RequiredArgsConstructor、@ToString、@EqualsAndHashCodethis

看起來彷佛這些註解都很正常，而且對咱們的代碼也有必定的優化，那爲何說@Data註解存在坑呢？spa

@Data註解

內部實現

由上面的表格咱們能夠知道，@Data是包含了@EqualsAndHashCode的功能，那麼它到底是如何重寫equals()和hashCode()方法的呢？.net

咱們定義一個類TestA：code

@Data
public class TestA {

    String oldName;
}

咱們將其編譯後的 class 文件進行反編譯：對象

public class TestA {

    String oldName;

    public TestA() {
    }

    public String getOldName() {
        return this.oldName;
    }

    public void setOldName(String oldName) {
        this.oldName = oldName;
    }

    public boolean equals(Object o) {
        // 判斷是不是同一個對象
        if (o == this) {
            return true;
        }
        // 判斷是不是同一個類
        else if (!(o instanceof TestA)) {
            return false;
        } else {
            TestA other = (TestA) o;
            if (!other.canEqual(this)) {
                return false;
            } else {
                // 比較類中的屬性(注意這裏，只比較了當前類中的屬性)
                Object this$oldName = this.getOldName();
                Object other$oldName = other.getOldName();
                if (this$oldName == null) {
                    if (other$oldName != null) {
                        return false;
                    }
                } else if (!this$oldName.equals(other$oldName)) {
                    return false;
                }

                return true;
            }
        }
    }

    protected boolean canEqual(Object other) {
        return other instanceof TestA;
    }

    public int hashCode() {
        int PRIME = true;
        int result = 1;
        Object $oldName = this.getOldName();
        int result = result * 59 + ($oldName == null ? 43 : $oldName.hashCode());
        return result;
    }

    public String toString() {
        return "TestA(oldName=" + this.getOldName() + ")";
    }
}

針對其equals()方法，當它進行屬性比較時，其實只比較了當前類中的屬性。若是你不信的話，咱們再來建立一個類TestB，它是TestA的子類：繼承

@Data
public class TestB extends TestA {

    private String name;

    private int age;
}

咱們將其編譯後的 class 文件進行反編譯：

public class TestB extends TestA {

    private String name;

    private int age;

    public TestB() {
    }

    public String getName() {
        return this.name;
    }

    public int getAge() {
        return this.age;
    }

    public void setName(String name) {
        this.name = name;
    }

    public void setAge(int age) {
        this.age = age;
    }

    public boolean equals(Object o) {
        if (o == this) {
            return true;
        } else if (!(o instanceof TestB)) {
            return false;
        } else {
            TestB other = (TestB)o;
            if (!other.canEqual(this)) {
                return false;
            } else {
                // 注意這裏，真的是隻比較了當前類中的屬性，並無比較父類中的屬性
                Object this$name = this.getName();
                Object other$name = other.getName();
                if (this$name == null) {
                    if (other$name == null) {
                        return this.getAge() == other.getAge();
                    }
                } else if (this$name.equals(other$name)) {
                    return this.getAge() == other.getAge();
                }

                return false;
            }
        }
    }

    protected boolean canEqual(Object other) {
        return other instanceof TestB;
    }

    public int hashCode() {
        int PRIME = true;
        int result = 1;
        Object $name = this.getName();
        int result = result * 59 + ($name == null ? 43 : $name.hashCode());
        result = result * 59 + this.getAge();
        return result;
    }

    public String toString() {
        return "TestB(name=" + this.getName() + ", age=" + this.getAge() + ")";
    }
}

按照代碼的理解，若是兩個子類對象，其子類中的屬性相同、父類中的屬性不一樣時，利用equals()方法時，依舊會認爲這兩個對象相同，測試一下：

public static void main(String[] args) {
        TestB t1 = new TestB();
        TestB t2 = new TestB();

        t1.setOldName("123");
        t2.setOldName("12345");

        String name = "1";
        t1.name = name;
        t2.name = name;

        int age = 1;
        t1.age = age;
        t2.age = age;

        System.out.println(t1.equals(t2));
        System.out.println(t2.equals(t1));
        System.out.println(t1.hashCode());
        System.out.println(t2.hashCode());
        System.out.println(t1 == t2);
        System.out.println(Objects.equals(t1, t2));
    }

結果爲：

true
true
6373
6373
false
true

問題總結

對於父類是Object且使用了 @EqualsAndHashCode(callSuper = true)註解的類，這個類由 Lombok 生成的 equals()方法只有在兩個對象是同一個對象時，纔會返回 true ，不然總爲 false ，不管它們的屬性是否相同。
這個行爲在大部分時間是不符合預期的， equals()失去了其意義。即便咱們指望 equals()是這樣工做的，那麼其他的屬性比較代碼即是累贅，會大幅度下降代碼的分支覆蓋率。