初识HashMap

HashMap

---

散列表

什么是哈希，Hash也称散列，哈希
基本原理就是把任意长度的输入，通过Hash算法变成固定长度的输出。
这个映射的规则就是对应的Hash算法，而原始数据映射后的二进制串就是哈希值。

Hash的特点：

1. 从hash值不可以反向推导出原始的数据
2. 输入数据的微小变化会得到完全不同的hash值，相同的数据会得到相同的值。
3. hash算法的执行效率要高效
4. hash算法的冲突概率要小

HashMap的继承体系

当链表长度为9，并且节点总数达到64个，链表升级为红黑树

计算出的hash值要经过扰动，使此hsah值更离散
然后再经过路由算法，找出node应存放在数组的位置（table.length是2的次方，table.length-1 的二进制表示一定都是1）

HasMap中的属性

    /**
     * 默认table大小（16）
     */
    static final int DEFAULT_INITIAL_CAPACITY = 1 << 4; // aka 16

    /**
     * table最大长度
     */
    static final int MAXIMUM_CAPACITY = 1 << 30;

    /**
     * 缺省负载因子
     */
    static final float DEFAULT_LOAD_FACTOR = 0.75f;

    /**
     * 树化域值
     */
    static final int TREEIFY_THRESHOLD = 8;

    /**
     * 树降级为链表的阈值
     */
    static final int UNTREEIFY_THRESHOLD = 6;

    /**
     * 数组的长度（桶的个数）
     */
    static final int MIN_TREEIFY_CAPACITY = 64;

---

    /**
     * 散列表结构
     * 什么时候初始化？？？
     */
    transient Node<K,V>[] table;

    /**
     * Holds cached entrySet(). Note that AbstractMap fields are used
     * for keySet() and values().
     *
     *
     */
    transient Set<Map.Entry<K,V>> entrySet;

    /**
     * The number of key-value mappings contained in this map.
     *
     * 当前哈希表中元素个数
     */
    transient int size;

    /**
     * 当前哈希表结构修改次数（插入和删除）
     */
    transient int modCount;

    /**
     * 扩容阈值，当你的哈希表中的元素超过阈值时，触发扩容
     */
    int threshold;

    /**
     * 负载因子
     *     12    =    16   *   0.75
     * threshold = capacity * loadFactor
     */
    final float loadFactor;

四个构造方法

    public HashMap(int initialCapacity, float loadFactor) {

        //其实就是做了一些校验
        //capacity必须大于0，最大值也就是MAXIMUM_CAPACITY
        if (initialCapacity < 0)
            throw new IllegalArgumentException("Illegal initial capacity: " +
                                               initialCapacity);

        if (initialCapacity > MAXIMUM_CAPACITY)
            initialCapacity = MAXIMUM_CAPACITY;
        //loadFactor必须大于0，负载因子
        if (loadFactor <= 0 || Float.isNaN(loadFactor))
            throw new IllegalArgumentException("Illegal load factor: " +
                                               loadFactor);
        this.loadFactor = loadFactor;
        this.threshold = tableSizeFor(initialCapacity);
    }

---

