JAVA数据结构——Map之HashMap

JAVA数据结构——Map之HashMap

一、原型及简介

　　原型：public class HashMap<K,V> extends AbstractMap<K,V> implements Map<K,V>, Cloneable, Serializable

　　简介：HashMap基于散列表实现的一个key-value数据结构，能够实现通过key值快速查找。HashMap继承自AbstractMap抽闲类，实现了Map接口。

 二、数据结构原理介绍

　　如下图所示，HashMap是利用数组与链表结合的形式构建的。竖列为数组结构，默认初始数量为16（1<<4）个，横列为链表结构用于解决散列冲突的问题。当数组中有值得元素超过了装载因子的比例（默认为0.75）时，会引发扩容的操作。此操作是为了避免元素过满时引起的链表长度过长，从而影响查找性能。

　　

上图为jdk1.7之前的实现，jdk1.8实现方法是当某一个桶中的元素个数超过了8时，将此桶中的链表构建成红黑树。

三、常用源码解析

　　1、常量说明

    /**
     * 默认初始容量
     */
    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;

    /**
     * 当一个桶中的元素的数量大于8时，该链表结构可能被转化成一棵红黑树，优化查找
     */
    static final int TREEIFY_THRESHOLD = 8;

    /**
     * 当一个桶中的元素的数量小于6时，该树结构被转化成链表。
     */
    static final int UNTREEIFY_THRESHOLD = 6;

    /**
     * 桶被树化的另一个条件是，当hashmap中元素个数大于4 * MIN_TREEIFY_CAPACITY 。避免调整大小和treei阈值之间的冲突。
     */
    static final int MIN_TREEIFY_CAPACITY = 64;

　　2、变量说明

    /**
     * The table, initialized on first use, and resized as
     * necessary. When allocated, length is always a power of two.
     * (We also tolerate length zero in some operations to allow
     * bootstrapping mechanics that are currently not needed.)
     */
    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;

    /**
     * HashMap中当前元素个数
     */
    transient int size;

    /**
     * HashMap对象被修改次数，防止出现多个线程修改出现的线程不一致性，每次修改HashMap的值时，都会自增。当使用Iterator操作HashMap时，会用此值与Iterator内部的值做一次比较，从而判断HashMap有没有被其他线程修改。故建议每次遍历HashMap时都使用Iterator。
     */
    transient int modCount;

    /**
     * 装载因子
     */
    final float loadFactor;

　　漏了一个变量：threshold，代表着扩容的阈值，其值为  当前容量*装载因子

　　3、节点数据结构

    static class Node<K,V> implements Map.Entry<K,V> {
        final int hash; //散列码
        final K key;  //key值
        V value;  //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() {
            // key值的散列码 幂运算 value值得散列码
            // 散列函数为空值返回0，非空值则返回该对象的32位JVM地址
            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;
        }
    }

　　4、常用方法

    /**
     * 指定初始大小以及装载因子
     */
    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);
    }

    /**
     * 返回一个比cap大的最小的2的幂次方整数
     */
    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的容量必须是2的幂次方，所以构造方法中有关于tableSizeFor方法，获得比给定容量大的最小的2的幂次方整数，很霸气的算法，其具体的说明可参考链接：

