浅谈Java重写equals方法的种种坑

介绍

在Java中，Object类中的equals方法是用于判断两个对象是否相等的。而且在大多数情况下，我们需要重写该方法来根据业务需要自定义判断两个对象是否相等。但是，重写equals方法并不容易，有一些坑需要我们注意。

重写equals方法的步骤

为了重写equals方法，我们需要遵循以下几个步骤：

1. 首先比较对象的引用，如果是同一个对象，则返回true。
2. 如果对象是null或者对象的类型不同，则返回false。
3. 将对象转换为该类的类型，并比较每一个属性是否相等。
4. 如果所有属性都相等，则返回true，否则返回false。

重写equals方法的问题

问题一：忘记重载hashCode方法

在重写equals方法时，我们需要注意如果两个对象是相等的，那么它们必须拥有相同的hashCode值。如果忘记重载hashCode方法，那么会导致该类无法用作集合类的键，比如HashMap。

示例：

public class Person {
    private String name;
    private int age;

    //省略get和set方法

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (!(o instanceof Person)) return false;
        Person person = (Person) o;
        return age == person.age &&
                Objects.equals(name, person.name);
    }
}

在该代码中，我们重写了equals方法，但是没有重写hashCode方法。所以我们不能在HashMap中使用该类作为键。

问题二：强制转型异常

在重写equals方法时，我们需要注意类型转换的问题。如果我们将一个父类对象强制类型转换成一个子类对象，那么就会发生ClassCastException异常。

示例：

public class Animal {
    private String name;

    //省略get和set方法

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (!(o instanceof Animal)) return false;
        Animal animal = (Animal) o;
        return Objects.equals(name, animal.name);
    }
}

public class Dog extends Animal {
    private String breed;

    //省略get和set方法

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (!(o instanceof Dog)) return false;
        Dog dog = (Dog) o;
        return Objects.equals(getName(), dog.getName()) &&
                Objects.equals(breed, dog.breed);
    }
}

在该代码中，Dog类继承自Animal类，我们分别在两个类中重写了equals方法。如果我们将一个Animal对象强制类型转换为一个Dog对象，那么就会发生ClassCastException异常。

总结

重写equals方法并不复杂，但是需要注意一些问题，比如要重载hashCode方法、类型转换的问题等等。如果没有注意这些问题，就会导致程序出现一些难以解决的问题。