tableSizeFor方法

    /**
     * 作用：返回一个大于当前值cap的一个数字，并且这个数字一定是2次方数
     * cap = 10
     * n = 10 - 1 = 9
     *
     * 1001 | 0100 = 1101
     * 1101 | 0011 = 1111
     * 1111 | 0000 = 1111
     *
     * 1111 => 15
     *
     * return 15 + 1 = 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;
    }

HashMap的Put方法

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

hash()，散列函数，或叫哈希函数

	//扰动函数 减少hash碰撞
    static final int hash(Object key) {
        int h;
        return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
    }

putVal方法

    final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
                   boolean evict) {
        /**
         * tab:引用当前hashmap的散列表
         * p:表示当前散列表的元素
         * n:表示散列表数组的长度
         * i:表示路由寻址结果
         */
        Node<K,V>[] tab; Node<K,V> p; int n, i;


        //延迟初始化逻辑，第一次调用putVal是会初始化hashMap对象中的最耗费内存的散列表
        if ((tab = table) == null || (n = tab.length) == 0)
            n = (tab = resize()).length;

        //最简单的一种情况：寻址地址的桶位刚好是null，这个时候，直接将当前k-v=>node 扔进去就可以了
        if ((p = tab[i = (n - 1) & hash]) == null)
            tab[i] = newNode(hash, key, value, null);

        else {
            //e:node临时变量
            //k:表示临时的一个key
            Node<K,V> e; K k;

            //表示桶位中的该元素，与你当前插入的的元素的可以完全一致，表示后续需要进行替代操作
            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 {
                //链表的情况，并且链表的头元素与我们要插入的key不一致
                for (int binCount = 0; ; ++binCount) {

                    //条件成立的话，说明迭代到最后一个元素了，也没有找到一个与你要插入的key一致的node
                    //说明需要加入到当前链表的末尾
                    if ((e = p.next) == null) {
                        p.next = newNode(hash, key, value, null);
                        //条件成立的话，说明当前链表的长度，达到树化标准了，需要树化
                        if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
                            treeifyBin(tab, hash);
                        break;
                    }
                    //条件成立的话，说明找到了相同key的node元素，需要进行替换操作
                    if (e.hash == hash &&
                        ((k = e.key) == key || (key != null && key.equals(k))))
                        break;
                    p = e;
                }
            }
            //e!=null，说明找到了一个与你插入元素完全一致的数据，需要进行替换
            if (e != null) { // existing mapping for key
                V oldValue = e.value;
                if (!onlyIfAbsent || oldValue == null)
                    e.value = value;
                afterNodeAccess(e);
                return oldValue;
            }
        }
        //modCount：表示散列表结构被修改的次数，替换Node元素的value不计数
        ++modCount;
        //插入新元素，size自增，如果自增后的值大于扩容阈值，则出发扩容
        if (++size > threshold)
            resize();
        afterNodeInsertion(evict);
        return null;
    }

resize 扩容方法

resize方法：

    final Node<K,V>[] resize() {
        //oldTab：引用扩容前的哈希表
        Node<K,V>[] oldTab = table;
        //oldCap：表示扩容前table数组的长度
        int oldCap = (oldTab == null) ? 0 : oldTab.length;
        //oldThr：表示扩容前的宽容阈值
        int oldThr = threshold;

        //newCap：扩容之后table数组的大小
        //newThr：扩容之后，下次再次触发扩容的条件（扩容后的阈值）
        int newCap, newThr = 0;

        //条件如果成立说明hashMap中的散列表已经初始化过了，是一次正常扩容
        if (oldCap > 0) {

            //扩容之前的table数组大小已经达到最大阈值后，则不扩容，且设置扩容条件位int最大值
            if (oldCap >= MAXIMUM_CAPACITY) {
                threshold = Integer.MAX_VALUE;
                return oldTab;
            }
            //oldCap左移一位实现数组翻倍，并且赋值给newCap，newCap小于数组最大值限制 且扩容之前的阈值>=16
            //这种情况下，则下一次扩容的阈值 等于当前阈值翻倍
            else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&
                     oldCap >= DEFAULT_INITIAL_CAPACITY)
                newThr = oldThr << 1; // double threshold
        }

        //oldCap==0,说明hashMap中的散列表是null
        //1. new HashMap(initCap,loadFactor);
        //2. new HashMap(initCap);
        //3. new HashMap(map);  并且这个map有数据
        else if (oldThr > 0) // initial capacity was placed in threshold
            //newCap肯定是2的次方数
            newCap = oldThr;

        //oldCap==0，oldThr==0
        //new HashMap();
        else {               // zero initial threshold signifies using defaults
            newCap = DEFAULT_INITIAL_CAPACITY;
            newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
        }

        //newThr==0的情况有两种
        // 1.oldCap >= DEFAULT_INITIAL_CAPACITY
        // 2.oldThr > 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 = newTab;

        //说明：hashmap本次扩容之前，table不为null
        if (oldTab != null) {
            for (int j = 0; j < oldCap; ++j) {

                //当前node节点
                Node<K,V> e;

                if ((e = oldTab[j]) != null) {
                    //置空，方便jvm GC时回收
                    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
                        //第三种情况：桶位已经链化

                        //低位链表：存放在扩容之后的数组的下标位置，与当前数组的下标位置一致
                        Node<K,V> loHead = null, loTail = null;
                        //高位链表：存放在扩容之后的数组的下表位置为 当前数组下标位置 + 扩容之前数组的长度
                        Node<K,V> hiHead = null, hiTail = null;


                        Node<K,V> next;
                        do {
                            next = e.next;
                            //hash->....1 1111
                            //hash->....0 1111
                            //oldCap->  1 0000
                            //为true，则高位为0就是第二个
                            // 否则高位就是1
                            //newCap 1 1111   32-1
                            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;
                        }

                    }
                }
            }
        }
        return newTab;
    }

