注意:本文基于JDK1.8进行记录。
1 简介
不允许插入key值相同的元素,允许插入null的key值。
底层由数组、链表、红黑树组成,数组中存储链表或红黑树,将一个key到value的映射作为一个元素,不能保证插入顺序和输出顺序一致。
线程不安全。
2 扩容机制
数组结构会有容量的概念,HashMap的默认容量为16,默认负载因子是0.75,表示当插入元素后个数超出长度的0.75倍时会进行扩增,默认扩容增量是1,所以扩增后容量为2倍。
最好指定初始容量值,避免过多的进行扩容操作而浪费时间和效率。
3 方法说明
3.1 构造方法
// 指定长度和负载因子的构造器。
public HashMap(int initialCapacity, float loadFactor);
// 指定长度的构造器,使用默认负载因子。
public HashMap(int initialCapacity);
// 空参构造器,使用默认负载因子。
public HashMap();
// 传入了一个集合的构造器,使用默认负载因子,添加指定集合。
public HashMap(Map<? extends K, ? extends V> m);
3.2 常用方法
// 获取个数。
public int size();
// 判断是否为空。
public boolean isEmpty();
// 根据key获取value,不存在会返回null。
public V get(Object key);
// 设置key和value键值对,返回原value,不存在会返回null。
public V put(K key, V value);
// 根据key删除键值对,返回原value,不存在会返回null。
public V remove(Object key);
// 清除所有元素。
public void clear();
4 源码分析
4.1 属性
静态属性:
// 默认容量为16,是2的整数次幂。
static final int DEFAULT_INITIAL_CAPACITY = 1 << 4;
// 最大容量是2的30次方,传入容量过大将被这个值替换。
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;
// 树化时哈希表最小的容量为64。为了避免冲突,该值至少为树化阈值和4的乘积。
static final int MIN_TREEIFY_CAPACITY = 64;
普通属性:
// 数组,用于存储链表和红黑树。
transient Node<K,V>[] table;
// 存储key和value键值对的集合。
transient Set<Map.Entry<K,V>> entrySet;
// 键值对的个数。
transient int size;
// 修改次数,用于快速失败机制。
transient int modCount;
// 扩容阈值。
int threshold;
// 负载因子。
final float loadFactor;
4.2 工具方法
// 根据key的hashCode重新计算hash值。
static final int hash(Object key) {
int h;
return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
}
// 根据长度计算阈值。
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;
}
4.3 构造方法
// 指定长度和负载因子的构造器。
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);
}
// 指定长度的构造器,使用默认负载因子。
public HashMap(int initialCapacity) {
this(initialCapacity, DEFAULT_LOAD_FACTOR);
}
// 空参构造器,使用默认负载因子。
public HashMap() {
this.loadFactor = DEFAULT_LOAD_FACTOR;
}
// 传入了一个集合的构造器,使用默认负载因子,添加指定集合。
public HashMap(Map<? extends K, ? extends V> m) {
this.loadFactor = DEFAULT_LOAD_FACTOR;
putMapEntries(m, false);
}
4.4 常用方法
// 获取个数。
public int size() {
return size;
}
// 判断是否为空。
public boolean isEmpty() {
return size == 0;
}
// 根据key获取value,不存在会返回null。
public V get(Object key) {
Node<K,V> e;
return (e = getNode(hash(key), key)) == null ? null : e.value;
}
// 根据key获取节点。
final Node<K,V> getNode(int hash, Object key) {
// 节点数组tab,数组首节点first,目标节点e,数组长度n,目标节点key值k。
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) {
// 判断数组首节点的key和value是否满足,满足则返回数组首节点。
if (first.hash == hash && ((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;
}
// 设置key和value键值对,返回原value,不存在会返回null。
public V put(K key, V value) {
return putVal(hash(key), key, value, false, true);
}
// 设置key和value键值对,返回原value,不存在会返回null。
final V putVal(int hash, K key, V value, boolean onlyIfAbsent, boolean evict) {
// 节点数组tab,指针节点p,数组长度n,数组位置i。
Node<K,V>[] tab; Node<K,V> p; int n, i;
// 赋值并判断,如果数组未初始化,则初始化数组。
if ((tab = table) == null || (n = tab.length) == 0)
n = (tab = resize()).length
// 如果数组已初始化,并且指针节点不存在,则创建新节点存储key和value。
if ((p = tab[i = (n - 1) & hash]) == null)
tab[i] = newNode(hash, key, value, null);
// 如果数组已初始化,并且指针节点存在,则查找key值相同节点并替换value。
else {
// 目标节点e,目标节点key值k。
Node<K,V> e; K k;
// 判断指针节点的key和value是否满足,满足则将指针节点作为目标节点。
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) {
// 创建新节点存储key和value。
p.next = newNode(hash, key, value, null);
// 如果新增后链表节点个数超过树化阈值,则尝试进行树化操作。
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;
}
}
// 如果目标节点存在,不需要个数自增和扩容,替换value并返回原值。
if (e != null) {
V oldValue = e.value;
if (!onlyIfAbsent || oldValue == null)
e.value = value;
afterNodeAccess(e);
return oldValue;
}
}
// 执行到这里,说明增加了新节点,操作数自增。
++modCount;
// 个数自增,如果自增后的个数超过了阈值则进行扩容。
if (++size > threshold)
resize();
// 添加新节点之后的后置处理。
afterNodeInsertion(evict);
// 返回null。
return null;
}
// 根据key删除键值对,返回原value,不存在会返回null。
public V remove(Object key) {
Node<K,V> e;
return (e = removeNode(hash(key), key, null, false, true)) == null ? null : e.value;
}
// 根据key删除键值对,并返回原节点。
final Node<K,V> removeNode(int hash, Object key, Object value, boolean matchValue, boolean movable) {
// 节点数组tab,指针节点p,数组长度n,数组位置index。
Node<K,V>[] tab; Node<K,V> p; int n, index;
// 赋值并判断,如果数组已初始化,并且数组首节点不为空,才删除元素。
if ((tab = table) != null && (n = tab.length) > 0 && (p = tab[index = (n - 1) & hash]) != null) {
// 原节点node,目标节点e,目标节点key值k,目标节点value值v。
Node<K,V> node = null, e; K k; V v;
// 判断指针节点的key和value是否满足,满足则将指针节点作为原节点。
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);
}
}
// 原节点存在,并且满足value值的判断规则,那就继续执行。
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)
tab[index] = node.next;
// 如果原节点是链表节点,并且原节点和指针节点不同,则将原节点的下一节点作为指针节点的下一节点。
else
p.next = node.next;
// 执行到这里,说明删除了原节点,操作数自增。
++modCount;
// 个数自减。
--size;
afterNodeRemoval(node);
// 返回原节点。
return node;
}
}
return null;
}
// 清除所有元素。
public void clear() {
// 定义节点数组tab。
Node<K,V>[] tab;
// 操作数自增。
modCount++;
// 如果数组已初始化,则设置个数为0,并且将每个节点置空。
if ((tab = table) != null && size > 0) {
size = 0;
for (int i = 0; i < tab.length; ++i)
tab[i] = null;
}
}
4.5 扩容方法
final Node<K,V>[] resize() {
// 记录原节点数组。
Node<K,V>[] oldTab = table;
// 记录原数组容量。
int oldCap = (oldTab == null) ? 0 : oldTab.length;
// 记录原阈值。
int oldThr = threshold;
// 定义新数组容量,定义新数组阈值。
int newCap, newThr = 0;
// 如果原容量大于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)
// 将原阈值扩容一倍并赋值给新阈值。
newThr = oldThr << 1;
}
// 原容量为0,判断原阈值是否大于0。
else if (oldThr > 0)
// 首次初始化,将原阈值赋值给新容量。
newCap = oldThr;
// 原容量为0,并且原阈值也是0。
else {
// 设置默认容量。
newCap = DEFAULT_INITIAL_CAPACITY;
// 设置默认阈值。
newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
}
// 判断新阈值是否为0。
if (newThr == 0) {
// 计算新阈值。
float ft = (float)newCap * loadFactor;
// 新容量小于容量最大值并且阈值小于容量最大值,则使用新阈值,否则使用最大值。
newThr = (newCap < MAXIMUM_CAPACITY && ft < (float)MAXIMUM_CAPACITY ? (int)ft : Integer.MAX_VALUE);
}
// 确定新阀值。
threshold = newThr;
// 开始构造新的节点数组。
Node<K,V>[] newTab = (Node<K,V>[])new Node[newCap];
table = newTab;
// 如果原节点数组已初始化,则将原节点放置到新节点数组。
if (oldTab != null) {
// 遍历原节点数组。
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 {
// 定义低位链表的头节点和尾节点。
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);
// 如果低位链表不为空,则将整个低位链表放到原位置。
if (loTail != null) {
loTail.next = null;
newTab[j] = loHead;
}
// 如果高位链表不为空,则将整个高位链表放到新增的空间中。
if (hiTail != null) {
hiTail.next = null;
newTab[j + oldCap] = hiHead;
}
}
}
}
}
// 返回新的节点数组。
return newTab;
}
5 补充说明
5.1 数组长度为2的倍数
长度减一后的二进制位全为1,可以用来计算节点在数组中的位置,不会造成浪费。
5.2 指定长度不为2的倍数
在构造方法中的最后一步会根据指定长度计算容量,会通过移位运算得到大于等于指定长度的,并且为2的倍数的最小正整数。
5.3 先使用hashCode()方法,再使用equals()方法
在Object类中有一个hashCode()方法,用来获取对象的哈希值,也被称作为散列值。
hashCode()方法被native修饰,意味着这个方法和平台有关。大多数情况下,hashCode()方法返回的是与对象信息(存储地址和字段等)有关的数值。
当向集合中插入对象时,如果调用equals()逐个进行比较,虽然可行但是这样做的效率很低。因此,先调用hashCode()进行判断,如果相同再调用equals()判断,就会提高效率。
5.4 使用hash()方法处理hashCode
在计算节点在数组中的下标时,一般是通过与节点有关的数值除以数组长度取余得到的。当数组长度为2的倍数时,取余操作相当于数值同数组长度减一进行与运算。
根据数组长度减一得到的结果,将二进制位分为高位和低位,将左边全为0的部分作为高位,将右边全为1的部分作为低位。在与运算时,任何数字与0相与只能得到0,所以高位无效,只用到了低位。
如果使用hashCode进行与运算,两个hashCode不同但是低位相同的节点会被分到一个数组中,哈希碰撞发生的可能性较大。因此,需要对hashCode进行处理,使两个高位不同低位相同的节点得到的结果也不同。
hash()方法被称为扰动函数,是用来对hashCode进行处理的方法。在hash()方法处理后,hashCode高位的变化也会影响低位,这时再使用低位计算下标就能使元素的分布更加合理,哈希碰撞的可能性也会降低。
在JDK1.8版本中,只使用了hashCode进行了一次与运算:
static final int hash(Object key) {
int h;
return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
}
5.5 何时进行扩容
1)插入第一个节点时,初始化数组时进行扩容。
2)插入节点后,长度超过阈值时进行扩容。
5.6 扩容时对链表结构的处理
使用高低位链表,将节点的hash值同原数组长度进行与运算,根据结果0和1放到低位链表和高位链表。
将低位链表放置到新数组的低位,将高位链表放置到新数组的高位,低位的位置加上原数组长度就是高位的位置。
5.7 重写equals方法和hashCode方法
一般在重写equals()方法的时候,也会尽量重写hashCode()方法,就是为了在equals()方法判断相等的时候保证让hashCode()方法判断相等。