深入理解Java中的HashMap

//hash桶中的结点Node,实现了Map.Entry
static class Node<K,V> implements Map.Entry<K,V> {
    final int hash;
    final K key;
    V value;
    Node<K,V> next; //链表的next指针
    Node(int hash, K key, V value, Node<K,V> next) {
        this.hash = hash;
        this.key = key;
        this.value = value;
        this.next = next;
    }
    public final K getKey()        { return key; }
    public final V getValue()      { return value; }
    public final String toString() { return key + "=" + value; }
    //重写Object的hashCode
    public final int hashCode() {
        return Objects.hashCode(key) ^ Objects.hashCode(value);
    }
    public final V setValue(V newValue) {
        V oldValue = value;
        value = newValue;
        return oldValue;
    }
    //equals方法
    public final boolean equals(Object o) {
        if (o == this)
            return true;
        if (o instanceof Map.Entry) {
            Map.Entry<?,?> e = (Map.Entry<?,?>)o;
            if (Objects.equals(key, e.getKey()) &&
                Objects.equals(value, e.getValue()))
                return true;
        }
        return false;
    }
}
//转变为红黑树后的结点类
static final class TreeNode<k,v> extends LinkedHashMap.Entry<k,v> {
    TreeNode<k,v> parent;  // 父节点
    TreeNode<k,v> left; //左子树
    TreeNode<k,v> right;//右子树
    TreeNode<k,v> prev;    // needed to unlink next upon deletion
    boolean red;    //颜色属性
    TreeNode(int hash, K key, V val, Node<k,v> next) {
        super(hash, key, val, next);
    }
    //返回当前节点的根节点
    final TreeNode<k,v> root() {
        for (TreeNode<k,v> r = this, p;;) {
            if ((p = r.parent) == null)
                return r;
            r = p;
        }
    }
}

//默认初始化容量初始化=16
static final int DEFAULT_INITIAL_CAPACITY = 1 << 4; // aka 16
//最大容量 = 1 << 30
static final int MAXIMUM_CAPACITY = 1 << 30;
//默认加载因子.一般HashMap的扩容的临界点是当前HashMap的大小 > DEFAULT_LOAD_FACTOR * 
//DEFAULT_INITIAL_CAPACITY = 0.75F * 16
static final float DEFAULT_LOAD_FACTOR = 0.75f;
//当hash桶中的某个bucket上的结点数大于该值的时候，会由链表转换为红黑树
static final int TREEIFY_THRESHOLD = 8;
//当hash桶中的某个bucket上的结点数小于该值的时候，红黑树转变为链表
static final int UNTREEIFY_THRESHOLD = 6;
//桶中结构转化为红黑树对应的table的最小大小
static final int MIN_TREEIFY_CAPACITY = 64;
//hash算法,计算传入的key的hash值，下面会有例子说明这个计算的过程
static final int hash(Object key) {
    int h;
    return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
} 
//tableSizeFor(initialCapacity)返回大于initialCapacity的最小的二次幂数值。下面会有例子说明
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;
}
//hash桶
transient Node<K,V>[] table;
//保存缓存的entrySet
transient Set<Map.Entry<K,V>> entrySet;
//桶的实际元素个数 != table.length
transient int size;
//扩容或者更改了map的计数器。含义：表示这个HashMap结构被修改的次数，结构修改是那些改变HashMap中的映射数量或者
//修改其内部结构（例如，重新散列rehash）的修改。 该字段用于在HashMap失败快速（fast-fail）的Collection-views
//上创建迭代器。
transient int modCount;
//临界值，当实际大小（cap*loadFactor）大于该值的时候，会进行扩充
int threshold;
//加载因子
final float loadFactor;

//hash算法
static final int hash(Object key) {
    int h;
    //key == null : 返回hash=0
    //key != null 
    //（1）得到key的hashCode：h=key.hashCode()
    //（2）将h无符号右移16位
    //（3）异或运算：h ^ h>>>16
    return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
}   

//n=cap-1=5; 5的二进制0101B。>>> 操作符表示无符号右移，高位取0
//n |= n>>>1: (1)n=0101 | 0101>>>1; (2)n=0101 | 0010; (3)n = 0111B 
//n |= n>>>2: (1)n=0111 | 0111>>>2; (2)n=0111 | 0011; (3)n = 0111B
//n |= n>>>4: (1)n=0111 | 0111>>>4; (2)n=0111 | 0000; (3)n = 0111B
//n |= n>>>8: (1)n=0111 | 0111>>>8; (2)n=0111 | 0000; (3)n = 0111B
//n |= n>>>16:(1)n=0111 | 0111>>>16;(2)n=0111 | 0000; (3)n = 0111B
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;
    //n<0返回1
    //n>最大容量，返回最大容量
    //否则返回n+1(0111B+1B=1000B=8)
    return (n < 0) ? 1 : (n >= MAXIMUM_CAPACITY) ? MAXIMUM_CAPACITY : n + 1;
}

