java.util.HashMap和java.util.HashTable (JDK1.8)

一、java.util.HashMap

1.1 java.util.HashMap 综述

java.util.HashMap继承结构如下图

HashMap是非线程安全的，key和value都支持null

HashMap的节点是链表，节点的equals比较的是节点的key和value内容是否相等。

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

1.2 HashMap属性

HashMap中的成员变量如下：

     transient Node<K,V>[] table;
     transient Set<Map.Entry<K,V>> entrySet;
     transient int size;
     transient int modCount;
     int threshold;
     final float loadFactor;

HashMap就是Node<K, V>数组，同时也是Map.Entry<K, V>集合。 transient修饰表明这些变量是不需要被序列化的。

size是指当前HashMap中有多少个node；

threshold表示下一次resize HashMap的值，换言之当size达到这个值的时候就需要扩容了，需要将现有的元素重新散列到扩容的空间；

loadFactor加载因子，因为HashMap并不会等空间全部使用完在扩容，通常会预留一部分。该值默认为0.75，threshold = loadFactor * capacity （此处有个前提就是loadFactor * capacity < MAXIMUM_CAPACITY ，也即小于 1 << 30）

modCount表示HashMap发生结构性修改的次数。

1.3 HashMap方法

先来看下计算hash的函数

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

这个hash算法实现的是：获取key的hashCode()，然后高16bit不变，低16bit和高16bit异或结果作为低16bit。

在put和get方法时计算下标采用：

 (n - 1) & hash

据代码注释解释，这种计算下标方式是综合考虑效率、作用和质量的结果。通常hash table的计算下标方式为模%，但是模%运算很容易发生碰撞，为什么这么说呢？不妨思考一下，在n - 1为15(0x1111)时，其实散列真正生效的只是低4bit的有效位，当然容易碰撞了。因此，设计者想了一个顾全大局的方法(综合考虑了速度、作用、质量)，就是把高16bit和低16bit异或了一下。设计者还解释到因为现在大多数的hashCode的分布已经很不错了，就算是发生了碰撞也用O(logn)的tree去做了。仅仅异或一下，既减少了系统的开销，也不会造成的因为高位没有参与下标的计算(table长度比较小时)，从而引起的碰撞。

整个过程图示如下：

在Java 8中使用了链表和红黑树来解决hash碰撞问题。链表法get一个key的时间复杂度是O(1) + O(n)，红黑树get一个key的时间复杂度为O(1) + O(logn)。从二者时间复杂度也能看出如果只使用链表解决hash碰撞，当碰撞非常严重的时候，效率并不理想，因此设定了一个链表的长度阈值，当长度超过该阈值（默认为8）则将链表转换为红黑树。

再来看下put方法，put方法的核心是putVal方法，代码如下

     final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
                    boolean evict) {
         Node<K,V>[] tab; Node<K,V> p; int n, i;
         if ((tab = table) == null || (n = tab.length) == 0)
             // table还未创建，则新建之
             n = (tab = resize()).length;
         if ((p = tab[i = (n - 1) & hash]) == null)
             // Hash 位置无数据，则直接插入
             tab[i] = newNode(hash, key, value, null);
         else {
             Node<K,V> e; K k;
             if (p.hash == hash &&
                 ((k = p.key) == key || (key != null && key.equals(k))))
                 // hash 位置上已经存在该key，则后续判断是否需要修改value
                 e = p;
             else if (p instanceof TreeNode)
                 // 红黑树节点，则将待插入节点插入到红黑树
                 // 如果插入过程中发现key已经存在于红黑树中，则后续判断是否需要修改value
                 e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
             else {
                 // 链表，则插入链表末尾
                 // 遍历链表过程中如果发现key已经存在，则后续判断是否需要修改value
                 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
                             // 链表长度超过一定长度（默认为8）则将链表转换为红黑树
                             treeifyBin(tab, hash);
                         break;
                     }
                     if (e.hash == hash &&
                         ((k = e.key) == key || (key != null && key.equals(k))))
                         break;
                     // 发现key已经存在于链表中了
                     p = e;
                 }
             }
             // table中已经存在该key了，根据onlyIfAbsent判断是否需要修改value
             if (e != null) { // existing mapping for key
                 V oldValue = e.value;
                 if (!onlyIfAbsent || oldValue == null)
                     e.value = value;
                 afterNodeAccess(e);
                 return oldValue;
             }
         }
         ++modCount;
         // 判断是否需要resize
         if (++size > threshold)
             resize();
         afterNodeInsertion(evict);
         return null;
     }