get方法

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

调用getNode方法

---

    final Node<K,V> getNode(int hash, Object key) {
        //tab:引用当前hashMap的散列表
        //first：桶位中的头元素
        //e:临时元素
        //n:table数组长度
        Node<K,V>[] tab; Node<K,V> first, e; int n; K k;

        if ((tab = table) != null && (n = tab.length) > 0 &&
            (first = tab[(n - 1) & hash]) != null) {


            //第一种情况：定位出来的桶位元素 即我们要get的数据
            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方法

第一个：

    public V remove(Object key) {
        Node<K,V> e;
        return (e = removeNode(hash(key), key, null, false, true)) == null ?
            null : e.value;
    }

第二个：

    @Override
    public boolean remove(Object key, Object value) {
        return removeNode(hash(key), key, value, true, true) != null;
    }

全都都调用removeNode（）：
传了value的remove ( ) 的matchValue 为true，没传的matchValue 为false

    /**
     * matchValue 是否需要匹配value
     */
    final Node<K,V> removeNode(int hash, Object key, Object value,
                               boolean matchValue, boolean movable) {
        //tab：引用当前HashMap中的散列表
        //p：当前node元素
        //n：表示散列表数组长度
        //index：表示寻址结果
        Node<K,V>[] tab; Node<K,V> p; int n, index;

        if ((tab = table) != null && (n = tab.length) > 0 &&
                //匹配到的桶不能为空
            (p = tab[index = (n - 1) & hash]) != null) {
            //说明路由的桶位是有数据的，需要进行查找操作，并且删除

            //node：查找结果
            //e：表示当前node的next元素
            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);
                }
            }

            //node有三种情况赋值，不为null，说明按照key查找需要删除的数据了
            if (node != null && (!matchValue || (v = node.value) == value ||
                                 (value != null && value.equals(v)))) {

                //第一种情况：node是树节点，进行删除操作
                if (node instanceof TreeNode)
                    ((TreeNode<K,V>)node).removeTreeNode(this, tab, movable);

                //第二种情况：桶位元素即为查找结果，则将该元素的下一个元素放到桶位中（对应上面的第二种情况）
                else if (node == p)
                    tab[index] = node.next;

                //node节点是我们要删除的节点，p节点是node节点的前驱
                else
                    p.next = node.next;
                ++modCount;
                --size;
                afterNodeRemoval(node);
                return node;
            }
        }
        return null;
    }

replace方法

第一个：

    @Override
    public boolean replace(K key, V oldValue, V newValue) {
        Node<K,V> e; V v;
        if ((e = getNode(hash(key), key)) != null &&
            ((v = e.value) == oldValue || (v != null && v.equals(oldValue)))) {
            e.value = newValue;
            afterNodeAccess(e);
            return true;
        }
        return false;
    }

第二个：

    @Override
    public V replace(K key, V value) {
        Node<K,V> e;
        if ((e = getNode(hash(key), key)) != null) {
            V oldValue = e.value;
            e.value = value;
            afterNodeAccess(e);
            return oldValue;
        }
        return null;
    }