【转载】http://blog.csdn.net/fan2012huan/article/details/51097331（写的很详细，很好）。

    /**
     * 将key-value键值对放入HashMap中
     */
    public V put(K key, V value) {
        return putVal(hash(key), key, value, false, true);
    }

    /**
     * 实际put的方法
     */
    final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
                   boolean evict) {
        Node<K,V>[] tab; //暂存HashMap节点数组
        Node<K,V> p; //暂存本次要插入的节点元素数据
        int n, i;

        //如果当前HashMap为空，则计算新分配空间
        if ((tab = table) == null || (n = tab.length) == 0)
            n = (tab = resize()).length;
        // 如果计算出的新节点位置（hash & (n - 1) 等价于 hash % n）是空，则将元素直接放入
        if ((p = tab[i = (n - 1) & hash]) == null)
            tab[i] = newNode(hash, key, value, null);
        //插入新的节点，并重新组织HashMap（确定位置并决定是否树化）
        else {
            Node<K,V> e; K k;
            // 插入了重复的key值（hash码一致且key值一致）
            if (p.hash == hash &&
                ((k = p.key) == key || (key != null && key.equals(k))))
                e = p;
            // 如果p是红黑树，则执行红黑树的插入操作
            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);
                        如果节点数量超过阈值，则执行树化操作
                        if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
                            treeifyBin(tab, hash);
                        break;
                    }
                    // 插入了重复值
                    if (e.hash == hash &&
                        ((k = e.key) == key || (key != null && key.equals(k))))
                        break;
                    p = e;
                }
            }
            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;
    }

    /**
     * 针对每个桶重新分配空间
     */
    final Node<K,V>[] resize() {
        Node<K,V>[] oldTab = table; //暂存当前table结构
        int oldCap = (oldTab == null) ? 0 : oldTab.length; //暂存当前桶的数量
        int oldThr = threshold; //暂存扩容的阈值
        int newCap, newThr = 0; //定义新的容量和阈值
        // 如果原有HashMap不为空
        if (oldCap > 0) {
            //如果容量已经达到了上限，则不扩容，返回原oldTab
            if (oldCap >= MAXIMUM_CAPACITY) {
                threshold = Integer.MAX_VALUE;
                return oldTab;
            }
            //如果容量没有达到上限，则将容量及扩容阈值均翻倍
            else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&
                     oldCap >= DEFAULT_INITIAL_CAPACITY)
                newThr = oldThr << 1; // double threshold
        }
        // 容量为0但老的阈值大于0，则阈值保持不变
        else if (oldThr > 0) // initial capacity was placed in threshold
            newCap = oldThr;
        // 如果容量与阈值均为0，则执行初始化
        else {               // zero initial threshold signifies using defaults
            newCap = DEFAULT_INITIAL_CAPACITY;//容量为默认容量
            newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);//阈值为默认容量*默认阀值（16*0.75）
        }
        // 如果现有容量翻倍后大于最大容量或现有容量小于系统默认值（16），才会出现新阈值=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;

        //重新组织每个桶内的链表或树状结构
        if (oldTab != null) {
            //遍历每个桶，分别处理每个桶中的数据
            for (int j = 0; j < oldCap; ++j) {
                Node<K,V> e;

                //当前桶不为空，则需将oldTab中的内容组织到newTab中
                if ((e = oldTab[j]) != null) {
                    oldTab[j] = null;
                    if (e.next == null) //e没有子节点，则根据e的hash值直接将此节点放到扩容后的桶数组中合适位置
                        // 此处e.hash & (newCap - 1)等价于e.hash % newCap
                        newTab[e.hash & (newCap - 1)] = e;
                    else if (e instanceof TreeNode) //如果e是个树型节点，则遍历红黑树，将树中的每个节点放到新的桶数组中合适的位置，并根据新的结构决定是否需要将每个桶做树化
                        ((TreeNode<K,V>)e).split(this, newTab, j, oldCap);
                    else { // e是个链式节点
                        Node<K,V> loHead = null, loTail = null;
                        Node<K,V> hiHead = null, hiTail = null;
                        Node<K,V> next;
                        do {
                            next = e.next;
                            // 因为容量扩大了二倍，则元素要么保持不变，要么放到index + oldCap位置
                            if ((e.hash & oldCap) == 0) {// 元素位置保持不变，先将元素放到lo链表中
                                if (loTail == null)
                                    loHead = e;
                                else
                                    loTail.next = e;
                                loTail = e;
                            }
                            else {// 元素位置需要移动，先将元素放到hi链表中
                                if (hiTail == null)
                                    hiHead = e;
                                else
                                    hiTail.next = e;
                                hiTail = e;
                            }
                        } while ((e = next) != null);
                        if (loTail != null) {//将lo链表放到newTab中原来（j）的位置
                            loTail.next = null;
                            newTab[j] = loHead;
                        }
                        if (hiTail != null) {//将hi链表放到newTab中扩容（j+oldCap）的位置
                            hiTail.next = null;
                            newTab[j + oldCap] = hiHead;
                        }
                    }
                }
            }
        }
    
        //返回最新的结构
        return newTab;
    }

put方法包含了HashMap的实际初始化及构建的过程，仔细研究put方法，可以更好的了解HashMap这种数据结构

    /**
     * 根据key值获取value值
     */
    public V get(Object key) {
        Node<K,V> e;
        return (e = getNode(hash(key), key)) == null ? null : e.value;
    }

    /**
     * 根据哈希码及key值获取value值
     */
    final Node<K,V> getNode(int hash, Object key) {
        Node<K,V>[] tab; Node<K,V> first, e; int n; K k;

        //如果表不为空且表的长度不为空且根据hash码定位到桶不为空
        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) {
                //如果该节点是树形节点，则遍历红黑树查找匹配节点
                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;
    }