//至于这里为什么减1，当传入的cap为2的整数次幂的时候，减1即保证最后的计算结果还是cap，而不是大于cap的另一个2的
//整数次幂，例如我们传入cap=16=10000B.按照上面那样计算
//n=cap-1=15=1111B.按照上面的方法计算得到：
// n |= n>>>1: n=1111|0111=1111;后面还是相同的结果最后n=1111B=15.
//所以返回的时候为return 15+1;
int n = cap - 1; 

//（1）参数为初始化容量和加载因子的构造函数
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); //阈值为大于initialCapacity的最小二次幂
}
//（2）只给定初始化容量，那么加载因子就是默认的加载因子：0.75
public HashMap(int initialCapacity) {
    this(initialCapacity, DEFAULT_LOAD_FACTOR);
}
//（3）加载因子为默认的加载因子，但是这个时候的初始化容量是没有指定的，后面调用put或者get方法的时候才resize
public HashMap() {
    this.loadFactor = DEFAULT_LOAD_FACTOR; // all other fields defaulted
}
//（4）将传递的map中的值调用putMapEntries加入新的map集合中，其中加载因子是默认的加载因子
public HashMap(Map<? extends K, ? extends V> m) {
    this.loadFactor = DEFAULT_LOAD_FACTOR;
    putMapEntries(m, false);
}

//计算map中key的hash值
static final int hash(Object key) {
    int h;
    return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
}
//这一小段代码就是定位元素在桶中的位置。具体做法就是：容量n-1 & hash. 
//其中n是一个2的整数幂，而(n - 1) & hash其实质就是hash%n,但
//是取余运算的效率不如位运算与，并且(n - 1) & hash也能保证散列均匀，不会产生只有偶数位有值的现象
p = tab[i = (n - 1) & hash];

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;
    //table == null 或者table的长度为0，调用resize方法进行扩容
    //这里也说明：table 被延迟到插入新数据时再进行初始化
    if ((tab = table) == null || (n = tab.length) == 0)
        n = (tab = resize()).length;
    // 这里就是调用了Hash算法的地方，具体的计算可参考后面写到的例子
    //这里定位坐标的做法在上面也已经说到过
    if ((p = tab[i = (n - 1) & hash]) == null)
        // 如果计算得到的桶下标值中的Node为null，就新建一个Node加入该位置(这个新的结点是在
        //table数组中)。而该位置的hash值就是调用hash()方法计算得到的key的hash值
        tab[i] = newNode(hash, key, value, null);
    //这里表示put的元素用自己key的hash值计算得到的下表和桶中的第一个位置元素产生了冲突，具体就是
    //(1)key相同，value不同
    //(2)只是通过hash值计算得到的下标相同，但是key和value都不同。这里处理的方法就是链表和红黑树
    else {
        Node<K,V> e; K k;
        //上面已经计算得到了该hash对应的下标i，这里p=tab[i]。这里比较的有：
        //(1)tab[i].hash是否等于传入的hash。这里的tab[i]就是桶中的第一个元素
        //(2)比较传入的key和该位置的key是否相同
        //(3)如果都相同，说明是同一个key，那么直接替换对应的value值(在后面会进行替换)
        if (p.hash == hash && ((k = p.key) == key || (key != null && key.equals(k))))
            //将桶中的第一个元素赋给e，用来记录第一个位置的值
            e = p;
        //这里判断为红黑树。hash值不相等，key不相等；为红黑树结点
        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);
                    //前面的binCount是记录链表长度的，如果该值大于8，就会转变为红黑树
                    if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
                        treeifyBin(tab, hash);
                    break;
                }
                //如果在遍历链表的时候，判断得出要插入的结点的key和链表中间的某个结点的key相
                //同，就跳出循环,后面也会更新旧的value值
                if (e.hash == hash &&
                    ((k = e.key) == key || (key != null && key.equals(k))))
                    break;
                //e = p.next。遍历链表所用
                p = e;
            }
        }
        //判断插入的是否存在HashMap中，上面e被赋值，不为空，则说明存在，更新旧的键值对
        if (e != null) { // existing mapping for key
            V oldValue = e.value;
            if (!onlyIfAbsent || oldValue == null)
                e.value = value; //用传入的参数value更新旧的value值
            afterNodeAccess(e);
            return oldValue; //返回旧的value值
        }
    }
    //modCount修改
    ++modCount;
    //容量超出就扩容
    if (++size > threshold)
        resize();
    afterNodeInsertion(evict);
    return null;
}

