Java1.8集合 - HashMap

概述

HashMap应该是工作中Map接口最常用的实现类，其key和value都允许使用null。由于其实基于哈希表，所以并不保证数据的顺序。

值得注意的是，它不是线程安全的，如果需要保证线程安全，推荐使用java.util.concurrent包中的ConcurrentHashMap。

属性

以下是HashMap中的属性。

    /**
     * 默认的初始容量为16，即数组的初始大小，同时需要注意的是必须为2的幂
     * 至于为什么是2的幂，这是为了尽可能使元素分布均匀，避免出现hash冲突，从而省去遍历链表的开销
     */
    static final int DEFAULT_INITIAL_CAPACITY = 1 << 4; // aka 16

    /**
     * 最大容量，超过该值的将使用该值来代替
     */
    static final int MAXIMUM_CAPACITY = 1 << 30;

    /**
     * 默认加载因子，用于计算扩容阈值
     */
    static final float DEFAULT_LOAD_FACTOR = 0.75f;

    /**
     * 存储数据的数组，长度为2的幂，Node为单向链表
     */
    transient Node<K,V>[] table;

    /**
     * 已用的数组槽数
     */
    transient int size;

    /**
     * 记录HashMap改变的次数
     */
    transient int modCount;

    /**
     * 扩容阈值，用于控制HashMap的容量，其数值通过容量*加载因子
     * 如默认的容量16*默认的加载因子0.75=12，当容量超过12时，将会扩容
     */
    int threshold;

    /**
     * 实际的加载因子
     */
    final float loadFactor;

构造函数

其有四个构造函数，如下所示。

    /**
     * 根据容量和加载因子创建HashMap
     * 加载因子对性能影响很大
     * 过大，会造成更多的hash冲突，这就意味着更多的链表遍历，降低查找效率
     * 过小，则为造成空间浪费，数据过于稀疏
     * 所以最好就是使用默认的0.75
     *
     * @param  initialCapacity 实际初始容量
     * @param  loadFactor      实际加载因子
     */
    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);
    }

    /**
     * 根据容量创建HashMap，加载因子使用默认
     *
     * @param  initialCapacity 实际初始容量
     */
    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创建，加载因子使用默认的0.75
     */
    public HashMap(Map<? extends K, ? extends V> m) {
        this.loadFactor = DEFAULT_LOAD_FACTOR;
        putMapEntries(m, false);
    }

数据结构

HashMap是由数组结合链表实现的，如下图所示。

为什么要采用链表，这是因为HashMap是通过计算key的散列值来确定其在数组中位置的。计算方法如下

static final int hash(Object key) {
        int h;
        return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
}

但是不同的key值有可能出现相同的散列值，也就是所谓的hash冲突。解决hash冲突的方法有多种，但是HashMap采用链表来解决。

但是链表过长会降低查询效率，所以当链表过长(阈值为8)时，将会转为红黑树来存储。从而提升查询效率。

链表结构

可以从如下代码中发现是单向链表，由next记录下一节点。

//上图中的红色部分
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;
        }
    }

这里通过重写hashCode和equals来保证

红黑树TreeNode

内容过多，只截取了关键属性。

    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;
            }
        }

        //方法太多，就不全部贴出
    }

结构总结

1、初始化一个大小为2的幂的Node类型数组；

2、当添加元素时，根据key的hash值，确定数组的槽位，如果出现冲突，则放入链表中。

3、当链表过长时，将其转换为红黑树结构，从而提高查询效率。

关键方法

