Java集合之HashMap常用方法解析

   最近正准备回顾一下Java，所以在此做一些记录。

关于树节点的先略过，下次进行补充

先简单看一下使用的链表节点的定义

 /**
     * 节点
     */
    static class Node<K,V> implements Map.Entry<K,V> {
        //hash值
        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; }
        //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;
        }
    }

1.put(K key, V value) 存放一个键值对

 /**
     * 存放一个键值对
     * @param key   键
     * @param value 值
     */
    public V put(K key, V value) {
        //计算key的hash值，存放一个键值对
        return putVal(hash(key), key, value, false, true);
    }

 /**
     * 存放一个键值对
     *
     * @param hash  根据key计算出来的hash值
     * @param key   存放的键
     * @param value 存放的值
     * @param onlyIfAbsent
     * @param evict
     */
    final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
                   boolean evict) {
        Node<K,V>[] tab;
        Node<K,V> p;
        int n, i;
        // 将tab设置为hashmap中存放数据的数组，n设置为数组的大小
        if ((tab = table) == null || (n = tab.length) == 0)
            //如果数组为空或者数组大小为0，生成一个新的数组
            n = (tab = resize()).length;
        //i设置成数组的大小减1与上hash值
        //因为是与操作，所以i的值一定保证在数组范围里
        //lenth = 2n 时，X % length = X & (length - 1) 
        //大家可以去搜一下验证
        if ((p = tab[i = (n - 1) & hash]) == null)
            //说明这个数组当前索引位置还没有存放数据，则放置新的节点
            tab[i] = newNode(hash, key, value, null);
        else {
            //数组当前索引已经有值的情况
            //p为当前数组索引上的节点
            Node<K,V> e; K k;
            if (p.hash == hash &&
                ((k = p.key) == key || (key != null && key.equals(k))))
                //当前数组索引上的节点key等于放入的key，将e设置成p
                e = p;
            else if (p instanceof TreeNode)
                //p节点已经转换成了树节点，往树节点上增加节点
                e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
            else {
                //还是链表节点，往后遍历链表节点
                for (int binCount = 0; ; ++binCount) {
                    //将e设置成后一个节点
                    if ((e = p.next) == null) {
                        //如果是空节点，则将新节点挂在链表上
                        //此时e为null值
                        p.next = newNode(hash, key, value, null);
                        //如果链表的节点数大于等于8，将链表转换成树节点
                        //TREEIFY_THRESHOLD = 8
                        if (binCount >= TREEIFY_THRESHOLD - 1)
                            //转变成树节点
                            treeifyBin(tab, hash);
                        break;
                    }
                    //如果下一个key等于要存放的节点的key，退出循环
                    if (e.hash == hash &&
                        ((k = e.key) == key || (key != null && key.equals(k))))
                        break;
                    //指向下一个节点
                    p = e;
                }
            }
            //e不为null，说明想要存放的节点的key重复
            if (e != null) {
                //获取旧值
                V oldValue = e.value;
                //参数onlyIfAbsent = false或旧值为空值，新值替换旧值
                if (!onlyIfAbsent || oldValue == null)
                    e.value = value;
                //hashmap中是个空方法
                afterNodeAccess(e);
                //返回旧值
                return oldValue;
            }
        }
        ++modCount;
        //放入一个新值后判断总大小是否大于阈值
        if (++size > threshold)
            //扩容，也就是会生成一个新的数组
            resize();
        //hashmap中是个空方法
        afterNodeInsertion(evict);
        return null;
    }

 /**
     * 扩容的操作，会重新生成数组
     *
     * @return 新的数组
     */
    final Node<K,V>[] resize() {
        //保存旧数组
        Node<K,V>[] oldTab = table;
        //保存旧数组的大小，旧数组为null则大小设置0
        int oldCap = (oldTab == null) ? 0 : oldTab.length;
        //保存旧的阈值
        int oldThr = threshold;
        //定义新的数组大小和阈值变量
        int newCap, newThr = 0;
        //如果旧数组大小大于0
        if (oldCap > 0) {
            //判断旧数组大小是否大于定义的最大值
            // MAXIMUM_CAPACITY = 1 << 30;
            if (oldCap >= MAXIMUM_CAPACITY) {
                //设置阈值为int的最大值
                threshold = Integer.MAX_VALUE;
                //返回旧数组，数组已经很大了
                return oldTab;
            }
            //如果旧数组大小还没有超过最大值的话
            //新数组的大小设置为旧数组的2倍
            //判断新数组的大小小于最大值并且旧数组的大小大于默认值16
            else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&
                     oldCap >= DEFAULT_INITIAL_CAPACITY)
                //新的阈值扩大成2倍
                newThr = oldThr << 1;
        }
        else if (oldThr > 0)
            //一般初始化的时候设置了大小的，会计算出threshold阈值，所以第一次put会在这里
            //如果旧阈值大于0，则设置新的数组大小为旧阈值大小
            newCap = oldThr;
        else {
            //一般new的时候没有设置初始值大小的时候，第一次put操作会到这里
            //设置新的数组大小为默认值16
            newCap = DEFAULT_INITIAL_CAPACITY;
            //设置新的阈值大小为默认负载因子 * 默认值 0.75*16 = 12
            newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
        }
        //如果新的阈值=0，只有两种情况
        //1.else if (oldThr > 0)的时候，也就是初始化的时候指定了大小第一次存放值，阈值大于等于数组大小，会降低阈值
        //2.(newCap = oldCap << 1) < MAXIMUM_CAPACITY && oldCap >= DEFAULT_INITIAL_CAPACITY
        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;
        //如果旧数组不为空，需要迁移所有的数组
        if (oldTab != null) {
            //遍历
            for (int j = 0; j < oldCap; ++j) {
                Node<K,V> e;
                //设置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 {
                        //如果是链表结构
                        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计算了在新数组中的索引位置
                            //e.hash & oldCap == 0 索引位置不发生变化
                            // ！=0，索引位置下移了旧数组大小
                            // 大家可以去验证一下
                            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;
    }

2.get(Object key) 根据键获取值

 /**
     * 根据键获取值
     * @param key 键
     * @return 对应的值
     */
    public V get(Object key) {
        Node<K,V> e;
        //调用了getNode方法获取节点，再获取值
        return (e = getNode(hash(key), key)) == null ? null : e.value;
    }

 /**
     * 根据hash和key获取值
     *
     * @param hash  hash值
     * @param key   键
     * @return 返回对于的节点
     */
    final Node<K,V> getNode(int hash, Object key) {
        Node<K,V>[] tab; Node<K,V> first, e; int n; K k;
        //存在数组并且数组大小大于0并且根据hash计算的数组索引上存在节点，否则返回null
        if ((tab = table) != null && (n = tab.length) > 0 &&
            (first = tab[(n - 1) & hash]) != null) {
            //first为数组对应索引上的第一个节点，如果对应的hash和key都相等，则返回
            if (first.hash == hash &&
                ((k = first.key) == key || (key != null && key.equals(k))))
                return first;
            //first的下一个节点不为空
            if ((e = first.next) != null) {
                //树结构的情况
                if (first instanceof TreeNode)
                    return ((TreeNode<K,V>)first).getTreeNode(hash, key);
                //链表的情况
                do {
                    //遍历计算，获取对应的key的节点
                    if (e.hash == hash &&
                        ((k = e.key) == key || (key != null && key.equals(k))))
                        return e;
                } while ((e = e.next) != null);
            }
        }
        return null;
    }

3.containsKey(Object key)  是否存在对应的key

 /**
     *  是否存在对应的key
     *
     * @param   key   键
     * @return true、false
     */
    public boolean containsKey(Object key) {
        //判断getNode方法是否获取到值
        return getNode(hash(key), key) != null;
    }

/**
     * 根据hash和key获取值
     *
     * @param hash  hash值
     * @param key   键
     * @return 返回对于的节点
     */
    final Node<K,V> getNode(int hash, Object key) {
        Node<K,V>[] tab; Node<K,V> first, e; int n; K k;
        //存在数组并且数组大小大于0并且根据hash计算的数组索引上存在节点，否则返回null
        if ((tab = table) != null && (n = tab.length) > 0 &&
            (first = tab[(n - 1) & hash]) != null) {
            //first为数组对应索引上的第一个节点，如果对应的hash和key都相等，则返回
            if (first.hash == hash &&
                ((k = first.key) == key || (key != null && key.equals(k))))
                return first;
            //first的下一个节点不为空
            if ((e = first.next) != null) {
                //树结构的情况
                if (first instanceof TreeNode)
                    return ((TreeNode<K,V>)first).getTreeNode(hash, key);
                //链表的情况
                do {
                    //遍历计算，获取对应的key的节点
                    if (e.hash == hash &&
                        ((k = e.key) == key || (key != null && key.equals(k))))
                        return e;
                } while ((e = e.next) != null);
            }
        }
        return null;
    }

4.remove(Object key) 删除对应的key

 /**
     * 删除对应的key
     *
     * @param  键
     * @return 对应的值
     */
    public V remove(Object key) {
        Node<K,V> e;
        //调用removeNode方法
        return (e = removeNode(hash(key), key, null, false, true)) == null ?
            null : e.value;
    }

 /**
     * 删除对应的节点
     *
     * @param hash          hash值
     * @param key           键
     * @param value         值
     * @param matchValue    是否开启value值的匹配
     * @param movable
     * @return              返回对应的节点
     */
    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;
        //判断数组不为空并且数组大小大于0并且根据hash值计算的数组索引所在的节点不为空
        if ((tab = table) != null && (n = tab.length) > 0 &&
            (p = tab[index = (n - 1) & hash]) != null) {
            Node<K,V> node = null, e; K k; V v;
            //hash所在的数组索引位置的节点等于寻找的key
            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 {
                        //遍历获取到对应key的节点
                        if (e.hash == hash &&
                            ((k = e.key) == key ||
                             (key != null && key.equals(k)))) {
                            node = e;
                            break;
                        }
                        p = e;
                    } while ((e = e.next) != null);
                }
            }
            //根据key查询到节点
            //matchValue  是否开始value值的匹配
            //开启value值的匹配徐娅萍判断value值是否相等
            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;
                //在链表中
                // p为找到节点的上一个节点，将p的下一个节点指向找到节点的下一个节点
                else
                    p.next = node.next;
                ++modCount;
                //数量减1
                --size;
                //hashmap中为空方法
                afterNodeRemoval(node);
                return node;
            }
        }
        //返回null
        return null;
    }

5.containsValue(Object value) 是否存在对应的值

/**
     * 是否存在对应的值
     *
     * @param value 需要查询的值
     */
    public boolean containsValue(Object value) {
        Node<K,V>[] tab; V v;
        //数组不为空并且数组大于0
        if ((tab = table) != null && size > 0) {
            //遍历数组
            for (int i = 0; i < tab.length; ++i) {
                //数组索引中的节点不为空，继续遍历
                for (Node<K,V> e = tab[i]; e != null; e = e.next) {
                    //如果存在相等的值
                    if ((v = e.value) == value ||
                        (value != null && value.equals(v)))
                        //返回true
                        return true;
                }
            }
        }
        //返回false
        return false;
    }