HashMap源码调试——认识"put"操作

前言：通常大家都知道HashMap的底层数据结构为数组加链表的形式，但其put操作具体是怎样执行的呢，本文通过调试HashMap的源码来阐述这一问题。

注：jdk版本：jdk1.7.0_51

---

1.put源码

public V put(K key, V value) {
        if (table == EMPTY_TABLE) {
            inflateTable(threshold);
        }
        if (key == null)
            return putForNullKey(value);
        int hash = hash(key);
        int i = indexFor(hash, table.length);
        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++;
        addEntry(hash, key, value, i);
        return null;
    }

下面通过对源码调试具体说明put操作的流程。

2.具体调试过程

public class CodeTest04
{
    public static void main(String[] args)
    {
        String keyAa = "Aa";
        String keyBB = "BB";

        System.out.println("keyAa hashCode=" + keyAa.hashCode());
        System.out.println("keyBB hashCode=" + keyBB.hashCode());

        HashMap<String, String> hashMap = new HashMap<String, String>();

        hashMap.put(keyAa, "abc");
//        hashMap.put(keyBB, "abc");
        hashMap.put(keyAa, "cba");
        hashMap.put(keyAa,"def");
        
        System.out.println(hashMap);

    }
}

说明：

①不同内容的字符串，其hashCode是可能相等的。如字符串“Aa”和“BB”的hashCode相等（都是2112）。

②当执行上述代码13行和15、16行的时候，结果如下：

③当执行上述代码13行和14行时，结果如下：

通过上述结果，可得出如下结论：

①在key的hashCode相等，且key也相同的情况下，HashMap在执行put操作的时候，会进行覆盖操作，新值将覆盖旧值，所以最后输出为"{Aa=def}"。

②在key的hashCode相等，但key不相同（如"Aa"与"BB"）的情况下，HashMap在执行put操作的时候，就会进行链表式存储，并且采用的是头插法，即新值处于链表头，最开始的值处于链表尾。

#1.对于第一个结论，通过下面这段源码可以很清晰的了解其流程：

#2.对于第二个结果，key的hashCode相等，但key不同的情况，通过调试描述put的过程。

通过debug可以非常清晰的看出：当前hashmap中存在一对键值{"Aa"->"abc"}，其key的hash值为2112，在put("BB","abc")的时候，发现其hash值也是2112，出现上文中描述的情况（key的hashCode值相等，当key的内容不同），因此会直接跳转。

注意i的值，这里的i表示put元素在hashmap底层数据结构中的索引值（可简单想象成元素在数组上的索引），因为"Aa"与"BB"的hashCode值相同，因此两次i的值都是4。我们进入addEntry函数。

由于我们这里不需要扩容，因此会创建新的元素，注意此时桶的index为4，但是当前位置上已经存在"Aa"的键值对了，进入该函数。

这里可以清晰的看出，会取出之前bucketIndex=4上的键值对，也就是{"Aa"->"abc"}，然后new一个Entry。

关键过程：把当前bucketIndex=4的值替换成了{"BB"->"abc"}，并将其next的值赋值为{"Aa"->"abc"}，这里就完成了头插法。

总结

HashMap在进行put操作时，会有如下操作：

1）在key的hashCode相等，且key的内容也相同的情况下（两次"Aa"），就会对value值进行覆盖。

2）在key的hashCode相等，但key的内容不相同的情况下（"Aa","BB"），会进行链式存储，并且是头插法，新加的值（"BB"）在链表头，最开始（"Aa"）的值在链表尾。

3）在key的hashCode不相等的情况，直接进行散列存储。

4）从上述调试过程也发现，HashMap主要是以key为主，value相当于key的一个附属值，因为value随key走的。

---

by Shawn Chen，2018.6.8日，晚。