上面代码为JDK 1.8 HashMap put方法的核心部分。当调用putVal方法的时候，先按照hash算法(n - 1) & hash去table中取数据，如果取出来的是null，则新建一个newNode(hash, key, value, null)存入到下标为(n - 1) & hash的位置。

如果取出来的不是null，则说明table中以(n - 1) & hash为下标的位置上已经有数据了，这个时候有两种情况：有可能是该key已经存在于table中了，或者发生了hash冲突。

如果确实key已经存在于table中了p.hash == hash && ((k = p.key) == key || (key != null && key.equals(k)))），那么则查看onlyIfAbsent参数，如果为true则不修改该key的value，否则就更新value。

如果发生了hash冲突，此时有两种解决方法，一种是红黑树，一种是链表。

如果是链表，也很好解决，循环遍历链表，如果找到了某个节点的key等于待存入的key，则根据onlyIfAbsent决定是否需要更新value；找不到则新建一个节点存入到链表的结尾。当然这个链表不能无限制的扩展的，程序中设置链表最长为REEIFY_THRESHOLD - 1，也即为7。长度超过7则需要将链表构建为一颗红黑树。

如果不是链表，则需要在红黑树中处理，红黑树中同样需要先查看key是否存在，存在则根据onlyIfAbsent决定是否更新value，不存在则new一个放入到红黑树中。

整个putVal方法流程图如下图所示。

每次调用putVal方法，如果key不存在于table中则会增加modCount，table修改次数加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;
         if (oldCap > 0) {
             if (oldCap >= MAXIMUM_CAPACITY) {
                 threshold = Integer.MAX_VALUE;
                 return oldTab;
             }
             else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&
                      oldCap >= DEFAULT_INITIAL_CAPACITY)
                 // 通常情况下threshold成倍扩展
                 newThr = oldThr << 1; // double threshold
         }
         else if (oldThr > 0) // initial capacity was placed in threshold
             newCap = oldThr;
         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"})
             Node<K,V>[] newTab = (Node<K,V>[])new Node[newCap];
         table = newTab;
         // 如果不是初始化的resize，就需要重新hash了。
         if (oldTab != null) {
             // 根据oldCap遍历整个table
             for (int j = 0; j < oldCap; ++j) {
                 Node<K,V> e;
                 if ((e = oldTab[j]) != null) {
                     oldTab[j] = null;
                     if (e.next == null)
                         // 如果是单独的一个节点，则重新hash到新table中
                         newTab[e.hash & (newCap - 1)] = e;
                     else if (e instanceof TreeNode)
                         // 如果是红黑树则分裂红黑树
                         ((TreeNode<K,V>)e).split(this, newTab, j, oldCap);
                     else { // preserve order 保持原来的顺序，否则多线程同时resize会出现jdk1.7中的死链问题
                         // 对链表节点进行重新Hash，具体Hash算法下面详解
                         Node<K,V> loHead = null, loTail = null;
                         Node<K,V> hiHead = null, hiTail = null;
                         Node<K,V> next;
                         do {
                             next = e.next;
                             // oldCap就是新增的高位，相与 == 0则节点还应放在原下标
                             if ((e.hash & oldCap) == 0) {
                                 if (loTail == null)
                                     loHead = e;
                                 else
                                     loTail.next = e;
                                 loTail = e;
                             }
                             else { // 相与 != 0 则节点应该放在 原下标+oldCap
                                 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; // 应该放在 原下标+oldCap 位置的节点组成的链表
                         }
                     }
                 }
             }
         }
         return newTab;
     }

当table的size超过threshold = capacity * loadFactor时，需要对HashMap进行resize操作。capacity表示table的总容量，size表示已经存入了多少node。threshold为阈值，超过该阈值则需要进行resize操作。

resize的时候，通常情况为capacity << 1， threshold << 1，也即扩展为之前的两倍（超过MAXIMUM_CAPACITY情况另当别论）。

无论是链表还是红黑树，其中节点在resize过后都需要重新重新hash，但是Java8中重新Hash设计的非常巧妙。举例说明，假设table从16扩展为32，具体变化为：

元素在重新计算hash之后，因为n变为2倍(capacity << 1)，那么n-1的mask范围在高位多1bit(红色)，因此新的index就会发生这样的变化：

