hashCode与equals的那些事

一、hashcode的作用

首先说明一点：hashCode是为了提高在散列结构存储中(HashTable，HashSet,HashMap)查找的效率，在线性表(ArrayList)中没有作用。因为在散列存储结构中，调用equals()方法之前会首先调用hashcode()方法，如果hashcode()方法返回不同的int值，则不会调用equals()方法。而在线性结构中，是不会调用hashcode()方法的。

我们先假定有一万个数据要放入集合中，如果我们直接放进去，则当我们要查询该集合是否包含A时，就需要拿A与一万个数据进行对比，这种做法是非常低效率的。为什么我们不可以像书本的目录一样，一开始就将该数据的查找范围缩小到某个区间内呢？因此，哈希算法就诞生了。

我们首先将这个集合分成若干个存储区域，再对每个对象计算出一个哈希码，根据哈希码，将对象分别放在某个对应的存储区域，这样一个对象根据它的哈希码就可以分到对应的存储区域。当我们在散列存储结构中查询某个对象时，先计算出该对象的哈希值，然后按照哈希值，缩小数据的存储范围，在该范围中进行对比，这样就不必查询所有的数据。

二、为什么说重写了equals方法建议同时重写hashcode方法

在Java中任何一个对象都具备equals(Object obj)和hashCode()这两个方法，因为他们是在Object类中定义的。在Object对象中，equals(Object obj)方法默认使用'=='来判断，比较两个对象在内存中的地址。

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

hashCode()方法是一个本地方法，在Object类中的默认实现“将该对象的内部地址转换成一个整数返回”。

public native int hashCode();

所以，默认情况下，java中的equals方法和hashcode方法作用的都是对象的内存地址。

然后看一张图片

从上面的图中可以看到在散列结构中存储一个对象时，会先进行hashCode值的比较，然后进行equals的比较。

 实际的代码

public V put(K key, V value) {
    return putVal(hash(key), key, value, false, true);
}

final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
			   boolean evict) {
	Node<K,V>[] tab; Node<K,V> p; int n, i;
	if ((tab = table) == null || (n = tab.length) == 0)
		n = (tab = resize()).length;
	if ((p = tab[i = (n - 1) & hash]) == null)
		tab[i] = newNode(hash, key, value, null);
	else {
		Node<K,V> e; K k;
		if (p.hash == hash &&
			((k = p.key) == key || (key != null && key.equals(k))))
			e = p;
		else if (p instanceof TreeNode)
			e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
		else {
			for (int binCount = 0; ; ++binCount) {
				if ((e = p.next) == null) {
					p.next = newNode(hash, key, value, null);
					if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
						treeifyBin(tab, hash);
					break;
				}
				if (e.hash == hash &&
					((k = e.key) == key || (key != null && key.equals(k))))
					break;
				p = e;
			}
		}
		if (e != null) { // existing mapping for key
			V oldValue = e.value;
			if (!onlyIfAbsent || oldValue == null)
				e.value = value;
			afterNodeAccess(e);
			return oldValue;
		}
	}
	++modCount;
	if (++size > threshold)
		resize();
	afterNodeInsertion(evict);
	return null;
}

假如我们重写了equals方法而没有重写hashcode方法，则当两个对象的hashcode值不相同但是equals方法重写之后相同，则会跳过调用equals方法，插入散列集合中，此时就放入了两个equals方法相同的两个对象，但事实上我们不希望存入两个equals方法比较结果相同的对象，这样就产生了一个bug。

三、同一个对象，不要在执行期间修改与hashCode值有关的对象信息，否则会导致内存泄露

public class HashTest {

    public static void main(String[] args) {
        Set<Student> studentSet = new HashSet<>();
        Student s1= new Student("100001", "张三");
        Student s2 = new Student("100002", "李四");
        studentSet.add(s1);
        studentSet.add(s2);
        //修改hashcode相关的属性
        s1.setName("张三丰");
        //移除s1，但是移除不了，因为hashCode变了，找不到s1对象
        studentSet.remove(s1);
        Iterator<Student> iterator = studentSet.iterator();
        while (iterator.hasNext()) {
            Student next = iterator.next();
            System.out.println(next.toString());
        }
    }

    public static class Student {
        private String id;
        private String name;

        public Student(String id, String name) {
            this.id = id;
            this.name = name;
        }

        public String getId() {
            return id;
        }

        public void setId(String id) {
            this.id = id;
        }

        public String getName() {
            return name;
        }

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

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

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

        @Override
        public String toString() {
            return "Student{" +
                    "id='" + id + '\'' +
                    ", name='" + name + '\'' +
                    '}';
        }
    }

}

// 输出结果：
Student{id='100003', name='张三丰'}
Student{id='100002', name='李四'}

假设s1的hashCode为1，s2的hashCode为2，在存储时通过hashcode值，s1被分配在区间A1中，s2被分配在A2中。这时修改了s2中与计算hashCode有关的信息（id和name），当调用remove(Object obj)时，首先会查找该hashCode值的对象是否在集合中。假设s1修改后的hashCode值为3（仍存在区间A1中）,这时通过hashcode值查找结果为空，系统认为该对象不在集合中，所以不会进行删除操作。然而用户以为该对象已经被删除，导致该对象长时间不能被释放，造成内存泄露。

解决该问题的办法是不要在执行期间修改与hashCode值有关的对象信息，如果非要修改，则必须先从集合中删除，然后再加入集合。