添加方法

    /**
     * 向HashMap中添加元素
     *
     * @param hash 键值key的散列值
     * @param key 键值key
     * @param value 元素的值
     * @param onlyIfAbsent 是否更新value
     * @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;
        //如果数组为null或者其长度为0，则通过resize方法分配内存
        if ((tab = table) == null || (n = tab.length) == 0)
            n = (tab = resize()).length;
        //根据key的散列值和数组长度n-1找到对应的槽位，若果当前槽位为null，则直接放入
        if ((p = tab[i = (n - 1) & hash]) == null)
            tab[i] = newNode(hash, key, value, null);
        else { //如果当前槽位不为null，则添加到链表中，以此解决冲突问题
            Node<K,V> e; K k;
            //如果链表的第一个元素的散列值相同，且key也相同，则准备更新该节点
            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) {
                    //第一次时p为链表的第一节点，并且通过第一个判断知道key不一致，所以取下一节点
                    //如果节点为空，则放入第一节点的next
                    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与新元素的相同，结束遍历，准备更新该节点
                    if (e.hash == hash &&
                            ((k = e.key) == key || (key != null && key.equals(k))))
                        break;
                    p = e;
                }
            }
            //如果找到了散列值和key相同的节点，则更新节点的value
            if (e != null) { // existing mapping for key
                V oldValue = e.value;
                //如果onlyIfAbsent为true，则表明不需要更新
                //如果onlyIfAbsent为false，或者原value为null，则更新节点的value
                if (!onlyIfAbsent || oldValue == null)
                    e.value = value;
                afterNodeAccess(e);
                return oldValue;
            }
        }
        ++modCount;
        //如果数组的大小超过阈值(数组初始大小*加载因子)，则通过resize方法扩容
        if (++size > threshold)
            resize();
        //专门为LinkedHashMap提供的专用回调方法
        afterNodeInsertion(evict);
        return null;
    }

查找方法

这个方法相当重要，想get()方法和containsKey()方法都是基于其实现的。代码如下所示

    /**
     * 获取key对应的链表元素Node
     *
     * @param hash 键值key的hash值
     * @param key 键值key
     */
    final Node<K,V> getNode(int hash, Object key) {
        Node<K,V>[] tab; Node<K,V> first, e; int n; K k;
        //首先要保证HashMap是有元素的，并且根据hash找到的链表不为null
        if ((tab = table) != null && (n = tab.length) > 0 &&
                (first = tab[(n - 1) & hash]) != null) {
            //对链表的第一个元素进行检查
            //如果元素保存的hash与查找键值key的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) {
                //首先判断第一个元素是否是TreeNode，如果是，则通过红黑树来查找
                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;
    }

扩容方法

现在要说到一个关键方法，为了保证查找效率，避免不必要的链表或者红黑树遍历，当数组的大小达到一定值时，会进行扩容。

    /**
     * 初始化数组，构造HashMap时，如果不指明初始大小，则使用默认值16来初始化Node[]数组
     * 如果数组的大小达到了阈值(即数组当前大小*加载因子)，则将原数组扩容到2倍大小。
     */
    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;
        //如果原数组不为null，及数组大小大于0
        if (oldCap > 0) {
            //如果原数组的大小超过了最大容量，则无法进行扩容，
            // 并将阈值改为Integer的最大值0x7fffffff，避免再次执行resize
            if (oldCap >= MAXIMUM_CAPACITY) {
                threshold = Integer.MAX_VALUE;
                return oldTab;
            }
            //新的容量为原容量的两倍，且必须小于最大容量，同时满足最小为默认初始容量，即16
            else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&
                    oldCap >= DEFAULT_INITIAL_CAPACITY)
                newThr = oldThr << 1; // 扩容阈值增加一倍
        }
        //此时原容量为0，如果原扩容阈值大于0
        //则使新的容为原扩容阈值，此时新扩容阈值为上面初始化后的值0
        else if (oldThr > 0)
            newCap = oldThr;
        else { //如果原容量及扩容阈值都为0，则使用默认值来初始化
            newCap = DEFAULT_INITIAL_CAPACITY;
            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 = newTab;
        //如果原数组不为null，则将原数组中的值放入新的数组中
        if (oldTab != null) {
            //遍历原数组，依次取出元素，
            for (int j = 0; j < oldCap; ++j) {
                Node<K,V> e;
                if ((e = oldTab[j]) != null) {
                    oldTab[j] = null;//将原数组中的元素所处槽位更新为null
                    if (e.next == null)//如果第一节点没有next节点，则直接将该节点根据其散列值找到新数组中某个槽位并放入
                        newTab[e.hash & (newCap - 1)] = e;
                    //按照红黑树处理
                    else if (e instanceof TreeNode)
                        ((TreeNode<K,V>)e).split(this, newTab, j, oldCap);
                    //维护链表的秩序
                    //由于新数组是原数组的两倍，所以每个槽位里的元素要么保持原index不变
                    //要么偏移2次幂的位置
                    else {
                        Node<K,V> loHead = null, loTail = null;
                        Node<K,V> hiHead = null, hiTail = null;
                        Node<K,V> next;
                        do {
                            next = e.next;
                            //保持原index
                            if ((e.hash & oldCap) == 0) {
                                if (loTail == null)
                                    loHead = e;
                                else
                                    loTail.next = e;
                                loTail = e;
                            }
                            //原index + 原数组大小
                            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;
    }