因此，我们在扩充HashMap的时候，不需要重新计算hash，只需要看看原来的hash值新增的那个bit是1还是0就好了，是0的话索引没变，是1的话索引变成“原索引+oldCap”。可以看看下图为16扩充为32的resize示意图：

这个设计确实非常的巧妙，既省去了重新计算hash值的时间，而且同时，由于新增的1bit是0还是1可以认为是随机的，因此resize的过程，均匀的把之前的冲突的节点分散到新的table中。牛逼！

两个主要的函数理解之后，其它方法就不是很困难了。再来看下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;
         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))))
                 // 判断找到的第一个节点，如果key相等（相等是为了处理key为null的情况）或equal则直接返回第一个
                 return first;
             if ((e = first.next) != null) {
                 if (first instanceof TreeNode)
                     // 如果是红黑树则去红黑树中查找该key
                     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;
     }

根据上面的描述，get方法还是很好理解的。在查找的时候，除了比较hash以外，还会比较key的内容(k = e.key) == key || (key != null && key.equals(k)))。

     public V remove(Object key) {
         Node<K,V> e;
         return (e = removeNode(hash(key), key, null, false, true)) == null ?
             null : e.value;
     }
 
     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;
         // 先get到对应key的节点，这部分代码跟get方法一样
         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;
             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 {
                         if (e.hash == hash &&
                             ((k = e.key) == key ||
                              (key != null && key.equals(k)))) {
                             node = e;
                             break;
                         }
                         // 保存节点
                         p = e;
                     } while ((e = e.next) != null);
                 }
             }
 
             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)
                     // 第一个节点就是待删除节点，直接将next节点存放到index位置
                     tab[index] = node.next;
                 else
                     // 链表，p为待删除节点的前一个节点
                     p.next = node.next;
                 ++modCount;
                 --size;
                 afterNodeRemoval(node);
                 return node;
             }
         }
         return null;
     }

参考：

https://tech.meituan.com/java-hashmap.html

https://yikun.github.io/2015/04/01/Java-HashMap%E5%B7%A5%E4%BD%9C%E5%8E%9F%E7%90%86%E5%8F%8A%E5%AE%9E%E7%8E%B0/

二、java.util.Hashtable

2.1 java.util.Hashtable综述

继承结构如下图：

Hashtable是线程安全的，key和value都不支持null。

2.2 Java.util.Hashtable属性

Hashtable属性如下，跟HashMap一样，也是一个数组。count表示当前table中有多少个Entry，threshold、loadFactor和modCount意义同HashMap。Hashtable的初始化capacity为11，loadFactor默认为0.75f。

     private transient Entry<?,?>[] table;
     private transient int count;
     private int threshold;
     private float loadFactor;
     private transient int modCount = 0;

2.3 Java.util.Hashtable方法

先来看下get方法

     public synchronized V get(Object key) {
         Entry<?,?> tab[] = table;
         int hash = key.hashCode();
         int index = (hash & 0x7FFFFFFF) % tab.length;
         for (Entry<?,?> e = tab[index] ; e != null ; e = e.next) {
             if ((e.hash == hash) && e.key.equals(key)) {
                 return (V)e.value;
             }
         }
         return null;
     }

get方法是synchronized方法，多线程执行的时候给整个hashtable对象加锁，这样一来效率肯定会打折扣，但是线程是安全的。

在hashtable中，index = (hash & 0x7FFFFFFF) % tab.length，将key.hashCode()除去符号位模上tab.length。目前hashtable仍然只使用了链表去解决hash碰撞问题，因此，如果tab[index]没找到，则遍历链表继续查找即可，算法复杂读O(n)。

