HashMap(JDK1.8)源码分析

一、构造函数

//initialCapacity 初始大小
//loadFactor 初始化负债因子
//threshold 阈值
public HashMap(int initialCapacity, float loadFactor) {
    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;
    this.threshold = tableSizeFor(initialCapacity);
}
//返回大于输入参数且最近的2的整数次幂的数。
//例如 cap=10 n=cap-1=9 
//转换二进制 n=1001
//对n右移1位 n=01001 再和原n 位或即 n=11011
//对n右移2位 n=0011011 再和原n 位或即 n=1111111
//接着右移4位再 位或 后可得 11个1
//综上可得，该算法让最高位的1后面的位全变为1。
//最后在让得到的结果 +1，也就得到2的整数次幂

//现在看一下int n = cap - 1
//让cap-1再赋值给n的目的是令 找到的目标值 大于或等于原值
//例如二进制1000，十进制数值为8。如果不对它减1而直接操作，将得到答案10000，即16。
//显然不是结果。减1后二进制为111，再进行操作则会得到原来的数值1000，即8。
//比如10，则返回16
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;
}
//不过在构造函数中 threshold 只是初始化一下，在resize()方法中会重新赋值
//应该是 threshold = LOAD_FACTOR * INITIAL_CAPACITY 

二、核心方法 put()

public V put(K key, V value) {
    return putVal(hash(key), key, value, false, true);
}
//先看key的hash方法
//关键点在key的hash值与 hash值右移16位的值做 异或运算，
//也就是高位做了异或运算，接着看下面的方法
static final int hash(Object key) {
    int h;
    return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
}
//根据key的哈希值来决定在散列中的位置，初始容量是16，放到散列中，就是0-15的位置
//也就是 tab[i = (n - 1) & hash] 中(n - 1) & hash 是位置所在，
//可以发现，在做 与 运算时，只有后四位，也就是低位有效
//这样，当key的哈希值高位变化很大，低位变化很小时，会导致Hash值相同情况增多。
final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
               boolean evict) {
    Node<K,V>[] tab; Node<K,V> p; int n, i;
    //当散列为null时，调用resize()初始化散列
    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;
        //p 链表的首节点
        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) {
                //如果下个节点为null，也就是到链表尾部了。
                if ((e = p.next) == null) {
                    //直接构造新节点，并插入链表中
                    p.next = newNode(hash, key, value, null);
                    //如果节点总数大于8位，就把链表转成红黑树
                    if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
                        treeifyBin(tab, hash);
                    break;
                }
                //如果找到了和插入值相同的key，则退出循环，并记录下当前节点
                //在接下来的方法中，用新插入的value，替换现有的value
                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;
}

三、扩容

final Node<K,V>[] resize() {
    //旧散列数组
    Node<K,V>[] oldTab = table;
    //旧散列的容量
    int oldCap = (oldTab == null) ? 0 : oldTab.length;
    int oldThr = threshold;
    int newCap, newThr = 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，并且阈值大于0，则数组的新容量为老数组的阈值
    else if (oldThr > 0) // initial capacity was placed in threshold
        newCap = oldThr;
    else {               // zero initial threshold signifies using defaults
        //使用默认值，容量为16，
        newCap = DEFAULT_INITIAL_CAPACITY;
        //阈值为(扩容因子*默认容量）16*0.75=12
        newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
    }
    //如果构造函数初始化时，设置容量为0，阈值大于0，导致新容量为0
    if (newThr == 0) {
        float ft = (float)newCap * loadFactor;
        //则新容量为 新容量(老阈值*扩容因子) 或者 2^31 - 1
        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
                // 进行链表复制
				// 方法比较特殊： 它并没有重新计算元素在数组中的位置(1.7是重新hash)
				// 而是采用了 原始位置加原数组长度的方法计算得到位置
                    Node<K,V> loHead = null, loTail = null;
                    Node<K,V> hiHead = null, hiTail = null;
                    Node<K,V> next;
                    do {
                        next = e.next;
                        // (e.hash & oldCap) 得到的是 元素的在数组中的位置是否需要移动,示例如下
						// 示例1：
						// e.hash=3     0000 0011
						// oldCap=8     0000 1000
						//	 &   =0	    0000 0000       
						//结论：元素位置在扩容后数组中的位置没有发生改变
						
						// 示例2：
						// e.hash=11    0000 1011
						// oldCap=8     0000 1000
						//	 &   =1	    0000 1000      
						
						//比如oldCap=8,hash是3，11，19，27时，
						//(e.hash & oldCap)的结果是0，8，0，8，
						//这样3，19组成新的链表，index为3；
						//而11，27组成新的链表，新分配的index为3+8；
           
                        //两种结果，一个是0，一个是oldCap
                        //为0，说明还是原索引，将符合结果的元素组建成为新的链表lo
                        if ((e.hash & oldCap) == 0) {
                            if (loTail == null)
                                loHead = e;
                            else
                                loTail.next = e;
                            loTail = e;
                        }
                        // 原索引+oldCap，不符合组建成为链表hi
                        else {
                            if (hiTail == null)
                                hiHead = e;
                            else
                                hiTail.next = e;
                            hiTail = e;
                        }
                    } while ((e = next) != null);
                    // 原索引放到链表里
                    if (loTail != null) {
                        loTail.next = null;
                        newTab[j] = loHead;
                    }
                    // 原索引+oldCap放到bucket里
                    if (hiTail != null) {
                        hiTail.next = null;
                        newTab[j + oldCap] = hiHead;
                    }
                }
            }
        }
    }
    return newTab;
}

