HashMap 使用自定义对象作为Key的注意点

HashMap 使用自定义对象作为Key的注意点

1. 自定义对象不重写hashCode方法和equals会发生什么？

public class AboutHashMap {
    public static void main(String[] args) {

        Student s1 = new Student("张三",18);
        Student s2 = new Student("张三",18);
        System.out.println(s1.hashCode()); //21685669
        System.out.println(s2.hashCode()); //2133927002

        System.out.println(s1.hashCode() == s2.hashCode()); //false
        System.out.println(s1.equals(s2)); //false

    }
}

class Student {
    private String name;
    private int age;
    // 省略getter，setter，有参构造
}

结论：

​ 当我们不重写Student对象的hashCode方法和equals方法时，Student对象沿用的就是Object对象的hashCode方法和equals方法；从上面代码的测试来说，即使两个属性相同的对象他们的hash值都是不一样的，调用equals方法进行比较，他们也是不相同的。

总结：

• Object对象的equals方法比较的是两个对象的内存地址。
• Object类的hashCode返回对象的内存地址经过处理后得到的值，由于每个对象的内存地址都不一样，所以哈希码也不一样。

public native int hashCode();

public boolean equals(Object obj) {
    return (this == obj);
}

2. 在HashMap中使用自定义对象作为key会发生什么？

public class AboutHashMap {
    public static void main(String[] args) {

        Student s1 = new Student("张三",18); // 两个相同属性的对象
        Student s2 = new Student("张三",18);
        Map<Student, Integer> hashMap = new HashMap<>();
        hashMap.put(s1, 99);
        
        // 使用属性相同的对象s2去调用get方法
        System.out.println( hashMap.get(s2) );  // null

    }
}

class Student {
    private String name;
    private int age;
    // 省略getter，setter，有参构造方法，toString方法
}

分析：

​ 我们可以发现，通过一个属性一模一样的s2去get哈希表中的元素竟然找不到前面put过的 s1-99！！！？？？

解释：

​ put入的元素在HashMap中数组结构的位置由key的hashCode方法返回值来决定，而此时自定义对象hashCode方法（未重写），返回值是由对象的内存地址值计算而来的，因此即使两个对象的属性完全相同，他们的哈希值也不同，所以即使两个属性完全相同的对象在HashMap中也完全找不到。

总结：
使用自定义对象作为HashMap的key不重写hashCode和equals方法会产生的问题

• get方法：使用属性完全相同的对象作为key去get元素会找不到元素。
• put方法：即使是有属性完全相同的对象put到HashMap中，也不会覆盖已有的value值，只会当作新元素加入到HashMap中
• 即使发生hash冲突，调用equal方法比较两个属性完全相同的对象也会返回false

所以要想顺利使用自定义对象作为hashMap的key就必须正确重写hashCode和equals方法。

3. 重写hashCode方法和equals方法的原则

equals:

• 相等的两个key实例调用equals()必须返回true(相等指的是属性完全相等)。

hashCode：

• 如果两个对象相等，则两个对象的hashCode()必须相等；
• 如果两个对象不相等，则两个对象的hashCode()尽量不要相等, (为了减少发生hash冲突的情况)。

ps：在IDEA中使用 ALT + INSERT可以快速帮我们实现equals和hashcode方法

class Student {
    private String name;
    private int age;

    @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 && name.equals(student.name);
    }

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

参考：廖雪峰的Java教程