在查找的时候除了比较hash值以外还会要求e.key.equals(key)对内容进行比较，因为key不允许为null，因此e.key也能保证不为null。

     private void addEntry(int hash, K key, V value, int index) {
         modCount++;
 
         Entry<?,?> tab[] = table;
         if (count >= threshold) {
             // 超过阈值，需要扩容，重新hash
             // Rehash the table if the threshold is exceeded
             rehash();
 
             tab = table;
             hash = key.hashCode();
             index = (hash & 0x7FFFFFFF) % tab.length;
         }
 
         // Creates the new entry.
         @SuppressWarnings("unchecked")
         // 保存下当前链表头部节点
         Entry<K,V> e = (Entry<K,V>) tab[index];
         // 插入到链表头部
         tab[index] = new Entry<>(hash, key, value, e);
         count++;
     }
 
     public synchronized V put(K key, V value) {
         // Make sure the value is not null
         if (value == null) {
             throw new NullPointerException();
         }
 
         // Makes sure the key is not already in the hashtable.
         Entry<?,?> tab[] = table;
         int hash = key.hashCode();
         int index = (hash & 0x7FFFFFFF) % tab.length;
         @SuppressWarnings("unchecked")
         Entry<K,V> entry = (Entry<K,V>)tab[index];
         for(; entry != null ; entry = entry.next) {
             if ((entry.hash == hash) && entry.key.equals(key)) {
                 // 如果key已经存在于hashtable，则直接替换旧的value
                 V old = entry.value;
                 entry.value = value;
                 return old;
             }
         }
         // 新建Entry，放在index位置上链表的头部
         addEntry(hash, key, value, index);
         return null;
     }

上面为put方法，put方法还是比较简单的，已经存在就更新value值，冲突了就添加到链表头部。

     public synchronized V remove(Object key) {
         Entry<?,?> tab[] = table;
         int hash = key.hashCode();
         // 定位下标
         int index = (hash & 0x7FFFFFFF) % tab.length;
         @SuppressWarnings("unchecked")
         Entry<K,V> e = (Entry<K,V>)tab[index];
         // 遍历链表，prev保存前一个节点
         for(Entry<K,V> prev = null ; e != null ; prev = e, e = e.next) {
             if ((e.hash == hash) && e.key.equals(key)) {
                 modCount++;
                 // 链表删除节点
                 if (prev != null) {
                     prev.next = e.next;
                 } else {
                     tab[index] = e.next;
                 }
                 count--;
                 V oldValue = e.value;
                 e.value = null;
                 return oldValue;
             }
         }
         return null;
     }

remove节点也比较简单。

     protected void rehash() {
         int oldCapacity = table.length;
         Entry<?,?>[] oldMap = table;
 
         // overflow-conscious code
         // 扩容为oldCapacity两倍+1
         int newCapacity = (oldCapacity << 1) + 1;
         if (newCapacity - MAX_ARRAY_SIZE > 0) {
             if (oldCapacity == MAX_ARRAY_SIZE)
                 // Keep running with MAX_ARRAY_SIZE buckets
                 return;
             newCapacity = MAX_ARRAY_SIZE;
         }
         Entry<?,?>[] newMap = new Entry<?,?>[newCapacity];
 
         modCount++;
         threshold = (int)Math.min(newCapacity * loadFactor, MAX_ARRAY_SIZE + 1);
         table = newMap;
         // 扩容后需要对原有数据进行重新hash分配位置
         for (int i = oldCapacity ; i-- > 0 ;) {
             for (Entry<K,V> old = (Entry<K,V>)oldMap[i] ; old != null ; ) {
                 Entry<K,V> e = old;
                 // 遍历链表
                 old = old.next;
                 // 重新确定位置
                 int index = (e.hash & 0x7FFFFFFF) % newCapacity;
                 // 新到来的节点插到链表开头位置
                 e.next = (Entry<K,V>)newMap[index];
                 newMap[index] = e;
             }
         }
     }

rehash扩容方法也还是比较简单，如果遇到链表遍历一下重新hash每个链表上的节点即可。

     public synchronized V putIfAbsent(K key, V value) {
         Objects.requireNonNull(value);
 
         // Makes sure the key is not already in the hashtable.
         Entry<?,?> tab[] = table;
         int hash = key.hashCode();
         int index = (hash & 0x7FFFFFFF) % tab.length;
         @SuppressWarnings("unchecked")
         Entry<K,V> entry = (Entry<K,V>)tab[index];
         // 先查找是否存在
         for (; entry != null; entry = entry.next) {
             if ((entry.hash == hash) && entry.key.equals(key)) {
                 V old = entry.value;
                 if (old == null) {
                     entry.value = value;
                 }
                 return old;
             }
         }
         // 不存在，则创建新节点插到链表开头
         addEntry(hash, key, value, index);
         return null;
     }

在putIfAbsent方法中需要先查找，找不到key或者key存在但是value为null，则插入。但是put方法中能确保插入的节点value都不为null，所以value为null的场景应该是不存在的。