HashMap源码阅读

继承树

注意下方的"元素"二字

按照习惯，先看构造函数和第一次添加
首先无参的构造函数

让过载因子等于0.75

public HashMap() {
    this.loadFactor = DEFAULT_LOAD_FACTOR; // all other fields defaulted
}

然后是put函数,调用了内部的putval函数

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

在看这个方法之前,要先知道HashMap中存储元素的类型
内部类Node<K,V>
首先,HashMap的键值对,保存在内部类Node<K,V>中
它内部有四个属性

final int hash;
final K key;
V value;
Node<K,V> next;

hash用来保存hash值,next是处理Hash冲突用的
方法有:

四个参数的构造器
Key和Value的getter
toString
hashCode
setValue
equals

**table

保存数据的实际数组就是Node<K,V>[] table

putVal方法,通过注释解释
大致逻辑就是,如果占用的散列地址已经超过了负载容量,并且新插入元素的负载地址已经有元素了,那么开启扩容
当onlyIfAbsent为false时:
在对应的散列地址中寻找有没有Key相同的元素,如果有,相应的value取而代之,返回旧的value
如果没有,将元素插入链表末尾,如果链表长度在插入后大于等于8,则将链表变为树型结构
当onlyIfAbsent为true时:
找到了Key相同的元素就直接返回,不会替换

final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
               boolean evict) {
    //onlyIfAbsent仅在key不存在时插入

    Node<K,V>[] tab; Node<K,V> p; int n, i;
    //数组为空或者长度为0,则重新构造数组
    if ((tab = table) == null || (n = tab.length) == 0)
        n = (tab = resize()).length;


    //要插入的散列地址为空,则直接插入
    //这里p被赋值为要插入散列地址的第一个元素引用
    if ((p = tab[i = (n - 1) & hash]) == null)
        tab[i] = newNode(hash, key, value, null);
    //要插入的散列地址不为空,查找有没有key值相同的元素
    //注意这个分支里面最后有return
    else {
        Node<K,V> e; K k;
        //如果首个元素的key是要插入的新元素的key,将e赋值为p
        //e是和新元素key相同的元素
        //树状节点是什么呢?就是在同一个散列地址插入的元素过多时,会导致链表过长
        //这是table中的一个节点就会变成树,减少查询时间
        if (p.hash == hash &&
            ((k = p.key) == key || (key != null && key.equals(k))))
            e = p;
        //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) {
                    //如果找到末尾还是没有找到key相同的,则把新元素插入到末尾
                    p.next = newNode(hash, key, value, null);
                    //链表中的元素大于等于8了,那就将其转换为树
                    if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
                        treeifyBin(tab, hash);
                    break;
                }
                //如果找到了key相同的
                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;
            //LinkedHashMap留用
            afterNodeAccess(e);
            return oldValue;
        }
    }
    //没有找到Key值是一样的,标记进行了增删操作
    ++modCount;
    //如果已经利用的table中散列地址的数量超过了负载容量,则扩容
    //也就是说,如果没有找到
    if (++size > threshold)
        resize();
    //LinkedHashMap留用
    afterNodeInsertion(evict);
    return null;
}

让我们在探讨一下putVal调用的方法

resize()
主要逻辑就是先计算出新的容量(*2)和新的负载容量,然后将原来的元素重新插入到散列表中

