1.8 HashMap学习笔记

概述

Hashmap支持null value和null key。（除了非同步和允许nulls，基本等同Hashtable）当数量超过load factor和capacity的乘积，hashtable会rehashed。
注意是非同步的，结构改变必须同步。（结构改变包含任何加减mappings的操作，仅更改关联key的值不是结构改变）
Collections.synchronizedMap会返回SynchronizedMap<K,V>，实现是把所有方法用synchronized包起来

存储结构

存储结构有两种，一个是普通节点

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

一个是红黑树节点

static final class TreeNode<K,V> extends LinkedHashMap.Entry<K,V> {
    TreeNode<K,V> parent;  // red-black tree links
    TreeNode<K,V> left;
    TreeNode<K,V> right;
    TreeNode<K,V> prev;    // needed to unlink next upon deletion
    boolean red;
    }

静态属性

static final int TREEIFY_THRESHOLD = 8;

链表长度大于8会转红黑树，还有一个条件

static final int MIN_TREEIFY_CAPACITY = 64;

在进行转换时，先检查长度是否>=8，第二检查数组容量，如果小，不转，对table数组扩容

static final int UNTREEIFY_THRESHOLD = 6;

扩容后，如果红黑树键值对过低，会重新转变为链表

HashMap成员属性

transient Node<K,V>[] table;

Node类型数组

transient int modCount;

引起结构变化的次数，主要用于迭代器访问时检测是否发生变化，支持快速失败行为

transient Set<Map.Entry<K,V>> entrySet;

调用entrySet（）可返回EntrySet实例，为了不至于每次调用都返回新的，设置该属性，缓存EntrySet实例

tableSizeFor(int cap)方法

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

通过 tableSizeFor 方法计算其合理的初始容量，初始容量暂存在threshold属性中

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

计算>=参数且满足2的幂的容量，使用位运算设计了高效的算法逻辑，这样操作后，会让原n-1的所有位都为1，+1后故可得

hash(Object key)方法

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

index = (n - 1) & hash

null对应桶下标为0
key.hashCode低16位和高16位异或
因为只能取到（n-1）以内的位，所以无法充分使用hashCode，经过这个变化，可以使键值更加分散

桶下标计算

如果能保证 capacity 为 2 的幂，那么就可以将这个操作转换为高效的位运算，也就是 HashMap 源码中的桶下标计算公式：

(capacity - 1) & hash

以上便是 HashMap 内部数组的容量为 2 的幂的其中一个原因，另一个原因是在 resize() 扩容方法中可以更高效的重新计算桶下标。

put(K key, V value)

