HashMap源码解析

Posted 2020-08-17 leskang

一 Entry

Entry是Map接口中的一个内部接口，它是实现键值对存储关键。在HashMap中，有Entry的实现类，叫做Entry。Entry类很简单，里面包含key，value，由外部引入的hash，还有指向下一个Entry对象的引用，和数据结构中学的链表中的note节点很类似,HashMap中的键值对实际是通过Entry存储的

 

Entry类的属性和构造函数:

final K key;
V value;
Entry<K,V> next;
int hash;
 
Entry(int h, K k, V v, Entry<K,V> n) {
value = v;
next = n;
key = k;
hash = h;
}

 

二 HashMap的初始化

//HashMap构造方法
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;
threshold = initialCapacity;
init();
}

 这是HashMap的构造函数之一，其他构造函数都引用这个构造函数进行初始化。参数InitialCapacity指的是HashMap中table数组最初的大小，参数loadFactory指的是HashMap可容纳键值对与数组长度的比值（举个例子：数组长度默认值为16，loadFactory默认值为0.75，如果HashMap中存储的键值对即Entry多于12，则会进行扩容，扩容后大小为当前数组长度的2倍）。在构造函数中不会对数组进行初始化，只有在put等操作方法内会进行判断是否要初始化或扩容。

 

三 table数组

在HashMap中有一个概念叫做threshold(实际可容纳量)，实际可容纳量指的是在HashMap中允许存在最多的Entry的个数，它是由HashMap中内置的数组table的长度*load factory(负载因子)得来。其作用是保证HashMap的效率。

table数组是HashMap实现键值对存储的又一关键，具体键值对保存方法请看下图

左边的数组索引是根据key的hash值计算得到，不同hash值有可能产生一样的索引，即哈希冲突，此时采用链地址法处理哈希冲突，即将所有索引一致的节点构成一个单链表；

 

如图中的[key，value]就是Entry对象来实现的，而table数组是用来存放Entry对象的。

//数组的初始化：
private void inflateTable(int toSize) {
// Find a power of 2 >= toSize
int capacity = roundUpToPowerOf2(toSize);
threshold = (int) Math.min(capacity * loadFactor, MAXIMUM_CAPACITY + 1);
table = new Entry[capacity];
initHashSeedAsNeeded(capacity);
}
 
private static int roundUpToPowerOf2(int number) {
return number >= MAXIMUM_CAPACITY ? MAXIMUM_CAPACITY : (number > 1) ? Integer.highestOneBit((number - 1) << 1) : 1;
}

 

在put等方法中发现数组未进行初始化时会调用InflateTable方法进行初始化，输入参数为初始设置的InitialCapacity，实际上他会调用roundUpToPowerOf2方法返回一个比初始容量大的最小的2的幂数（其中一个原因是在得到Entry所在数组位置时方便）。

 

四 增加（put）方法

public V put(K key, V value) {
if (table == EMPTY_TABLE) {
inflateTable(threshold);//初始化table数组，新建的hashmap中threshold代表初始容量16
}
if (key == null)
return putForNullKey(value);
int hash = hash(key);
int i = indexFor(hash, table.length);
for (Entry<K,V> e = table[i]; e != null; e = e.next) {
Object k;
if (e.hash == hash && ((k = e.key) == key || key.equals(k))) {
V oldValue = e.value;
e.value = value;
e.recordAccess(this);
return oldValue;
}
}
modCount++;
addEntry(hash, key, value, i);
return null;
}
 
private V putForNullKey(V value) {
for (Entry<K,V> e = table[0]; e != null; e = e.next) {
if (e.key == null) {
V oldValue = e.value;
e.value = value;
e.recordAccess(this);
return oldValue;
}
}
modCount++;
addEntry(0, null, value, 0);
return null;
}
//hash方法，用于返回hash值，通过hashCode（）方法实现
final int hash(Object k) {
int h = hashSeed;
if (0 != h && k instanceof String) {
return sun.misc.Hashing.stringHash32((String) k);
}
h ^= k.hashCode();
h ^= (h >>> 20) ^ (h >>> 12);
return h ^ (h >>> 7) ^ (h >>> 4);
}
 
void addEntry(int hash, K key, V value, int bucketIndex) {
if ((size >= threshold) && (null != table[bucketIndex])) {
resize(2 * table.length);
hash = (null != key) ? hash(key) : 0;
bucketIndex = indexFor(hash, table.length);
}
createEntry(hash, key, value, bucketIndex);
}
 
void createEntry(int hash, K key, V value, int bucketIndex) {
Entry<K,V> e = table[bucketIndex];
table[bucketIndex] = new Entry<>(hash, key, value, e);
size++;
}

 在put方法中

1. 首先会判断数组是否为空，如果为空会对数组进行初始化，初始化为初始容量为16，加载因子为0.75的空集合

2. 接下来判断key是否为null，如果为null就采用第二个方法对键值对进行put。

3. 接下来对key调用hash（）方法得到一个hash值，再对这个数值进行处理（IndexFor方法）得到所在数组中的位置。