final Node<K,V>[] resize() {
    Node<K,V>[] oldTab = table;
    int oldCap = (oldTab == null) ? 0 : oldTab.length;
    int oldThr = threshold;
    int newCap, newThr = 0;

    //如果原来的容量>0
    if (oldCap > 0) {
        if (oldCap >= MAXIMUM_CAPACITY) {
            threshold = Integer.MAX_VALUE;
            return oldTab;
        }
        else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&
                 oldCap >= DEFAULT_INITIAL_CAPACITY)
            //新的负载容量变为2倍
            newThr = oldThr << 1; // double threshold
    }
    //如果原来的负载容量大于0
    else if (oldThr > 0) // initial capacity was placed in threshold
        newCap = oldThr;
    else {               // zero initial threshold signifies using defaults
        //使用默认配置
        newCap = DEFAULT_INITIAL_CAPACITY;
        newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
    }
    if (newThr == 0) {
        float ft = (float)newCap * loadFactor;
        newThr = (newCap < MAXIMUM_CAPACITY && ft < (float)MAXIMUM_CAPACITY ?
                  (int)ft : Integer.MAX_VALUE);
    }
    threshold = newThr;
    @SuppressWarnings({"rawtypes","unchecked"})
    //创建数组,重新插入
    Node<K,V>[] newTab = (Node<K,V>[])new Node[newCap];
    table = newTab;
    if (oldTab != null) {
        for (int j = 0; j < oldCap; ++j) {
            Node<K,V> e;
            //如果当前这个散列地址非空
            if ((e = oldTab[j]) != null) {
                oldTab[j] = null;
                //如果散列地址上只有一个元素,则直接将这个元素放在新的散列地址上
                if (e.next == null)
                    newTab[e.hash & (newCap - 1)] = e;
                else if (e instanceof TreeNode)
                    ((TreeNode<K,V>)e).split(this, newTab, j, oldCap);
                else { // preserve order
                //经过计算,散列地址应该在
                //[0,oldCap)范围内的,放入low的链表
                //[oldCap,oldCap*2)范围内的,放入high的链表
                    Node<K,V> loHead = null, loTail = null;
                    Node<K,V> hiHead = null, hiTail = null;
                    Node<K,V> next;
                    do {
                        next = e.next;
                        if ((e.hash & oldCap) == 0) {
                            if (loTail == null)
                                loHead = e;
                            else
                                loTail.next = e;
                            loTail = e;
                        }
                        else {
                            if (hiTail == null)
                                hiHead = e;
                            else
                                hiTail.next = e;
                            hiTail = e;
                        }
                    } while ((e = next) != null);
                    //把low和high放入相应的散列位置中去
                    if (loTail != null) {
                        loTail.next = null;
                        newTab[j] = loHead;
                    }
                    if (hiTail != null) {
                        hiTail.next = null;
                        newTab[j + oldCap] = hiHead;
                    }
                }
            }
        }
    }
    return newTab;
}

接下来就是精彩绝伦的树型结构了,听起来就很可怕
首先,我们需要打开百度,看看HashMap使用哪种数据结构,然后把这个数据结构的大致算法看懂,最好能自己写出来

final void treeifyBin(Node<K,V>[] tab, int hash) {
    int n, index; Node<K,V> e;
    //容量大于64的时候才会触发树节点哦
    if (tab == null || (n = tab.length) < MIN_TREEIFY_CAPACITY)
        resize();
    else if ((e = tab[index = (n - 1) & hash]) != null) {
        //head与tail
        TreeNode<K,V> hd = null, tl = null;
        //生成一个树节点的简单链表
        do {
        //返回一个新的树型节点
            TreeNode<K,V> p = replacementTreeNode(e, null);
            if (tl == null)
                hd = p;
            else {
                p.prev = tl;
                tl.next = p;
            }
            tl = p;
        } while ((e = e.next) != null);

        //真正地构建一颗红黑树
        //内部逻辑就和我上一篇写的代码差不多,大同小异
        //这里先挖个坑,以后再来看吧
        if ((tab[index] = hd) != null)
            hd.treeify(tab);
    }
}

虽然我没有确切地分析treeify方法,但是还是说一下内部大致逻辑:
1.如果树里面还什么都没有,那就将插入的点作为root
2.把这颗树当做普通搜索二叉树,找到新节点应该插入的位置,并将其插入
3.进行必要的平衡操作:balanceInsertion()方法

