所使用的jdk版本为1.8.0_172版本,先看一下 Hashtable<K,V> 在JDK中Map的UML类图中的位置:
2.1 Hashtable<K,V> 类概述
上图中的继承实现关系不够详尽,先看一下 Hashtable 定义:
public class Hashtable<K,V>
extends Dictionary<K,V>
implements Map<K,V>, Cloneable, java.io.Serializable {
Hashtable继承实现了抽象类Dictionary<K,V>类,并且实现了Map<K,V>,Cloneable、Serializable三个接口。Dictionary<K,V>抽象类JDK已经注明是一个过时的类,新的实现应该实现Map<K,V>接口,而不是继承该类。
Hashtable存储映射用的是内部私有静态类 Entry<K,V>,基本思想就是 Entry<K,V>数组 加 Entry<K,V>链表 存储映射数据。看一下 Entry<K,V> 的简单定义:
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;
}
Hashtable<K,V>中的键K和值V不能是null,使用时用作键K的对象必须实现 hashCode
方法和 equals
方法。常用的Integer和String等都实现了这两个方法,如果是我们自己定义的的类作为Key,一定要记得实现。Hashtable是线程安全的,因为它的方法比如put、get等方法都用synchronized关键字修饰了,不过因为这种实现方式锁比较重,因此官方推荐如果不需要线程安全的Map实现,则推荐使用 HashMap;如果需要支持高并发的Map实现,推荐使用 ConcurrentHashMap。
Hashtable中有两个参数initialCapacity(初始容量)和 loadFactor(加载因子,float类型),两者影响Hashtable何时扩容Entry数组的长度以及Rehash的过程。Entry数组的长度达到阀值threshold(threshold = initialCapacity * loadFactor),put方法中就会触发扩容Rehash的过程,新的Entry数组长度 newCapacity = (oldCapacity * 2) + 1。
新数组的长度最大为 Integer.MAX_VALUE - 8。为什么不是整型最大值,原因如下:
(Some VMs reserve some header words in an array,Attempts to allocate larger arrays may result in OutOfMemoryError: Requested array size exceeds VM limit)。
initialCapacity的默认值为 11,loadFactor默认值为 0.75f。
2.1.1 构造方法
Hashtable提供了四种构造方法:
/**
* 用指定初始容量和指定加载因子构造一个新的空哈希表。
*/
public Hashtable(int initialCapacity, float loadFactor)
/**
* 用指定初始容量和默认的加载因子 (0.75) 构造一个新的空哈希表。
*/
public Hashtable(int initialCapacity)
/**
* 用默认的初始容量 (11) 和加载因子 (0.75) 构造一个新的空哈希表
*/
public Hashtable()
/**
* 构造一个与给定的 Map 具有相同映射关系的新哈希表。
*/
public Hashtable(Map<? extends K, ? extends V> t)
2.1.2 put 方法
public synchronized V put(K key, V value);
将指定的K-V映射关系放入Hashtable中,注意方法使用了synchronized关键字修饰。
入参:键和值都不可以为 null,否则抛出NullPointerException。
返回值:
此哈希表中指定key以前的值;如果不存在该key,则返回 null
代码简单分析:
public synchronized V put(K key, V value) {
// 校验映射的值value不能为null
if (value == null) {
throw new NullPointerException();
}
// 校验key是否已在Hashtable中
Entry<?,?> tab[] = table;
int hash = key.hashCode();
//计算key在Hashtable中位置,和整型的最大值做位与运算,保证得到一个正整数
//对entry[]长度取模运算,得到key在数组中的位置
int index = (hash & 0x7FFFFFFF) % tab.length;
@SuppressWarnings("unchecked")
Entry<K,V> entry = (Entry<K,V>)tab[index];
for(; entry != null ; entry = entry.next) {
//如果数组中的位置已被占用,遍历该位置的entry链表,查看该key是否已存在
//如果已存在,更新值,返回旧值
if ((entry.hash == hash) && entry.key.equals(key)) {
V old = entry.value;
entry.value = value;
return old;
}
}
//该key不存在,新建entry对象加入Hashtable,返回null
addEntry(hash, key, value, index);
return null;
}
再进入 addEntry(hash, key, value, index) 方法中看一下:
private void addEntry(int hash, K key, V value, int index) {
modCount++;
Entry<?,?> tab[] = table;
//检验数组长度是否达到容量阀值
if (count >= threshold) {
// 如果超过阈值,rehash过程
rehash();
tab = table;
hash = key.hashCode();
index = (hash & 0x7FFFFFFF) % tab.length;
}
//创建新的entry,头插法添加链表节点,tab[index]位置处放的是新加入的key对应的Entry对象.
@SuppressWarnings("unchecked")
Entry<K,V> e = (Entry<K,V>) tab[index];
tab[index] = new Entry<>(hash, key, value, e);
count++;
}
最后看一下 rehash() 过程:
/**
* 增加此哈希表的容量并在内部重新组织该哈希表
* 以便更有效地容纳和访问其哈希表
* 当哈希表中的键数超过该哈希表的容量和负载因子的乘积时,将自动调用此方法。
*/
@SuppressWarnings("unchecked")
protected void rehash() {
int oldCapacity = table.length;
Entry<?,?>[] oldMap = table;
//新的容量变为旧容量的2倍 + 1
//Entry[]最大容量的限制,整型最大值减8
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++;
//更新下一次触发rehash的阀值
threshold = (int)Math.min(newCapacity * loadFactor, MAX_ARRAY_SIZE + 1);
table = newMap;
//重新映射hashtable中已有的数据
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;
}
}
}
2.1.3 get 方法
public synchronized V get(Object key)
返回指定键key所映射到的值,如果此映射不包含此key的映射,则返回 null
. 注意get()方法也是被synchronized修饰。
更确切地讲,如果此映射包含满足 (key.equals(k))
的从键 k
到值 v
的映射,则此方法返回 v
;否则,返回 null
。
入参:key不能为null,否则抛出 NullPointerException
代码很简单:
public synchronized V get(Object key) {
Entry<?,?> tab[] = table;
int hash = key.hashCode();
int index = (hash & 0x7FFFFFFF) % tab.length;
//找到tab[index],遍历entry链表对比查找
for (Entry<?,?> e = tab[index] ; e != null ; e = e.next) {
if ((e.hash == hash) && e.key.equals(key)) {
return (V)e.value;
}
}
return null;
}
2.1.4 containsKey方法
public synchronized boolean containsKey(Object key)
测试指定对象是否为此哈希表中的键key
源代码很简单,和上面 get() 方法几乎一样:
public synchronized boolean containsKey(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 true;
}
}
return false;
}
2.1.4 containsValue 和 contains 方法
public boolean containsValue(Object value)
public synchronized boolean contains(Object value)
这两个方法基本功能一致,都是测试此映射表中是否存在与指定值value关联的键;其中containsValue方法内部直接调用的contains方法实现,所以方法定义没有加synchronized。
public synchronized boolean contains(Object value) {
if (value == null) {
throw new NullPointerException();
}
Entry<?,?> tab[] = table;
//两层循环,第一层遍历entry数组,第二层遍历entry链表
for (int i = tab.length ; i-- > 0 ;) {
for (Entry<?,?> e = tab[i] ; e != null ; e = e.next) {
if (e.value.equals(value)) {
return true;
}
}
}
return false;
}
2.1.5 remove 方法
public synchronized V remove(Object key)
从哈希表中移除该键及其相应的值。如果该键不在哈希表中,则此方法不执行任何操作。
入参:key不能为null,否则抛出 NullPointerException
返回值:此哈希表中与该键key存在映射关系的值;如果该键没有映射关系,则返回 null
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) {
//删除key操作就是考虑链表节点的删除,prev节点记录key的前置节点
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;
}
其余的方法,如size()、keySet()、entrySet()等,大家可以自己看一下,这里不再介绍了。