Java中的容器（集合）之HashMap源码解析

static final int hash(Object key) {
        int h;
        //hashCode()返回散列值，这是Object中的一个方法
        // ^ 按位异或，& 按位与，|按位或；&&逻辑与，||逻辑或
        // >>> 无符号右移
        return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
        }

public class HashMap<K,V> extends AbstractMap<K,V> implements Map<K,V>, Cloneable, Serializable {
    // 序列号
    private static final long serialVersionUID = 362498820763181265L;
    // 默认的初始容量，需为2的幂次方（为了减少哈希碰撞），<< 表示左移，运算规则为乘以2的n次方，1<<4=16
    static final int DEFAULT_INITIAL_CAPACITY = 1 << 4;
    // 最大容量，如果由某个带参构造函数隐式的指定了更高的值，需为2的幂次方且小于1 << 30
    static final int MAXIMUM_CAPACITY = 1 << 30;
    // 构造函数中未指定时使用的加载因子，即默认加载因子
    static final float DEFAULT_LOAD_FACTOR = 0.75f;
    // 当传入的节点大于2且至少为8的时候，链表节点转为红黑树
    static final int TREEIFY_THRESHOLD = 8;
    // 当节点小于为6的时候，红黑树退化为链表
    static final int UNTREEIFY_THRESHOLD = 6;
    // 红黑树中对应的最小表容量应该最少为4*TREEIFY_THRESHOLD，以避免在调整大小和红黑树阈值之间的冲突。
    static final int MIN_TREEIFY_CAPACITY = 64;
    // 在第一次使用的时候初始化表，且根据需要设置大小，分配的大小总是2的幂次方
    transient Node<k,v>[] table;
    // 保存元素的集，需要注意的是，它使用的AbstractMap字段是keySet()和values()。
    transient Set<map.entry<k,v>> entrySet;
    // 此映射中包含的键值映射数，键值是一个整体，不等于数组的长度（因为存在哈希碰撞之后的链表和红黑树）
    transient int size;
    // 每次扩容和更改map结构的计数器
    transient int modCount;
    // 下一个要调整大小的大小值（容量*加载因子）
    int threshold;
    // hash表的加载因子
    final float loadFactor;
}