在比较时,将hash值作为key和判断大小的依据
当hash值相等时,用到了comparableClassFor()和compareComparables()方法来操作
第一个方法是返回能够使用Comparable接口来判断大小,如果能,则使用第二个方法,如果不能或者判断结果仍然是相等,则使用tieBreakOrder()方法进行判断

这就是一个基本的插入流程了.
让我们回头看一下一些注意点

构造器
无参构造器,负载因子指定为默认值

public HashMap() {
    this.loadFactor = DEFAULT_LOAD_FACTOR; // all other fields defaulted
}

public HashMap(int initialCapacity, float loadFactor) {
    //这些if用于判断的参数是否合法
    if (initialCapacity < 0)
        throw new IllegalArgumentException("Illegal initial capacity: " +
                                           initialCapacity);
    if (initialCapacity > MAXIMUM_CAPACITY)
        initialCapacity = MAXIMUM_CAPACITY;
    if (loadFactor <= 0 || Float.isNaN(loadFactor))
        throw new IllegalArgumentException("Illegal load factor: " +
                                           loadFactor);
   
    this.loadFactor = loadFactor;
    //注意这里没有构建table,看了这里再回头resize方法可能有新的理解哦
    //tableSizeFor是确定一个真正的容量值,这个操作使得:
    //HashMap的table数组长度,只能是2的幂次
    this.threshold = tableSizeFor(initialCapacity);
}

指定容量,负载因子指定为默认值

public HashMap(int initialCapacity) {
    this(initialCapacity, DEFAULT_LOAD_FACTOR);
}

让我们来分析一下这个方法

//这是在干啥QAQ
//实际上就是把从最高位的1开始
//将低位全部置为1
//让后加1返回.
//将cap写成二进制数,手动模拟一下就可以看得很清楚了
//因为1+2+4+8+16 = 31
//所以刚好处理int正数
static final int tableSizeFor(int cap) {
    int n = cap - 1;
    n |= n >>> 1;
    n |= n >>> 2;
    n |= n >>> 4;
    n |= n >>> 8;
    n |= n >>> 16;
    return (n < 0) ? 1 : (n >= MAXIMUM_CAPACITY) ? MAXIMUM_CAPACITY : n + 1;
}

key与value集合
HashMap提供了keySet()方法,返回一个set包含了所有key值
观察这个方法可以发现,如果HashMap的成员变量keySet不为空,那么直接放回,否则生成一个keyset
但是这个类何时更新,怎么赋值,我都没找到源码,说是诡异一点都不过分
values()方法也一样,HashMap还提供了entrySet()方法,都是大同小异的

hash
众所周知,hash是将一个对象映射为一个正整数,对象千变万化而hash值范围有限,所以可能出现多个对象对应一个正整数的情况
在Object中,有public native int hashCode();这样一个方法,它的实现我们不知道是什么,但是可以猜测,因为定义在Object内,应该与对象的属性无关,而与类型,地址等可能有关.
String等类重写了hashcode方法,如果自定义类也想放入HashMap也需要重写hashcode方法,当然还有equals方法.但是由于这两方法都定义在Object中,所以不写也不会报错

HashMap中,不仅仅是简单地调用了对象的hashcode方法
比如

static final int hash(Object key) {
    int h;
    return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
}

这个方法在public V put(K key, V value)中被调用了
它实际上是将key的hashval处理了一下
但是为什么要这么处理呢?
这是一种hash扰动,如果只有高位不等,低位相等时,hash&(length-1),当length<2^16时就会相等,为了避免这种情况,于是高位与低位异或,使得低位与高位相关联.
那么能让本来低位一样的两个hash值变得低位不一样,当然也是有可能让本来两个低位不等的hash值变得低位相等的
但是hashcode这么写仍然很有必要,因为key可能是自定义的,你自己重写的hashcode方法可能有失水准
多嘴一句,在HashMap中,对数组长度取模,用的是&运算哦