对象作为HashMap的键

写这篇文章起源于一道面试题，如何将自定义的类对象作为key存储到HashMap中，即考虑怎么判断key的唯一性。
首先，我们看以下HashMap中put(...)方法的源码：

    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;
    }

关注插入判断的这一行代码：

 if (p.hash == hash &&((k = p.key) == key || (key != null && key.equals(k))))

可以看到HashMap是通过验证hashCode和key的相等两个步骤保证key的唯一性的。

所以要想实现对象作为键插入，则需要重写hashCode()和equals()方法，以下给出示例：

package com.zhangcf.hashmap;

import java.util.HashMap;
import java.util.Map;

class Student{
    private String name;
    private int age;

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

    public String getName() {
        return name;
    }

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

    public int getAge() {
        return age;
    }

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

    @Override
    public int hashCode() {
        int result = 31;
        result = result * 31 + age;
        result = result + 31 + ((name == null) ? 0:(name.hashCode()));
        return result;
    }

    @Override
    public boolean equals(Object obj) {
        return this.name.equals(((Student)obj).name) && (this.age == ((Student)obj).age);
    }
}

public class HashMapTest {
    public static void main(String[] args) {
        Student student = new Student("jack",23);

        Map<Student, Integer> map = new HashMap<>();
        map.put(student, 1);

        System.out.println(map.get(new Student("jack",23)));
    }
}

这样就保证了属性相同的对象，即使不是同一对象也能存储在同一个key里面。

在重写以上两个方法之后，有关hashCode和equals两者的关系有这样的说法：

对于两个对象，

• 如果调用equals方法得到的结果为true，则两个对象的hashcode值必定相等；
• 如果equals方法得到的结果为false，则两个对象的hashcode值不一定不同；
• 如果两个对象的hashcode值不等，则equals方法得到的结果必定为false；
• 如果两个对象的hashcode值相等，则equals方法得到的结果未知。

在重写hashCode函数时，有以下规则：
hashCode函数的通项如下：

public int hashCode() {
  int result = 17;  //任意素数
 result = 31*result +c1; //c1,c2是什么看下文解释
  result = 31*result +c2;
  return result;
}

其中c1，c2是我们生成的你要计算在内的字段的代码，生成规则如下：

• 如果字段是boolean 计算为(f?1:0);
• 如果字段是byte,char,short,int则计算为 (int)f;
• 如果字段是long 计算为 (int)(f^(f>>32));
• 如果字段是float 计算为 Float.floatToLongBits(f);
• 如果字段是一个引用对象，那么直接调用对象的hashCode方法，如果需要判空，可以加上如果为空就返回0;