JDK原始碼分析-Hashtable
概述
與 HashMap 類似， Hashtable 也是散列表的實現。它的內部結構可以理解為 「陣列 + 連結串列」的形式，結構示意圖如下：
Hashtable 的類繼承結構與簽名如下：
public class Hashtable<K,V>
extends Dictionary<K,V>
implements Map<K,V>, Cloneable, java.io.Serializable {}
Hashtable 的 key 和 value 都不能為空（HashMap 的 key 和 value 都允許為空），並且 key 必須要實現 hashCode 方法和 equals 方法。
PS: Hashtable 目前使用不是很多，若無執行緒安全的需求，推薦使用 HashMap；若需要執行緒安全的高併發實現，推薦使用 ConcurrentHashMap。
程式碼分析
Entry 類
private static class Entry<K,V> implements Map.Entry<K,V> {
final int hash;
final K key;
V value;
Entry<K,V> next;
protected Entry(int hash, K key, V value, Entry<K,V> next) {
this.hash = hash;
this.key = key;
this.value = value;
this.next = next;
}
public boolean equals(Object o) {
if (!(o instanceof Map.Entry))
return false;
Map.Entry<?,?> e = (Map.Entry<?,?>)o;
return (key==null ? e.getKey()==null : key.equals(e.getKey())) &&
(value==null ? e.getValue()==null : value.equals(e.getValue()));
}
public int hashCode() {
return hash ^ Objects.hashCode(value);
}
// ...
}
Entry 類實現了 Map.Entry 介面，是 Hashtable 中的節點類。
成員變數
// Hashtable 內部儲存元素的陣列
private transient Entry<?,?>[] table;
// Hashtable 的閾值 (int)(capacity * loadFactor)
private int threshold;
// 負載因子
private float loadFactor;
// 陣列能夠分配的最大容量
private static final int MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8;
構造器
// 構造一個空的 Hashtable，初始容量為 11，負載因子為 0.75
public Hashtable() {
this(11, 0.75f);
}
// 構造一個空的 Hashtable，指定初始容量，負載因子為 0.75
public Hashtable(int initialCapacity) {
this(initialCapacity, 0.75f);
}
// 構造一個空的 Hashtable，指定初始容量和負載因子
public Hashtable(int initialCapacity, float loadFactor) {
if (initialCapacity < 0)
throw new IllegalArgumentException("Illegal Capacity: "+
initialCapacity);
if (loadFactor <= 0 || Float.isNaN(loadFactor))
throw new IllegalArgumentException("Illegal Load: "+loadFactor);
if (initialCapacity==0)
initialCapacity = 1;
this.loadFactor = loadFactor;
table = new Entry<?,?>[initialCapacity];
threshold = (int)Math.min(initialCapacity * loadFactor, MAX_ARRAY_SIZE + 1);
}
// 使用給定的 Map 構造一個 Hashtable
public Hashtable(Map<? extends K, ? extends V> t) {
this(Math.max(2*t.size(), 11), 0.75f);
putAll(t);
}
主要方法分析
put 方法
public synchronized V put(K key, V value) {
// Make sure the value is not null (value 不能為空)
if (value == null) {
throw new NullPointerException();
}
// Makes sure the key is not already in the hashtable.
Entry<?,?> tab[] = table;
// 計算 key 在 table 中的索引
int hash = key.hashCode();
int index = (hash & 0x7FFFFFFF) % tab.length;
// 判斷 key 在 table 中是否已存在，若存在，則用 value 替換舊值
@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;
entry.value = value;
return old;
}
}
// 若不存在，則執行 addEntry 方法，將 key-value 新增到 table
addEntry(hash, key, value, index);
return null;
}
可以看到，key 或 value 有一個為空都會丟擲 NullPointerException 異常，因此二者都不能為空。
private void addEntry(int hash, K key, V value, int index) {
modCount++;
Entry<?,?> tab[] = table;
if (count >= threshold) {
// Rehash the table if the threshold is exceeded
// 超過閾值，則擴容
rehash();
tab = table;
hash = key.hashCode();
index = (hash & 0x7FFFFFFF) % tab.length;
}
// Creates the new entry.
// 將 key-value 新增到 table 中（頭插法，即插到連結串列的頭部）
// 即：先拿到 index 位置的元素，若為空，表示插入 entry 後則只有一個元素；
// 若不為空，表示該位置已有元素，將已有元素 e 連線到新的 entry 後面
@SuppressWarnings("unchecked")
Entry<K,V> e = (Entry<K,V>) tab[index];
tab[index] = new Entry<>(hash, key, value, e);
count++;
}
擴容操作 rehash() 如下：
protected void rehash() {
int oldCapacity = table.length;
Entry<?,?>[] oldMap = table;
// overflow-conscious code
// 新容量為舊容量的 2 倍加 1
int newCapacity = (oldCapacity << 1) + 1;
// 若新容量的值超過最大容量 MAX_ARRAY_SIZE，且舊容量為 MAX_ARRAY_SIZE，則直接返回；
// 若舊容量值不為 MAX_ARRAY_SIZE，則新容量為 MAX_ARRAY_SIZE.
if (newCapacity - MAX_ARRAY_SIZE > 0) {
if (oldCapacity == MAX_ARRAY_SIZE)
// Keep running with MAX_ARRAY_SIZE buckets
return;
newCapacity = MAX_ARRAY_SIZE;
}
// 新建一個 Entry 陣列，容量為上面計算的容量大小
Entry<?,?>[] newMap = new Entry<?,?>[newCapacity];
modCount++;
threshold = (int)Math.min(newCapacity * loadFactor, MAX_ARRAY_SIZE + 1);
table = newMap;
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;
}
}
}
擴容操作，若 index 位置為連結串列，且插入順序為 1、2、3 ，則在該位置的儲存順序為 3、2、1 。擴容時，會從前往後讀取元素並操作，因此擴容後的順序為 3、2、1。示意圖：
值得注意的是，put 方法（包括後面分析的 get 和 remove 等方法）帶有 synchronized 關鍵字，Hashtable 就是通過這種方式實現執行緒安全的。這裡鎖定的是整個 table，因此併發效率較低，這也是高併發場景下推薦使用 ConcurrentHashMap 的原因。
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;
}
分析過 put 方法後，get 方法和 remove 方法分析起來就比較簡單了，它們和 put 方法類似。
remove 方法
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];
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;
}
三種集合檢視 EntrySet、 keySet 和 values 分別如下:
private transient volatile Set<K> keySet;
private transient volatile Set<Map.Entry<K,V>> entrySet;
private transient volatile Collection<V> values;
public Set<K> keySet() {
if (keySet == null)
keySet = Collections.synchronizedSet(new KeySet(), this);
return keySet;
}
public Set<Map.Entry<K,V>> entrySet() {
if (entrySet==null)
entrySet = Collections.synchronizedSet(new EntrySet(), this);
return entrySet;
}
public Collection<V> values() {
if (values==null)
values = Collections.synchronizedCollection(new ValueCollection(),
this);
return values;
}
小結
1. Hashtable 是散列表的實現，處理雜湊衝突使用的是連結串列法，內部結構可以理解為「陣列 + 連結串列」；
2. 預設初始化容量為 11，預設負載因子為 0.75；
3. 執行緒安全，使用 synchronized 關鍵字， 併發效率低 ；
4. 若無需保證執行緒安全，推薦使用 HashMap；若需要執行緒安全的高併發場景，推薦使用 ConcurrentHashMap。
相關閱讀：
Stay hungry, stay foolish.