//静态内部类，实现了Map.Entry<K,V>接口
static class Node<K,V> implements Map.Entry<K,V> {
    final int hash;//哈希值，用于与其他元素的哈希值进行比较
    final K key;//键
    V value;//值
    Node<K,V> 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; }  

    public final int hashCode() {
        return Objects.hashCode(key) ^ Objects.hashCode(value);
    }

    public final V setValue(V newValue) {
        V oldValue = value;
        value = newValue;
        return oldValue;
    }

    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;  // red-black tree links
    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;
        }
    }
}

    /**
     * 指定容量以及加载因子构造一个空的HashMap
     */
    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);
    }

    /**
     * 指定容量以及默认加载因子0.75构造一个空的HashMap
     */
    public HashMap(int initialCapacity) {
        this(initialCapacity, DEFAULT_LOAD_FACTOR);
    }

    /**
     * 以默认容量16以及默认加载因子0.75构造一个空的HashMap
     */
    public HashMap() {
        this.loadFactor = DEFAULT_LOAD_FACTOR; // all other fields defaulted
    }

    /**
     * 以另一个Map的键值对构造一个新的HashMap。新HashMap的容量最少足够存储旧HashMap的键值对数，加载因子为默认加载因子0.75
     */
    public HashMap(Map<? extends K, ? extends V> m) {
        this.loadFactor = DEFAULT_LOAD_FACTOR;
        putMapEntries(m, false);
    }

    /**
     * 实现map.putall和map构造函数
     */
    final void putMapEntries(Map<? extends K, ? extends V> m, boolean evict) {
        int s = m.size();
        //判断m是否为空
        if (s > 0) {
            //判断table是否初始化
            if (table == null) { // pre-size
                //计算m的总容量，计算规则为使用容量/加载因子+1
                float ft = ((float)s / loadFactor) + 1.0F;
                //将m总容量与HashMap规定的最大容量相比得到最终容量
                int t = ((ft < (float)MAXIMUM_CAPACITY) ?
                        (int)ft : MAXIMUM_CAPACITY);
                //判断最终容量是否大于扩容阈值（扩容阈值计算规则：容量*加载因子）
                if (t > threshold)
                    threshold = tableSizeFor(t);
            }
            //如果m的键值对数大于扩容阈值，则进行扩容
            else if (s > threshold)
                resize();
            //将m中的键值对添加到新HashMap中
            for (Map.Entry<? extends K, ? extends V> e : m.entrySet()) {
                K key = e.getKey();
                V value = e.getValue();
                putVal(hash(key), key, value, false, evict);
            }
        }
    }

    /**
     * 初始化表或者将表容量翻倍，如果为空则分配初始容量，否则以2的幂次方扩容，需要保持索引一致
     * @return
     */
    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;
            }
            //判断旧容量的两倍容量（左移表示乘以2的n次方）是否小于最大容量，且旧容量是否大于等于默认容量
            else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&
                    oldCap >= DEFAULT_INITIAL_CAPACITY)
                //扩容两倍
                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
            //否则新容量设置为默认容量（因为旧容量小于0）
            newCap = DEFAULT_INITIAL_CAPACITY;
            //新阈值设置为默认容量乘以默认加载因子，即16*0.75
            newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
        }
        //如果新阈值为0，则重新计算新阈值
        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
        //如果旧table为空，则初始化
        table = newTab;
        //否则将旧table的值放入新table
        if (oldTab != null) {
            //旧table的值循环放入新table
            for (int j = 0; j < oldCap; ++j) {
                Node<K,V> e;
                //判断当前节点是否有值
                if ((e = oldTab[j]) != null) {
                    //旧table节点置为空
                    oldTab[j] = null;
                    //如果该节点没有子节点，则返回新table，元素放入的位置为e的哈希值按位与（新容量-1）
                    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
                        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);
                        //旧索引放入table
                        if (loTail != null) {
                            loTail.next = null;
                            newTab[j] = loHead;
                        }
                        //新索引放入table
                        if (hiTail != null) {
                            hiTail.next = null;
                            newTab[j + oldCap] = hiHead;
                        }
                    }
                }
            }
        }
        return newTab;
    }

    //put元素到map中
    public V put(K key, V value) {
        //实际调用的是putVal()方法
        return putVal(hash(key), key, value, false, true);
    }

    //putVal()方法用于实际操作插入元素
    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未初始化，调用resize()进行扩容（使用的都是默认值）
        if ((tab = table) == null || (n = tab.length) == 0)
            n = (tab = resize()).length;
        //判断(n - 1) & hash]索引处的table是否为空，为空，则插入新节点（table为空，此时插入的节点是在数组中）
        if ((p = tab[i = (n - 1) & hash]) == null)
            tab[i] = newNode(hash, key, value, null);
        //table不为空
        else {
            Node<K,V> e; K k;
            //判断节点的hash以及key是否相等，是则覆盖。
            if (p.hash == hash &&
                    ((k = p.key) == key || (key != null && key.equals(k))))
                e = p;
            //否则如果属于树节点，使用putTreeVal插入节点数据（putTreeVal是针对红黑树的putVal方法），有兴趣的可以看一下putTreeVal方法
            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);
                        //如果大于规则节点数（8），则转为红黑树存储
                        if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
                            treeifyBin(tab, hash);
                        //跳出循环
                        break;
                    }
                    //判断插入元素与链表中原有元素的hash以及key是否相等
                    if (e.hash == hash &&
                            ((k = e.key) == key || (key != null && key.equals(k))))
                        //相等，跳出循环
                        break;
                    //循环链表
                    p = e;
                }
            }
            //存在键值对的key
            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;
    }

    //通过指定key从map中get值
    public V get(Object key) {
        Node<K,V> e;
        //实际调用的是getNode()方法
        return (e = getNode(hash(key), key)) == null ? null : e.value;
    }

    //getNode()方法用于实际操作查询元素值
    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) {
            //总是检查第一个节点，如果第一个节点与需要查询的节点的hash以及key相等，则返回第一个节点
            if (first.hash == hash && // always check first node
                    ((k = first.key) == key || (key != null && key.equals(k))))
                return first;
            //如果存在多个节点
            if ((e = first.next) != null) {
                //如果属于红黑树，则调用红黑树中的getTreeNode方法查询，有兴趣的可以看一下getTreeNode方法
                if (first instanceof TreeNode)
                    return ((TreeNode<K,V>)first).getTreeNode(hash, key);
                //否则在链表中查询
                do {
                    //如果链表节点与需要查询的节点的hash以及key相等，则返回链表节点
                    if (e.hash == hash &&
                            ((k = e.key) == key || (key != null && key.equals(k))))
                        return e;
                } while ((e = e.next) != null);
            }
        }
        return null;
    }