Java数据结构详解（十二）- HashMap

HashMap

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

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

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

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

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

注意，此实现不是同步的。如果多个线程同时访问一个哈希映射，而其中至少一个线程从结构上修改了该映射，则它必须 保持外部同步。（结构上的修改是指添加或删除一个或多个映射关系的任何操作；仅改变与实例已经包含的键关联的值不是结构上的修改。）这一般通过对自然封装该映射的对象进行同步操作来完成。如果不存在这样的对象，则应该使用 Collections.synchronizedMap 方法来“包装”该映射。最好在创建时完成这一操作，以防止对映射进行意外的非同步访问，如下所示：

Map m = Collections.synchronizedMap(new HashMap(…));由所有此类的“collection 视图方法”所返回的迭代器都是快速失败 的：在迭代器创建之后，如果从结构上对映射进行修改，除非通过迭代器本身的 remove 方法，其他任何时间任何方式的修改，迭代器都将抛出 ConcurrentModificationException。因此，面对并发的修改，迭代器很快就会完全失败，而不冒在将来不确定的时间发生任意不确定行为的风险。

---

HashMap

//默认初始化容量 :16 必须是2的幂。
static final int DEFAULT_INITIAL_CAPACITY = 1 << 4;

//最大容量：1073741824 必须是2的幂
static final int MAXIMUM_CAPACITY = 1 << 30;

//默认的加载因子：0.75
static final float DEFAULT_LOAD_FACTOR = 0.75f;

//使用树的阈值:8 .在链地址法的节点到达阈值 8 之后转化为红黑树.
static final int TREEIFY_THRESHOLD = 8;

//卸载树的阈值: 6 如果发现链表长度小于 6，则会由树重新退化为链表.
static final int UNTREEIFY_THRESHOLD = 6;

//最小的hashmap容量:64 在转变成树之前，还会有一次判断，只有键值对数量大于 64 才会发生转换。这是为了避免在哈希表建立初期，多个键值对恰好被放入了同一个链表中而导致不必要的转化。
static final int MIN_TREEIFY_CAPACITY = 64;

---

HashMap.Node
HashMap的节点,和LinkedList的节点差不多,就是多了点东西.

    static class Node<K,V> implements Map.Entry<K,V> {
        //hash值
        final int hash;
        final K key;
        V value;

        //下一个Node的引用.
        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;
        }
        //get方法
        public final K getKey()        { return key; }
        public final V getValue()      { return value; }
        //toString方法
        public final String toString() { return key + "=" + value; }
        //hashCode方法
        public final int hashCode() {
            return Objects.hashCode(key) ^ Objects.hashCode(value);
        }
        //set方法
        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;
        }
    }

---

    /* ---------------- Static utilities -------------- */

静态工具方法

    static final int hash(Object key) {
        int h;
        //如果key为null 返回0 ,否则返回key的hashCode与h>>>16  进行异或运算的结果
        return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
    }

    //将给定的初始容量格式化成2的幂的方法，比如输入4，得到4，输入7得到8。
    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;
    }

---

/* ---------------- Fields -------------- */

HashMap Fields

//数组形式的节点 table
transient Node<K,V>[] table;

//键值对
transient Set<Map.Entry<K,V>> entrySet;

//键值对映射的数量
transient int size;

//改变的次数(HashMap不是线程同步的)
transient int modCount;

//调整大小的下一个大小值
int threshold;

//哈希表的负载因子
final float loadFactor;

---

HashMap的构造方法

    //无参构造器,使用默认的负载因子
    public HashMap() {
        this.loadFactor = DEFAULT_LOAD_FACTOR; // all other fields defaulted
    }

    //给定初始容量参数的构造方法,将会调用下一个构造方法,参数为默认的负载因子
    public HashMap(int initialCapacity) {
        this(initialCapacity, DEFAULT_LOAD_FACTOR);
    }

    //参数为初始化容量,和负载因子
    public HashMap(int initialCapacity, float loadFactor) {

        //初始容量参数的一系列判断.........start
        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);
        //初始容量参数的一系列判断.........end


        this.loadFactor = loadFactor;
        //将初始容量参数通过tableSizeFor格式化成2的幂.并返回给threshold 
        this.threshold = tableSizeFor(initialCapacity);
    }

    public HashMap(Map<? extends K, ? extends V> m) {
        //使用默认负载因子
        this.loadFactor = DEFAULT_LOAD_FACTOR;
        putMapEntries(m, false);
    }

---

HashMap -put

    //返回putVal方法
    public V put(K key, V value) {
        return putVal(hash(key), key, value, false, true);
    }

putVal();

    final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
                   boolean evict) {

        //节点tab 节点p  int n 和i ;
        Node<K,V>[] tab; Node<K,V> p; int n, i;

        //将字段中的table赋值给tab并判断tab是不是为null.
        if ((tab = table) == null || (n = tab.length) == 0)
            //创建一个新表
            n = (tab = resize()).length;

            //确定元素存放在哪个桶中，桶为空，(此时，这个结点是放在数组中)
        if ((p = tab[i = (n - 1) & hash]) == null)
            //将新生成结点放入桶中
            tab[i] = newNode(hash, key, value, null);
        else {//桶不为空,已经有元素在这个桶中,这个时候要解决桶冲突问题.
            Node<K,V> e; K k;

            //将传进来的参数与桶中第一个元素(数组中的结点)的hash值比较，key比较.
            if (p.hash == hash &&
                ((k = p.key) == key || (key != null && key.equals(k))))
                // 将第一个元素赋值给e，用e来记录
                e = p;
                //// hash值不相等，即key不相等；判断p是否为红黑树结点
            else if (p instanceof TreeNode)
                //将p转换为红黑树并将参数添加到树节点中
                e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
            else {//为链表.

                //for循环(一直循环)
                for (int binCount = 0; ; ++binCount) {

                    // 到达链表的尾部
                    if ((e = p.next) == null) {

                        //将参数添加到链表尾部
                        p.next = newNode(hash, key, value, null);

                        //如果链表长度大于阈值TREEIFY_THRESHOLD则转换为红黑树.
                        if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
                            treeifyBin(tab, hash);
                            //跳出
                        break;
                    }

                    //如果hash相等,key相等 说明链表中已经有相同的元素.则跳出循环.
                    if (e.hash == hash &&
                        ((k = e.key) == key || (key != null && key.equals(k))))
                        break;
                        //和p.next 结合控制链表的遍历
                    p = e;
                }
            }
            // 表示在桶中找到key值、hash值与插入元素相等的结点
            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;
    }

---

HashMap-get

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

    final Node<K,V> getNode(int hash, Object key) {
        Node<K,V>[] tab; Node<K,V> first, e; int n; K k;
        // table已经初始化，长度大于0，根据hash寻找table中的项也不为空
        if ((tab = table) != null && (n = tab.length) > 0 &&
            (first = tab[(n - 1) & hash]) != null) {
            // 桶中第一项(数组元素)相等
            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;
    }