Java集合框架之三：HashMap源码解析

版权声明：本文为博主原创文章，转载请注明出处，欢迎交流学习！

      HashMap在我们的工作中应用的非常广泛，在工作面试中也经常会被问到，对于这样一个重要的集合模型我们有必要弄清楚它的使用方法和它底层的实现原理。HashMap是通过key-value键值对的方式来存储数据的，通过put、get方法实现键值对的快速存取，这是HashMap最基本的用法。HashMap底层是通过数组和链表相结合的混合结构来存放数据的。我们通过分析底层源码来详细了解一下HashMap的实现原理。

      1、HashMap的初始化

      在HashMap实例化时我们要了解两个概念：初始容量和加载因子。HashMap是基于哈希表的Map接口实现，初始容量是哈希表在创建时的容量。加载因子是哈希表在其容量自动增加之前可以达到多满的一种尺度。当哈希表中的条目数超过了加载因子与当前容量的乘积时，则要对该哈希表进行rehash操作（即重建内部数据结构），从而哈希表将具有大约两倍于当前容量的新的容量。

       

       以上是Java API中HashMap的构造方法，其源码如下：

       

static final int DEFAULT_INITIAL_CAPACITY = 16;//默认初始容量16
static final int MAXIMUM_CAPACITY = 1 << 30;//定义最大容量
static final float DEFAULT_LOAD_FACTOR = 0.75f;//默认负载因子0.75
transient Entry[] table;
int threshold; //临界值，值为容量与加载因子的乘积
final float loadFactor; //加载因子

public HashMap() {
        this.loadFactor = DEFAULT_LOAD_FACTOR;
        threshold = (int)(DEFAULT_INITIAL_CAPACITY * DEFAULT_LOAD_FACTOR);
        table = new Entry[DEFAULT_INITIAL_CAPACITY];
        init();
    }

void init() {
    }

       以上构造方法定义了一个空的HashMap，其默认初始容量为16，默认初始加载因子为0.75，同时声明了一个Entry类型的数组，数组初始长度为16。那么这里出现的Entry对象是如何定义的呢？看一下它的实现代码：

       

    static class Entry<K,V> implements Map.Entry<K,V> {
        final K key;
        V value;
        Entry<K,V> next; //指向下一个Entry节点
        final int hash; //哈希值

        /**
         * Creates new entry.
         */
        Entry(int h, K k, V v, Entry<K,V> n) {
            value = v;
            next = n;
            key = k;
            hash = h;
        }

        public final K getKey() {
            return key;
        }

        public final V getValue() {
            return value;
        }

        public final V setValue(V newValue) {
        V oldValue = value;
            value = newValue;
            return oldValue;
        }
        //重写equals方法，判断两个Entry是否相等，如果两个Entry对象的key和value相等，则返回true，否则返回false
        public final boolean equals(Object o) {
            if (!(o instanceof Map.Entry))
                return false;
            Map.Entry e = (Map.Entry)o;
            Object k1 = getKey();
            Object k2 = e.getKey();
            if (k1 == k2 || (k1 != null && k1.equals(k2))) {
                Object v1 = getValue();
                Object v2 = e.getValue();
                if (v1 == v2 || (v1 != null && v1.equals(v2)))
                    return true;
            }
            return false;
        }
        //重写hashCode方法，返回key的hashCode值与value的hashCode值异或运算所得的值
        public final int hashCode() {
            return (key==null   ? 0 : key.hashCode()) ^
                   (value==null ? 0 : value.hashCode());
        }
        //重写toString方法，返回此Entry对象的“key=value”映射关系
        public final String toString() {
            return getKey() + "=" + getValue();
        }

        /**
         * This method is invoked whenever the value in an entry is
         * overwritten by an invocation of put(k,v) for a key k that's already
         * in the HashMap.
         */
        void recordAccess(HashMap<K,V> m) {  //当向HashMap中添加键值对时，会调用此方法，这里方法体为空，即不做处理
        }

        /**
         * This method is invoked whenever the entry is
         * removed from the table.
         */
        void recordRemoval(HashMap<K,V> m) {   //当向HashMap中删除键值对映射关系时，会调用此方法，这里方法体为空，即不做处理
        }
    }

       Entry类是HashMap的内部类，其实现了Map.Entry接口。Entry类里定义了4个属性：Object类型的key、value(K、V类型可以看成Object类型)，Entry类型的next属性（这个next其实就是一个指向下一个Entry对象的引用，形成了一个链表，通过此Entry对象的next属性可以找到其下一个Entry对象）和int型的hash值。HashMap底层维护的就是一个个Entry对象。在Entry类里还重写了equals方法，若两个Entry的key和value都相等，则返回true，否则返回false，同时还重写了hashCode方法。

       2、HashMap的底层数据结构

       前面提到过HashMap的底层是基于数组和链表来实现的，那么如何决定一个Entry对象是存放在数组中的哪个位置的呢？它是通过计算hash值来决定存储位置的，同时在查找元素的时候同样也是计算出一个值来找到对应的位置，因此它具有相当快的查询速度。HashMap是根据key的hashCode值来计算hash值的，相同的hashCode值计算出来的hash值也是相同的。当存储的对象达到了一定数量，就有可能出现不同对象的key的hashCode值是相同的，因此计算出来的hash值也相同，这样就出现了冲突。哈希冲突的解决方法有很多，比如再哈希法，这种方法是同时构造多个不同的哈希函数，当发生冲突时就换另外的函数重新计算hash值，直到不再产生冲突为止。HashMap是通过单链表来解决哈希冲突的，这种方法也被称为拉链法。如图所示：

                              

       在上图中，左边的部分是哈希表（也称为哈希数组），右边是一个单链表，单链表是用来解决哈希冲突的，数组里的每一个元素都是一个单链表的头节点，当不同的key计算出的数组中的存放位置相同时，就将此对象添加到单链表中。

       3、数据存储

       在HashMap中定义了put方法来向集合中添加数据，数据以键值对的形式存储，put方法的实现如下：

       

