HashMap源码

HashMap<K,V> extends AbstractMap<K,V>    implements Map<K,V>, Cloneable, Serializable 

• 基于哈希表的 Map 接口的实现。此实现提供所有可选的映射操作，并允许使用 null 值和 null 键。（除了非同步和允许使用 null 之外，HashMap 类与Hashtable 大致相同）此类不保证映射的顺序，特别是它不保证该顺序恒久不变。

• 此实现假定哈希函数将元素适当地分布在各桶之间，可为基本操作（get 和 put）提供稳定的性能。迭代 collection 视图所需的时间与HashMap 实例的“容量”（桶的数量）及其大小（键-值映射关系数）成比例。所以，如果迭代性能很重要，则不要将初始容量设置得太高（或将加载因子设置得太低）。

• HashMap 的实例有两个参数影响其性能：初始容量 和加载因子。容量 是哈希表中桶的数量，初始容量只是哈希表在创建时的容量。加载因子 是哈希表在其容量自动增加之前可以达到多满的一种尺度。当哈希表中的条目数超出了加载因子与当前容量的乘积时，则要对该哈希表进行rehash 操作（即重建内部数据结构），从而哈希表将具有大约两倍的桶数。

• 通常，默认加载因子 (.75) 在时间和空间成本上寻求一种折衷。加载因子过高虽然减少了空间开销，但同时也增加了查询成本（在大多数 HashMap 类的操作中，包括get 和put 操作，都反映了这一点）。在设置初始容量时应该考虑到映射中所需的条目数及其加载因子，以便最大限度地减少 rehash 操作次数。如果初始容量大于最大条目数除以加载因子，则不会发生 rehash 操作。

• 如果很多映射关系要存储在 HashMap 实例中，则相对于按需执行自动的 rehash 操作以增大表的容量来说，使用足够大的初始容量创建它将使得映射关系能更有效地存储。

  1. 类变量&常量

    static final int DEFAULT_INITIAL_CAPACITY = 1 << 4; // 默认初始容量为16

    static final int MAXIMUM_CAPACITY = 1 << 30;        //最大容量为2^30

    static final float DEFAULT_LOAD_FACTOR = 0.75f;     //默认装载因子为0.75

    //发生hash冲突的链表上，若链表容量大于8，且map的容量大于64，则将链表变成红黑树static final int TREEIFY_THRESHOLD = 8;

    //如果以红黑树存储的元素个数小于6，则变成链表形式存储static final int UNTREEIFY_THRESHOLD = 6;

   static final int MIN_TREEIFY_CAPACITY = 64;      //决定是否转化为红黑树的最小容量

    transient Set<Map.Entry<K,V>> entrySet  //持有的entrySet()缓存

    transient int size;             //HashMap的容量

    transient int modCount;         //记录HashMap的结构被改变的次数       

    int threshold;                  //capacity*loadFactor,即发生扩容的阈值

    final float loadFactor;         //装载因子

2.内部类

EntrySet extends AbstractSet<Map.Entry<K,V>> ：反映Map中的映射关系的一个Set视图，其对HashMap进行操作。故改变HashMap即改变了EntrySet，反之亦然。而且若对其进行iterator遍历时，HashMap发生了结构改变，则会导致EntrySet的不确定性。可以通过EntrySet对HashMap的元素进行删除，Iterator.remove，Set.remove，removeAll，retainAll和clear均可对其进行操作，但是add和addAll不可。