四、相比较而言简单的get()

public V get(Object key) {
    Node<K,V> e;
    return (e = getNode(hash(key), key)) == null ? null : e.value;
}

final Node<K,V> getNode(int hash, Object key) {
    Node<K,V>[] tab; Node<K,V> first, e; int n; K k;
    //散列列表不为null并且length大于0
    if ((tab = table) != null && (n = tab.length) > 0 &&
        //所在位置不为null
        (first = tab[(n - 1) & hash]) != null) {
        //如果首位就是需要的值
        if (first.hash == hash && // always check first node
            ((k = first.key) == key || (key != null && key.equals(k))))
            return first;
        if ((e = first.next) != null) {
            //首位不是需要的值，如果是红黑树就在红黑树中查找
            if (first instanceof TreeNode)
                return ((TreeNode<K,V>)first).getTreeNode(hash, key);
            do {
            //否则就去链表中找
                if (e.hash == hash &&
                    ((k = e.key) == key || (key != null && key.equals(k))))
                    return e;
            } while ((e = e.next) != null);
        }
    }
    return null;
}

五、remove()

//和get()逻辑基本相同
public V remove(Object key) {
    Node<K,V> e;
    return (e = removeNode(hash(key), key, null, false, true)) == null ?
        null : e.value;
}
//
final Node<K,V> removeNode(int hash, Object key, Object value,
                           boolean matchValue, boolean movable) {
    Node<K,V>[] tab; Node<K,V> p; int n, index;
    //散列列表不为null并且length大于0
    if ((tab = table) != null && (n = tab.length) > 0 &&
        //所在位置不为null
        (p = tab[index = (n - 1) & hash]) != null) {
        Node<K,V> node = null, e; K k; V v;
        //如果首位就是需要的值
        if (p.hash == hash &&
            ((k = p.key) == key || (key != null && key.equals(k))))
            node = p;
        else if ((e = p.next) != null) {
            //否则就去红黑树或者链表中找到对应的值
            if (p instanceof TreeNode)
                node = ((TreeNode<K,V>)p).getTreeNode(hash, key);
            else {
                do {
                    if (e.hash == hash &&
                        ((k = e.key) == key ||
                         (key != null && key.equals(k)))) {
                        node = e;
                        break;
                    }
                    p = e;
                } while ((e = e.next) != null);
            }
        }
        if (node != null && (!matchValue || (v = node.value) == value ||
                             (value != null && value.equals(v)))) {
            //执行移除操作
            if (node instanceof TreeNode)
                //红黑树移除
                ((TreeNode<K,V>)node).removeTreeNode(this, tab, movable);
            else if (node == p)
                //链表
                tab[index] = node.next;
            else
                //在首位
                p.next = node.next;
            ++modCount;
            --size;
            afterNodeRemoval(node);
            return node;
        }
    }
    return null;
}