4. 接下来遍历数组位置的链表，如果该位置的key的hash值和传入key的hash值相同且（key内存地址相等 或 equals方法相等），表示hashMap中已有此键值对，则会更新在链表中的value值，并返回旧的value值。

5. 如果上边的方法都没有奏效，则会继续执行到下面的addEntry创建一个新的Entry对象来添加传入的键值。

总体而言就是hash值相同的话会找此hash位置上的链表的各个对象逐个对比，如果相同则替换此链表位置上的值，如果hash值不相同则新建一个hash位置的table

 

在putForNullKey方法中，我们看到它是为了NULL值专门设置的，NULL值的hash始终为0，所以key为NULL的Entry对象肯定在数组的第0个位置。同样，如果找到则更新，没有找到则添加。

调用addEntry方法意味着要往这个数组链表中添加一个Entry，所以会在最开始判断已经存在的Entry数量是否超过了实际可容纳量。如果超过了，则会调用resize方法将数组扩大两倍，注意在扩大之后会对已经存入的Entry进行重排，原因是当初存入时IndexFor方法与数组长度有关系。接着会调用第四个方法。

createEntry方法很简单，就是将原本在数组中存放的链表头置入到新的Entry之后，将新的Entry放入数组中。从这里我们可以看出HashMap不保证顺序问题。

get方法和contains方法原理和put方法一致，即先通过对key的hash得到其value值所在的链表头在数组中的位置，再通过equals方法判断value是否存在。

 

五 删除（remove）方法

public V remove(Object key) {
Entry<K,V> e = removeEntryForKey(key);
return (e == null ? null : e.value);
}
 
final Entry<K,V> removeEntryForKey(Object key) {
if (size == 0) {
return null;
}
int hash = (key == null) ? 0 : hash(key);
int i = indexFor(hash, table.length);
Entry<K,V> prev = table[i];
Entry<K,V> e = prev;
while (e != null) {
Entry<K,V> next = e.next;
Object k;
if (e.hash == hash && ((k = e.key) == key || (key != null && key.equals(k)))) {
modCount++;
size--;
if (prev == e)
table[i] = next;
else
prev.next = next;
e.recordRemoval(this);
return e;
}
prev = e;
e = next;
}
return e;
}

 分析：

如图所示，列存放的是不同hash值对应的位置，整个列用table表示，table(hash值)代表链表第一个位置的元素，加入要找的value在entry3的位置，则：

第一步：table(i)=prev=e=entry0，然后判断hash值和key对象是否相等，第一步不相等，则执行： prev = e；e = next;故此时：prep=table(i)=entry0，e=entry1

第二步：判断hash值和key对象是否相等，第二步依然不相等，则执行： prev = e；e = next;故此时：prep=entry1，e=entry2

第三步：以此类推，继续hash值和key对象是否相等，到第三次时prep=entry2,e=entry3

第四步：第四次判断时e.key==key && key.equals(k) 满足条件，然后判断prev == e，此判断主要是为了判断是否是第一个元素，因为第一个元素的话两个值相等，只需要把next指针变成table（i）即可

此处不perp!=e则执行prev.next = next; perp.next正常应该等于entry3，现在执行prev.next = next（e.next=entry4）后prep.next指向了entry4，表示entry3没有指针指向它了，会被GC垃圾回收器自动回收，实现删除效果

 

六 查询（get）方法

public V get(Object key) {
if (key == null)
return getForNullKey();
Entry<K,V> entry = getEntry(key);
return null == entry ? null : entry.getValue();
}
 
private V getForNullKey() {
if (size == 0) {
return null;
}
for (Entry<K,V> e = table[0]; e != null; e = e.next) {
if (e.key == null)
return e.value;
}
return null;
}
 
final Entry<K,V> getEntry(Object key) {
if (size == 0) {
return null;
}
int hash = (key == null) ? 0 : hash(key);
for (Entry<K,V> e = table[indexFor(hash, table.length)];e != null;e = e.next) {
Object k;
if (e.hash == hash &&((k = e.key) == key || (key != null && key.equals(k))))
return e;
}
return null;
}

 总结：查询调用get时在hash值形同的位置上遍历链表，对比每个链表的key，用==或者equals方法寻找key相同的对象取出，当链表的next方法返回为null时表示到了链表结尾处，此处null表示entry对象没有取到来判断链表结束，不是键值对中的value为null，value是在entry对象的value中存储hashMap没有修改方法，插入时会直接替换原来的值

 

总结

最终数组初始化的容量大小会是大于等于你传入初始容量的最小2的幂数。

key为null或value为null能存入HashMap的原因是对null值会进行单独的操作。

在table数组中的链表中每个Entry的共同点是key的hash(key.hashCode)部分相同。

注意对key的hashCode和equals方法的重写如果你想让两个key映射一个对象，因为判定key相等的条件是（hashCode相等+（内存相等 或 equals相等））。

最早存入的键值对会在链表的末端。

当数组没有链表存在时，HashMap性能最好为O(1)。而最差为O(threshould)。