Node<K,V> implements Map.Entry<K,V> ：链表的节点类，注意其实现了Map.Entry接口        final int hash;        final K key;        V value;        Node<K,V> next;        构造方法、getKey、getValue、setValue方法以及        public final int hashCode() {  //一般用于判断两个Node是否相同            return Objects.hashCode(key) ^ Objects.hashCode(value);        }              public final boolean equals(Object o) {            if (o == this)                return true;            if (o instanceof Map.Entry) {       //均为Map.Entry                Map.Entry<?,?> e = (Map.Entry<?,?>)o;                if (Objects.equals(key, e.getKey()) &&                    Objects.equals(value, e.getValue()))                    return true;            }            return false;        }

KeySet ： 以key组成的Set集合

Values ：以value组成的集合类

HashIterator ：KeyIterator、ValueIterator、EntryIterator的父类，主要有hasNext、nextNode和remove等方法

3.构造方法

    //无参数构造方法    public HashMap() {        this.loadFactor = DEFAULT_LOAD_FACTOR; //令装载因子为默认的0.75    }    //有初始容量的构造方法    public HashMap(int initialCapacity) {        this(initialCapacity, DEFAULT_LOAD_FACTOR);    }    //有初始容量和装载因子的构造方法    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)) //判断loadFactor是否小于等于0或者不是一个数字            throw new IllegalArgumentException("Illegal load factor: " +                                               loadFactor);        this.loadFactor = loadFactor;        //此处threshold保证为2的幂，调用tableSizeFor函数，对初始化容量进行调整        this.threshold = tableSizeFor(initialCapacity);         }    public HashMap(Map<? extends K, ? extends V> m) {        this.loadFactor = DEFAULT_LOAD_FACTOR;        putMapEntries(m, false);    //将m放入到map中    }

4.重要函数

1.tableSizeFor函数，将threshold扩展至2的幂    static final int tableSizeFor(int cap) {        int n = cap - 1;        //通过不断做或运算，最后一定能够得到2的幂        n |= n >>> 1;        n |= n >>> 2;        n |= n >>> 4;        n |= n >>> 8;        n |= n >>> 16;  //由于int为32位，故最多向右移动16位        return (n < 0) ? 1 : (n >= MAXIMUM_CAPACITY) ? MAXIMUM_CAPACITY : n + 1;    }

2.putMapEntries函数，作用相当于putAll，即将一个map放入到原有HashMap中  evict为一个boolean函数，当为false时，表示是第一次创建该map。  当为true时，表示要传递给afterNodeInsertion方法，该方法是LinkedHashMap使用   final void putMapEntries(Map<? extends K, ? extends V> m, boolean evict) {        int s = m.size();        if (s > 0) {            if (table == null) { // 若为空，则需要对threshold进行处理                float ft = ((float)s / loadFactor) + 1.0F;  //得到一个threshold                int t = ((ft < (float)MAXIMUM_CAPACITY) ?                         (int)ft : MAXIMUM_CAPACITY);                if (t > threshold)                    threshold = tableSizeFor(t);            }            else if (s > threshold)                resize();            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);            }        }    }

3.返回loadFactor & 返回capacity，也即table的长度或者threshold    final float loadFactor() { return loadFactor; }    final int capacity() {        return (table != null) ? table.length :            (threshold > 0) ? threshold :            DEFAULT_INITIAL_CAPACITY;    }

4，再次初始化，被readObject和clone方法调用    void reinitialize() {        table = null;        entrySet = null;        keySet = null;        values = null;        modCount = 0;        threshold = 0;        size = 0;    }

5.克隆函数    public Object clone() {        HashMap<K,V> result;        try {            result = (HashMap<K,V>)super.clone();        } catch (CloneNotSupportedException e) {            // this shouldn't happen, since we are Cloneable            throw new InternalError(e);        }        result.reinitialize();        result.putMapEntries(this, false);        return result;    }

6.判断是否需要将链表改成红黑树    final void treeifyBin(Node<K,V>[] tab, int hash) {        int n, index; Node<K,V> e;        if (tab == null || (n = tab.length) < MIN_TREEIFY_CAPACITY)            resize(); //若容量小于64，则只扩容        else if ((e = tab[index = (n - 1) & hash]) != null) {            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);        }    }

7.hash函数，用于计算每一个key的hash值利用key.hashCode与key.hashCode/2^16进行异或计算，为了避免哈希碰撞，将高位分配到低位上，综合了速度与性能的考虑。hash集合只有在bit值高于当前掩码的时候总是会引发碰撞    static final int hash(Object key) {        int h;        return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);    }

8.put函数，添加元素进HashMap    public V put(K key, V value) {        return putVal(hash(key), key, value, false, true);    }    //实现map.put以及相关的方法，如果onlyIfAbsent为true，则不改变原有值。    //若evict为afterNodeInsertion的后续    final V putVal(int hash, K key, V value, boolean onlyIfAbsent,                   boolean evict) {        Node<K,V>[] tab;    //新的table        Node<K,V> p;                int n, i;        //如果table为null或者长度为0，则tab=resize()可以初始化一个table        if ((tab = table) == null || (n = tab.length) == 0)            n = (tab = resize()).length;        //p为元素在tab中的位置，利用hash&(table.length-1)进行计算        if ((p = tab[i = (n - 1) & hash]) == null)            tab[i] = newNode(hash, key, value, null);         else {  //该位置的原有元素不为null，即发生了hash碰撞            Node<K,V> e; K k;            //若hash和key均相同，且onlyIfAbsent为false，则直接替换value值            if (p.hash == hash &&                       ((k = p.key) == key || (key != null && key.equals(k))))                e = p;            //p为树节点，则将新的node节点加到树中                else if (p instanceof TreeNode)                 e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);            //p为链表节点，则将新的node节点加到链表中            else {                for (int binCount = 0; ; ++binCount) {                    if ((e = p.next) == null) {                        //无相同的key，则将新节点加到链表最后面                        p.next = newNode(hash, key, value, null);                          if (binCount >= TREEIFY_THRESHOLD - 1)                             treeifyBin(tab, hash); // 判断是扩容还是从链表转换成树                        break;                    }                     //在链表中有节点和新节点的key相同，则直接break                    if (e.hash == hash &&                        ((k = e.key) == key || (key != null && key.equals(k))))                        break;                    p = e;                }            }            if (e != null) { // 有相同节点,替换值或保留原节点                V oldValue = e.value;                //onlyIfAbsent为false则替换value，为true则不替换                if (!onlyIfAbsent || oldValue == null)                     e.value = value;                afterNodeAccess(e);                return oldValue;            }        }        ++modCount;        if (++size > threshold)     //size+1,判断是否需要扩容            resize();           afterNodeInsertion(evict); //一般用于LinkedHashMap        return null;    }

具体的计算过程用如下图表示,在设计hash函数时，因为目前的table长度为2的N次方，
而计算下标的时候，使用&位操作，而非%求余：

9.get方法，得到指定key的value    //返回指定key的value值，或者是null如果map中没有相应的key    //即若有(key==null ? k==null : key.equals(k))，则返回v，否则返回null(最多一个这样的映射)    public V get(Object key) {        Node<K,V> e;        return (e = getNode(hash(key), key)) == null ? null : e.value;    }    //Map.get和相关方法的实现    final Node<K,V> getNode(int hash, Object key) {        Node<K,V>[] tab;        //新的table        Node<K,V> first, e;             int n; K k;        //判断该hash(key)^table.length 是否在table中。        if ((tab = table) != null && (n = tab.length) > 0 &&            (first = tab[(n - 1) & hash]) != null) {            if (first.hash == hash && // 检查第一个节点的key值是否与key相同                ((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;    }

10.扩容函数resize    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) {   //无法扩容，只能提升阈值为Integer.MAX_VALUE                threshold = Integer.MAX_VALUE;                return oldTab;            }            //newCap为新容量=oldCap*2，若其小于MAXIMUM_CAPACITY(Integer.MAX_VALUE-8)            //且oldCap大于等于10，则newThr新阈值为oldThr*2            else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&                     oldCap >= DEFAULT_INITIAL_CAPACITY)                newThr = oldThr << 1; // double threshold        }        else if (oldThr > 0) // oldCap等于0，表示hashMap为空            newCap = oldThr;        else {               // oldCap和oldThr均为0            newCap = DEFAULT_INITIAL_CAPACITY;            newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);        }        if (newThr == 0) {  //未给newThr赋值的情况            float ft = (float)newCap * loadFactor;              newThr = (newCap < MAXIMUM_CAPACITY && ft < (float)MAXIMUM_CAPACITY ?                      (int)ft : Integer.MAX_VALUE);        }        threshold = newThr; //将newThr赋值给threshold        Node<K,V>[] newTab = (Node<K,V>[])new Node[newCap];     //重新划分newCap的空间        table = newTab;        if (oldTab != null) {            for (int j = 0; j < oldCap; ++j) {                      Node<K,V> e;                //在oldTab[j]位置不为0的结点                if ((e = oldTab[j]) != null) {                              oldTab[j] = null;                    //e为指定位置的第一个节点，若只有一个节点，则对其重新计算位置为e.hash&(newCap-1)                    if (e.next == null)                        newTab[e.hash & (newCap - 1)] = e;                    //若指定位置上不止一个节点且为treeNode，则对树进行拆分                    else if (e instanceof TreeNode)                        ((TreeNode<K,V>)e).split(this, newTab, j, oldCap);                    else {                     /*                    1.                     oldIndex = hash & (oldCap - 1)                             = hash % oldCap                    ==> hash = m * oldCap + oldIndex                    2.                     newIndex = hash & (newCap - 1)                             = hash & (oldCap * 2 - 1)                             = hash % (oldCap * 2)                    ==> hash = n * oldCap * 2 + newIndex                    ==> n * oldCap * 2 + newIndex = m * oldCap + oldIndex                    ==> newIndex - oldIndex = oldCap * (m - 2 * n)                    3.                     m = hash / oldCap                    n = hash / newCap = hash/ (2 * oldCap)                     ==> m >= (2 * n)                    ==> newIndex - oldIndex = 0 or oldCap                        3.1 若 newIndex - oldIndex = 0                        (newIndex = oldIndex) < oldCap                        则扩容后，e.hash & oldCap = 0，元素位置不变，仍放在原先的索引位置上                        3.2 若newIndex - oldIndex = oldCap                        则扩容后，e.hash & oldCap = oldIndex + oldCap，元素需要放到新扩容出的部分里                    */                    /*：把链表上的键值对按hash值分成lo和hi两串，lo串的新索引位置与原先相同[原先位置j]，hi串的新索引位置为[原先位置j+oldCap]；链表的键值对加入lo还是hi串取决于 判断条件if ((e.hash & oldCap) == 0)，因为capacity是2的幂，所以oldCap为10...0的二进制形式，若判断条件为真，意味着oldCap为1的那位对应的hash位为0，对新索引的计算没有影响（新索引=hash&(newCap-1)，newCap=oldCap<<2）；若判断条件为假，则 oldCap为1的那位对应的hash位为1，即新索引=hash&( newCap-1 )= hash&( (oldCap<<2) - 1)，相当于多了10...0，即oldCap    例子：    旧容量=16，二进制10000；新容量=32，二进制100000    旧索引的计算：    hash = xxxx xxxx xxxy xxxx    旧容量-1 1111    &运算 xxxx    新索引的计算：    hash = xxxx xxxx xxxy xxxx    新容量-1 1 1111    &运算 y xxxx    新索引 = 旧索引 + y0000，若判断条件为真，则y=0(lo串索引不变)，否则y=1(hi串索引=旧索引+旧容量10000)    */                        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 = 0,则用loHead作为链表的新节点                            // 若e.hash & oldCap != 0,则用hiHead作为链表的新节点                                                     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);                        if (loTail != null) {                            loTail.next = null;                            newTab[j] = loHead;                        }                        if (hiTail != null) {                            hiTail.next = null;                            newTab[j + oldCap] = hiHead;//newTab的j+oldTab位置保存hiHead链表                        }                    }                }            }        }        return newTab;    }

11.clear函数，清除map中的元素    public void clear() {        Node<K,V>[] tab;        modCount++;        if ((tab = table) != null && size > 0) {            size = 0;            for (int i = 0; i < tab.length; ++i)                tab[i] = null;  //help gc        }    }