public V put(K key, V value) {
          //如果存入HashMap的key为null，则将该键值对添加到table[0]中
        if (key == null)
            return putForNullKey(value);
        //key不为null，调用hash方法计算key的hashCode值对应的hash值
        int hash = hash(key.hashCode());
        //根据计算出的hash值，结合数组的长度计算出数组中的插入位置i
        int i = indexFor(hash, table.length);
        //遍历数组下标为i处的链表，如果链表上存在元素，其hash值与上述计算得到的hash值相等，
        //并且其key值与新增的键值对的key值相等，那么就以新增键值对的value替换此元素的value值，
        //并返回此元素原来的value
        for (Entry<K,V> e = table[i]; e != null; e = e.next) {
            Object k;
            if (e.hash == hash && ((k = e.key) == key || key.equals(k))) {
                V oldValue = e.value;
                e.value = value;
                e.recordAccess(this);
                return oldValue;
            }
        }

        modCount++; //操作次数加1
        //如果链表上不存在满足条件的元素，则将键值对对应生成的Entry对象添加到table[i]处，
        //并将下标为i处原先的Entry对象链接到新的Entry对象后面
        addEntry(hash, key, value, i);
        return null;
    }



private V putForNullKey(V value) {
         //遍历数组下标为0处的链表，如果链表中存在元素其key为null，则用value覆盖此元素原来的value
        for (Entry<K,V> e = table[0]; e != null; e = e.next) {
            if (e.key == null) {
                V oldValue = e.value;
                e.value = value;
                e.recordAccess(this);
                return oldValue;
            }
        }
        modCount++; //操作数加1
        //如果链表中不存在满足条件的元素，则将此键值对生成的Entry对象存放到table[0]
        addEntry(0, null, value, 0);//key为null，计算出的hash值为0
        return null;
    }


//计算hash值
static int hash(int h) {
        // This function ensures that hashCodes that differ only by
        // constant multiples at each bit position have a bounded
        // number of collisions (approximately 8 at default load factor).
        h ^= (h >>> 20) ^ (h >>> 12);
        return h ^ (h >>> 7) ^ (h >>> 4);
    }



//根据hash值和数组长度，计算出在数组中的索引位置 
    static int indexFor(int h, int length) {
        return h & (length-1); //计算出的值不会超出数组的长度
    }



void addEntry(int hash, K key, V value, int bucketIndex) {
          //获取table[bucketIndex]处的Entry对象
          Entry<K,V> e = table[bucketIndex];
          //根据key-value生成新的Entry对象，并将新的Entry对象存入table[bucketIndex]处，将其next引用指向原来的对象
        table[bucketIndex] = new Entry<K,V>(hash, key, value, e);
        //如果数组容量大于或等于临界值，则进行扩容
        if (size++ >= threshold)
            resize(2 * table.length); //容量为原来的2倍
    }

       以上就是put方法的实现原理，我给出了详细的代码注释。上面已经讲到过HashMap底层的数据结构是由数组和单向链表构成的，当我们向HashMap中put一对key-value键值对时，首先判断key是否为null，如果为null，则遍历table[0]处的链表，若此链表上存在key为null的元素，则用value覆盖此元素的value值，如果不存在这样的元素，那么将此键值对生成的Entry对象存放到table[0]中；如果key不为null，首先根据key的hashCode值计算出hash值，根据hash值和数组长度计算出要存放到数组中的位置i，然后遍历table[i]处的链表，如果链表上存在元素其hash值与计算得到的hash值相等并且其key值与新增的key相等，那么就以新增的value覆盖此元素原来的value并返回原来的value值；如果链表上不存在满足上面条件的元素，则将key-value生成的Entry对象存放到table[i]处，并将其next指向此处原来的Entry对象。这样经过多次put操作，就构成了数组加链表的存储结构。

       4、数据读取

       HashMap的get方法可以根据key返回其对应的value，如果key为null，则返回null。

       