//该方法有2种使用情况：1.初始化哈希表(table==null) 2.当前数组容量过小，需扩容
final Node<K,V>[] resize() {
    Node<K,V>[] oldTab = table; //oldTab指向旧的table数组
    //oldTab不为null的话，oldCap为原table的长度
    //oldTab为null的话，oldCap为0
    int oldCap = (oldTab == null) ? 0 : oldTab.length; 
    int oldThr = threshold; //阈值
    int newCap, newThr = 0;
    if (oldCap > 0) { 
        //这里表明oldCap！=0，oldCap=原table.length();
        if (oldCap >= MAXIMUM_CAPACITY) {
            threshold = Integer.MAX_VALUE; //如果大于最大容量了，就赋值为整数最大的阀值
            return oldTab;
        }
        // 如果数组的长度在扩容后小于最大容量 并且oldCap大于默认值16(这里的newCap也是在原来的
        //长度上扩展两倍)
        else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&
                 oldCap >= DEFAULT_INITIAL_CAPACITY)
            newThr = oldThr << 1; // double threshold双倍扩展threshhold
    }
    else if (oldThr > 0) // initial capacity was placed in threshold
        //	这里的oldThr=tabSizeFor(initialCapacity),从上面的构造方法看出，如果不是调用的
        //无参构造，那么threshhold肯定都会是经过tabSizeFor运算得到的2的整数次幂的,所以可以将
        //其作为Node数组的长度(个人理解)
        newCap = oldThr; 
    else { // zero initial threshold signifies using defaults(零初始阈值表示使用默认值)
        //这里说的是我们调用无参构造函数的时候(table == null,threshhold = 0)，新的容量等于默
        //认的容量，并且threshhold也等于默认加载因子*默认初始化容量
        newCap = DEFAULT_INITIAL_CAPACITY;
        newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
    }
    // 计算新的resize上限
    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数组存放结点元素
    //当然，桶数组的初始化也是在这里完成的
    Node<K,V>[] newTab = (Node<K,V>[])new Node[newCap]; 
    table = newTab;
    //原来的table不为null
    if (oldTab != null) {
        // 把每个bucket都移动到新的buckets中
        for (int j = 0; j < oldCap; ++j) {
            Node<K,V> e;
            //原table中下标j位置不为null
            if ((e = oldTab[j]) != null) {
                oldTab[j] = null; //将原来的table[j]赋为null，及时GC？
                if (e.next == null) //如果该位置没有链表，即只有数组中的那个元素
                    //通过新的容量计算在新的table数组中的下标：(n-1)&hash
                    newTab[e.hash & (newCap - 1)] = e; 
                else if (e instanceof TreeNode) 
                    //如果是红黑树结点，重新映射时，需要对红黑树进行拆分
                    ((TreeNode<K,V>)e).split(this, newTab, j, oldCap);
                else { // 链表优化重hash的代码块
                    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) {
                            //loTail处为null，那么直接加到该位置
                            if (loTail == null) 
                                loHead = e;
                            //loTail为链表尾结点，添加到尾部
                            else
                                loTail.next = e;
                            //添加后，将loTail指向链表尾部，以便下次从尾部添加
                            loTail = e;
                        }
                        // 原位置+旧容量
                        else {
                            //hiTail处为null，就直接点添加到该位置
                            if (hiTail == null)
                                hiHead = e;
                            //hiTail为链表尾结点，尾插法添加
                            else
                                hiTail.next = e;
                            hiTail = e;
                        }
                    } while ((e = next) != null);
                    // 将分组后的链表映射到新桶中
                    // 原索引放到bucket里
                    if (loTail != null) {
                        //旧链表迁移新链表,链表元素相对位置没有变化; 
                        //实际是对对象的内存地址进行操作 
                        loTail.next = null;//链表尾元素设置为null
                        newTab[j] = loHead; //数组中位置为j的地方存放链表的head结点
                    }
                    // 原索引+oldCap放到bucket里
                    if (hiTail != null) {
                        hiTail.next = null;
                        newTab[j + oldCap] = hiHead;
                    }
                }
            }
        }
    }
    return newTab;
}

// 原位置
if ((e.hash & oldCap) == 0) {
    //loTail处为null，那么直接加到该位置
    if (loTail == null) 
        loHead = e;
    //loTail为链表尾结点，添加到尾部
    else
        loTail.next = e;
    //添加后，将loTail指向链表尾部，以便下次从尾部添加
    loTail = e;
}
// 原位置+旧容量
else {
    //hiTail处为null，就直接点添加到该位置
    if (hiTail == null)
        hiHead = e;
    //hiTail为链表尾结点，尾插法添加
    else
        hiTail.next = e;
    hiTail = e;
}

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;
    //计算存放在数组table中的位置.具体计算方法上面也已经介绍了
    if ((tab = table) != null && (n = tab.length) > 0 &&
        (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) {
            //如果first为红黑树结点，就在红黑树中遍历查找
            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;
}