final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
               boolean evict) {
    Node<K,V>[] tab; Node<K,V> p; int n, i;
    // 步骤①：table为空则创建
    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 {
    	// 步骤③：发生hash碰撞，若键已存在就返回该Node，并用属性 e 引用，若键不存在就创建一个新的Node，并直接插入到桶中
        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 {
            for (int binCount = 0; ; ++binCount) {
                if ((e = p.next) == null) {
                    // 直接插入新节点到链表的尾部
                    p.next = newNode(hash, key, value, null);
                    // 链表长度大于7转为红黑树处理
                    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;
}

resize()

用于初始化table或增加table数组大小
如果 table 数组为 null，则根据字段 threshold 中保持的初始容量进行分配。否则扩容，因为我们使用的是 2 的幂，所以每个桶中的元素必须保持相同的索引，或者在新 table 中以 2 的幂偏移。
容量为 16 时，hash1 和 hash2 经过桶下标计算后结果相同，会进入同一个桶中。当容量扩展为 32 后，新的桶下标计算过程如下所示：

32-1 = 0000 0000 0000 0000 0000 0000 0001 1111
hash1 = 0000 0000 0000 0000 0000 0000 0000 1111
hash2 = 0000 0000 0000 0000 0000 0000 0001 1111
// 桶下标为
(32-1)&hash1 = 0000 0000 0000 0000 0000 0000 0000 1111
(32-1)&hash2 = 0000 0000 0000 0000 0000 0000 0001 1111
hash1 和 hash2 经过桶下标公式重新计算之后，hash1的结果不变，所以依旧在原来的桶里；而 hash2 的结果比原来多了 1 位，即 2^4 = 16，也就是偏移了原来的容量大小。如下图所示：

因此，在扩充 HashMap 的时候，不需要重新计算 hash，只需要检查二进制 hash 中与二进制桶下标中新增的有效位的位置相同的那个位（以下简称“新增位”）是 0 还是 1 即可，是 0 的话索引没变，是 1 的话索引变成“原索引+oldCap”。
如何检查新增位是 0 还是 1 呢？HashMap 中使用 hash & oldCap 位与运算检查该新增位。oldCap 是 2 的幂，故二进制表示只有 1 位是 1，且该位正好与之对应。不得不说这个设计还是非常巧妙的，既省去了重新计算 hash 值的时间，而且，由于新增的 1 位是 0 还是 1 可以认为是随机的，因此在扩容的过程，均匀的把之前碰撞的节点分散到新旧桶中。

final Node<K,V>[] resize() {
    Node<K,V>[] oldTab = table;
    int oldCap = (oldTab == null) ? 0 : oldTab.length;
    int oldThr = threshold;
    int newCap, newThr = 0;
    // 步骤①：根据 oldCap 判断是扩容还是初始化数组，若是扩容..
    if (oldCap > 0) {
    	// 超过最大容量就不再扩容，随它去碰撞
        if (oldCap >= MAXIMUM_CAPACITY) {
            threshold = Integer.MAX_VALUE;
            return oldTab;
        }
        // 没超过最大值，就扩容为原来的2倍
        else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&
                 oldCap >= DEFAULT_INITIAL_CAPACITY)
            newThr = oldThr << 1; // double threshold
    }
    // 步骤②：若是初始化数组，若是字段 threshold 中已经保存初始容量
    else if (oldThr > 0) // initial capacity was placed in threshold
        newCap = oldThr;
    // 步骤③：若是初始化数组，若是字段 threshold 中没有保存初始容量，则使用默认容量
    else {               // zero initial threshold signifies using defaults
        newCap = DEFAULT_INITIAL_CAPACITY;
        newThr = (int)(DEFAULT_LOAD_FACTOR * 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"})
    // 步骤⑤：实例化新的 table 数组
    Node<K,V>[] newTab = (Node<K,V>[])new Node[newCap];
    table = newTab;
    if (oldTab != null) {
        // 步骤⑥：将每个桶及内部节点都移到新的 table 数组中
        for (int j = 0; j < oldCap; ++j) {
            Node<K,V> 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 { // preserve order
                    // 原桶的头尾节点引用
                    Node<K,V> loHead = null, loTail = null;
                    // 新桶的头尾节点引用
                    Node<K,V> hiHead = null, hiTail = null;
                    Node<K,V> next;
                    // 循环遍历桶内碰撞节点
                    do {
                        next = e.next;
                        // 新增位是 0 放原桶
                        if ((e.hash & oldCap) == 0) {
                            if (loTail == null)
                                loHead = e;
                            else
                                loTail.next = e;
                            loTail = e;
                        }
                        // 新增位是 1 放新桶
                        else {
                            if (hiTail == null)
                                hiHead = e;
                            else
                                hiTail.next = e;
                            hiTail = e;
                        }
                    } while ((e = next) != null);
                    // 原桶放新 table 数组
                    if (loTail != null) {
                        loTail.next = null;
                        newTab[j] = loHead;
                    }
                    // 新桶放新 table 数组
                    if (hiTail != null) {
                        hiTail.next = null;
                        newTab[j + oldCap] = hiHead;
                    }
                }
            }
        }
    }
    return newTab;
}

get(Object key)

返回值为 null 不一定表示不包含该键对应的映射关系，也可能表示该键对应的值为 null。 如果需要验证是否存在该键对应的映射关系可以调用 containsKey() 方法。

final Node<K,V> getNode(int hash, Object key) {
    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;
}

HashMap序列化与反序列化

在使用 put 操作存入一个键值对时，需要调用 key.hashCode() 方法参与计算 hash 值。而 Object.hashCode() 是 native 方法，不同的 JVM 里可能是不一样的。
所以，HashMap 取消对成员属性 table 的序列化操作，并实现了自己的序列化与反序列方法。

void internalWriteEntries(java.io.ObjectOutputStream s) throws IOException {
    Node<K,V>[] tab;
    if (size > 0 && (tab = table) != null) {
        for (int i = 0; i < tab.length; ++i) {
            for (Node<K,V> e = tab[i]; e != null; e = e.next) {
                s.writeObject(e.key);
                s.writeObject(e.value);
            }
        }
    }
}

private void readObject(java.io.ObjectInputStream s)
        throws IOException, ClassNotFoundException {
    // Read in the threshold (ignored), loadfactor, and any hidden stuff
    s.defaultReadObject();
    reinitialize();
    if (loadFactor <= 0 || Float.isNaN(loadFactor))
        throw new InvalidObjectException("Illegal load factor: " +
                loadFactor);
    s.readInt();                // Read and ignore number of buckets
    int mappings = s.readInt(); // Read number of mappings (size)
    // 如果键值对数量小于0，抛出异常
    if (mappings < 0)
        throw new InvalidObjectException("Illegal mappings count: " +
                mappings);
    // 如果键值对数量大于0            
    else if (mappings > 0) { // (if zero, use defaults)
        // Size the table using given load factor only if within
        // range of 0.25...4.0
        float lf = Math.min(Math.max(0.25f, loadFactor), 4.0f);
        float fc = (float)mappings / lf + 1.0f;
        int cap = ((fc < DEFAULT_INITIAL_CAPACITY) ?
                DEFAULT_INITIAL_CAPACITY :
                (fc >= MAXIMUM_CAPACITY) ?
                        MAXIMUM_CAPACITY :
                        tableSizeFor((int)fc));
        float ft = (float)cap * lf;
        threshold = ((cap < MAXIMUM_CAPACITY && ft < MAXIMUM_CAPACITY) ?
                (int)ft : Integer.MAX_VALUE);

        // Check Map.Entry[].class since it's the nearest public type to
        // what we're actually creating.
        SharedSecrets.getJavaOISAccess().checkArray(s, Map.Entry[].class, cap);
        //创建 table 数组
        @SuppressWarnings({"rawtypes","unchecked"})
        Node<K,V>[] tab = (Node<K,V>[])new Node[cap];
        table = tab;

        // Read the keys and values, and put the mappings in the HashMap
        // 读取键值对，通过 put 操作存入
        for (int i = 0; i < mappings; i++) {
            @SuppressWarnings("unchecked")
            K key = (K) s.readObject();
            @SuppressWarnings("unchecked")
            V value = (V) s.readObject();
            putVal(hash(key), key, value, false, false);
        }
    }
}