public V get(Object key) {
          //如果key为null，则循环table[0]处的单链表
        if (key == null)
            return getForNullKey();
        //key不为null，根据key的hashCode计算出一个hash值    
        int hash = hash(key.hashCode());
        //根据hash值和数组长度计算出一个数组下标值，并且遍历此下标处的单链表
        for (Entry<K,V> e = table[indexFor(hash, table.length)];
             e != null;
             e = e.next) {
            Object k;
            //如果Entry对象的hash值跟上面计算得到的hash值相等，并且key也相等，那么就返回此Entry对象value
            if (e.hash == hash && ((k = e.key) == key || key.equals(k)))
                return e.value;
        }
        //如果单链表上不存在满足上述条件的Entry对象，则表明HashMap不包含该key的映射关系，返回null
        return null;
    }



private V getForNullKey() {
          //获取table[0]处的Entry对象，并循环其链接的单链表，如果单链表上存在不为null的对象，
          //并且其key为null，那么就返回此对象的value
        for (Entry<K,V> e = table[0]; e != null; e = e.next) {
            if (e.key == null)
                return e.value;
        }
        //如果单链表上不存在满足条件的对象，则返回null
        return null;
    }

       了解了put方法的原理，我们就不难理解get的实现原理了，与之类似也是要根据key的hashCode值来计算出一个hash值，然后根据hash值和数组长度计算出一个数组下标值，接着循环遍历此下标处的单链表，寻找满足条件的Entry对象并返回value，此value就是HashMap中该key所映射的value。注意分析当key为null时的情况：如果HashMap中有key为null的映射关系，那么就返回null映射的value，否则就表明HashMap中不存在key为null的映射关系，返回null。同理，当get方法返回的值为null时，并不一定表明该映射不包含该键的映射关系，也可能是该映射将该键显示的映射为null，即put(key, null)。可使用containKey方法来区分这两种情况。

       5、移除映射关系

       remove方法根据指定的key从HashMap映射中移除相应的映射关系（如果存在），此方法返回一个value。

       

public V remove(Object key) {
        Entry<K,V> e = removeEntryForKey(key);
        return (e == null ? null : e.value);
    }



final Entry<K,V> removeEntryForKey(Object key) {
          //根据key的hashCode计算hash值
        int hash = (key == null) ? 0 : hash(key.hashCode());
        //根据hash值和数组长度计算数组下标值i
        int i = indexFor(hash, table.length);
        //获取下标为i处的数组元素
        Entry<K,V> prev = table[i];
        Entry<K,V> e = prev;
        //遍历数组下标为i处的单链表
        while (e != null) {
            Entry<K,V> next = e.next;
            Object k;
            //如果此单链表上存在Entry对象e，其hash值与计算出的hash值相等并且其key也跟传入的key"相等"，则从单链表上移除e
            if (e.hash == hash &&
                ((k = e.key) == key || (key != null && key.equals(k)))) {
                modCount++;
                size--; //map中的映射数减1
                //判断满足条件的Entry对象是在数组下标i处还是在数组外面的单链表上
                if (prev == e)
                    table[i] = next;
                else
                    prev.next = next;
                e.recordRemoval(this);
                return e;
            }
            prev = e;
            e = next;
        }

        return e;
    }

       从上面的源码可以看出，remove方法的原理是先找出满足条件的Entry对象，然后从单链表上删除该对象，并返回该对象中的value，本质上是对单链表的操作。

       6、总结

       从以上源码的分析中我们知道了HashMap底层维护的是数组加链表的混合结构，这是HashMap的核心，只要掌握了这一点我们就能很容易弄清楚HashMap中映射关系的各种操作原理，其本质是对数组和链表的操作。要注意的是HashMap不是线程安全的，我们可以使用Collections.synchoronizedMap方法来获得线程安全的HashMap。例如：

       Map map = Collections.sychronizedMap(new HashMap());

       以上是我个人对HashMap底层原理的一点理解，不妥的地方欢迎指正！