java 容器类研究一：HashMap源码原理分析

1. HashMap概述：

HashMap是基于哈希表的Map接口的非同步实现。此实现提供所有可选的映射操作，并允许使用null值和null键。此类不保证映射的顺序，特别是它不保证该顺序恒久不变。

2. HashMap的数据结构：

在java编程语言中，最基本的结构就是两种，一个是数组，另外一个是模拟指针（引用），所有的数据结构都可以用这两个基本结构来构造的，HashMap也不例外。HashMap实际上是一个“链表散列”的数据结构，即数组和链表的结合体。



从上图中可以看出，HashMap底层就是一个数组结构，数组中的每一项又是一个链表。当新建一个HashMap的时候，就会初始化一个数组。

3 .HashMap成员变量

//默认初始容量，总为2的次方值
static final int DEFAULT_INITIAL_CAPACITY = 16;

//最大容量
static final int MAXIMUM_CAPACITY = 1 << 30;

//默认加载因子
static final float DEFAULT_LOAD_FACTOR = 0.75f;

//Entry数组，每一个Entry是一个键值对实体
transient Entry[] table;

//实际存的Entry个数
transient int size;

//数组扩容的阀值，当size+1 > threshold时，扩充到以前容量的两倍
//threshold = table.length * loadFactor
int threshold;

//负载比率
final float loadFactor;

//Map结构一旦变化，如put remove clear等操作的时候，modCount随之变化
transient volatile int modCount;

可以看出，Entry就是数组中的元素，每个 Map.Entry 其实就是一个key-value对，它持有一个指向下一个元素的引用，这就构成了链表。
四.Entry对象

//很简单的一个键值对实体而已
static class Entry<K,V> implements Map.Entry<K,V> {
final K key;          //key
V value;              //value
Entry<K,V> next;  //next Entry
final int hash;       //计算出key的hash值

/**
* Creates new entry.
*/
Entry(int h, K k, V v, Entry<K,V> n) {
value = v;
next = n;
key = k;
hash = h;
}
.....
}

五.构造函数

// 构造函数
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);

// 将传入的initialCapacity值，转变成2的次方值capacity去实例化hashmap的属性
// 比喻传入initialCapacity = 100，则算出来capacity = 2 << 7 = 128，
// 最终threshold = 128 * 0.75 = 96，table = new Entry[128]
int capacity = 1;
while (capacity < initialCapacity)
capacity <<= 1;

this.loadFactor = loadFactor;
threshold = (int) (capacity * loadFactor);
table = new Entry[capacity];
// 模板方法模式，子类想在init里面做点什么重写init就好了
init();
}

六.hash算法和index算法

/**
* 让hashMap里面的元素尽量分布均需，方便查找
* @param h entry中key的hash值
* @return 打散后的hash值
*/
static int hash(int h) {
// This function ensures that hashCodes that differ only by
// constant multiples at each bit position have a bounded
// number of collisions (approximately 8 at default load factor).
h ^= (h >>> 20) ^ (h >>> 12);
return h ^ (h >>> 7) ^ (h >>> 4);
}

/**
* 类似求模运算， 将hash值同length-1(必定是01111...1)相与，运算的结果处于1到length-1间，0刚好用来保存key为null和0的元素
* @param h 打散后的hash值
* @param length 数组的长度
* @return 数组下标 1到lenght-1
*/
static int indexFor(int h, int length) {
return h & (length-1);
}

七. HashMap的存取实现：

public V put(K key, V value) {
//1.key为空时候，调用putForNullKey方法
if (key == null)
return putForNullKey(value);
//2.key不为空
//2-1.计算hash和index
int hash = hash(key.hashCode());
// 搜索指定hash值在对应table中的索引。
int i = indexFor(hash, table.length);
//2-2.根据index得到当前链表头e=table[i]不为空
for (Entry<K,V> e = table[i]; e != null; e = e.next) {
Object k;
//2-3.如果e满足hash(key.hashCode())=e.hash && key==e.key || key.equals(e.key)，value覆盖oldValue
if (e.hash == hash && ((k = e.key) == key || key.equals(k))) {
V oldValue = e.value;
e.value = value;
e.recordAccess(this);
return oldValue;
}
}
//2-4.table[i]为空，直接插入entry
// 如果i索引处的Entry为null，表明此处还没有Entry。
modCount++;
// 将key、value添加到i索引处。
addEntry(hash, key, value, i);
return null;
}
/**
从上面的源代码中可以看出：当我们往HashMap中put元素的时候，先根据key的hashCode重新计算hash值，根据hash值得到这个元素在数组中的位置（即下标），如果数组该位置上已经存放有其他元素了，那么在这个位置上的元素将以链表的形式存放，新加入的放在链头，最先加入的放在链尾。如果数组该位置上没有元素，就直接将该元素放到此数组中的该位置上。
*/
private V putForNullKey(V value) {
//1.从0位置的链表头开始，遍历
for (Entry<K,V> e = table[0]; e != null; e = e.next) {
//1-1.e.key==null时，直接替代value
if (e.key == null) {
V oldValue = e.value;
e.value = value;
e.recordAccess(this);
return oldValue;
}
}
//2.头Entry不存在时，直接插入entry
modCount++;
addEntry(0, null, value, 0);
return null;
}

/**
* @param hash 计算后key的hash值
* @param key
* @param value
* @param bucketIndex 应该插入到Entry[]的哪个位置
*/
void addEntry(int hash, K key, V value, int bucketIndex) {
//1.当前bucketIndex位置的头Entry e
Entry<K,V> e = table[bucketIndex];
//2.在bucketIndex位置新建一个Entry，新建Entry.next=原头Entry，也就是addEntry的Entry都被加到了链表头
table[bucketIndex] = new Entry<K,V>(hash, key, value, e);
//hashmap在每次addEntry完后检查是否扩容，而list是在每次加入之前检查：ensureCapacity(size + 1);elementData[size++] = e;
// 如果 Map 中的 key-value 对的数量超过了极限
if (size++ >= threshold)
// 把 table 对象的长度扩充到原来的2倍。
resize(2 * table.length);
}

//扩容，把hashmap的容量设置为新容量newCapacity
void resize(int newCapacity) {
Entry[] oldTable = table;
int oldCapacity = oldTable.length;
//每次扩到到原来的两倍，总有一个时候到MAXIMUM_CAPACITY
if (oldCapacity == MAXIMUM_CAPACITY) {
//到了MAXIMUM_CAPACITY设置threshold后直接return
threshold = Integer.MAX_VALUE;
return;
}

//1.新建newCapacity大小的Entry数组
Entry[] newTable = new Entry[newCapacity];
//2.把当前Entry的数据全部移到新Entry数组中
transfer(newTable);
//3.用已经就绪的新Entry数组重新给table赋值
table = newTable;
//4.设置新的threshold
threshold = (int)(newCapacity * loadFactor);
}

void transfer(Entry[] newTable) {
Entry[] src = table;
int newCapacity = newTable.length;
//1.从0开始遍历原Entry数组
for (int j = 0; j < src.length; j++) {
//2.拿到下标为j的链表头Entry e
Entry<K,V> e = src[j];
//3.遍历链表
if (e != null) {
src[j] = null;
do {
//3-1.e的下一个Entry，为了继续遍历做准备
Entry<K,V> next = e.next;
//3-2.计算e应该存放在新Entry数组的位置下标
int i = indexFor(e.hash, newCapacity);
//3-3.将e插入到新Entry[i]链表的表头
e.next = newTable[i];
//3-4.将Entry[i]表头的Entry重新定位为e，这样就完成了一个元素的重新hash
newTable[i] = e;
//3-5.继续链表的下一个Entry
e = next;
} while (e != null);
}
}
}

当系统决定存储HashMap中的key-value对时，完全没有考虑Entry中的value，仅仅只是根据key来计算并决定每个Entry的存储位置。我们完全可以把 Map 集合中的 value 当成 key 的附属，当系统决定了 key 的存储位置之后，value 随之保存在那里即可。

hash(int h)方法根据key的hashCode重新计算一次散列。此算法加入了高位计算，防止低位不变，高位变化时，造成的hash冲突。

static int hash(int h) {
h ^= (h >>> 20) ^ (h >>> 12);
return h ^ (h >>> 7) ^ (h >>> 4);
}

我们可以看到在HashMap中要找到某个元素，需要根据key的hash值来求得对应数组中的位置。如何计算这个位置就是hash算法。前面说过HashMap的数据结构是数组和链表的结合，所以我们当然希望这个HashMap里面的 元素位置尽量的分布均匀些，尽量使得每个位置上的元素数量只有一个，那么当我们用hash算法求得这个位置的时候，马上就可以知道对应位置的元素就是我们要的，而不用再去遍历链表，这样就大大优化了查询的效率。

对于任意给定的对象，只要它的 hashCode() 返回值相同，那么程序调用 hash(int h) 方法所计算得到的 hash 码值总是相同的。我们首先想到的就是把hash值对数组长度取模运算，这样一来，元素的分布相对来说是比较均匀的。但是，“模”运算的消耗还是比较大的，在HashMap中是这样做的：调用 indexFor(int h, int length) 方法来计算该对象应该保存在 table 数组的哪个索引处。indexFor(int h, int length) 方法的代码如下：

static int indexFor(int h, int length) {
return h & (length-1);
}

这个方法非常巧妙，它通过 h
& (table.length -1) 来得到该对象的保存位，而HashMap底层数组的长度总是 2 的n 次方，这是HashMap在速度上的优化。在 HashMap 构造器中有如下代码：

int capacity = 1;
while (capacity < initialCapacity)
capacity <<= 1;

这段代码保证初始化时HashMap的容量总是2的n次方，即底层数组的长度总是为2的n次方。

当length总是 2 的n次方时，h& (length-1)运算等价于对length取模，也就是h%length，但是&比%具有更高的效率。

这看上去很简单，其实比较有玄机的，我们举个例子来说明：

假设数组长度分别为15和16，优化后的hash码分别为8和9，那么&运算后的结果如下：

h & (table.length-1) hash table.length-1

8 & (15-1)： 0100 & 1110 = 0100

9 & (15-1)： 0101 & 1110 = 0100

-----------------------------------------------------------------------------------------------------------------------

8 & (16-1)： 0100 & 1111 = 0100

9 & (16-1)： 0101 & 1111 = 0101

从上面的例子中可以看出：当它们和15-1（1110）“与”的时候，产生了相同的结果，也就是说它们会定位到数组中的同一个位置上去，这就产生了碰撞，8和9会被放到数组中的同一个位置上形成链表，那么查询的时候就需要遍历这个链 表，得到8或者9，这样就降低了查询的效率。同时，我们也可以发现，当数组长度为15的时候，hash值会与15-1（1110）进行“与”，那么 最后一位永远是0，而0001，0011，0101，1001，1011，0111，1101这几个位置永远都不能存放元素了，空间浪费相当大，更糟的是这种情况中，数组可以使用的位置比数组长度小了很多，这意味着进一步增加了碰撞的几率，减慢了查询的效率！而当数组长度为16时，即为2的n次方时，2n-1得到的二进制数的每个位上的值都为1，这使得在低位上&时，得到的和原hash的低位相同，加之hash(int
h)方法对key的hashCode的进一步优化，加入了高位计算，就使得只有相同的hash值的两个值才会被放到数组中的同一个位置上形成链表。

所以说，当数组长度为2的n次幂的时候，不同的key算得得index相同的几率较小，那么数据在数组上分布就比较均匀，也就是说碰撞的几率小，相对的，查询的时候就不用遍历某个位置上的链表，这样查询效率也就较高了。

根据上面 put 方法的源代码可以看出，当程序试图将一个key-value对放入HashMap中时，程序首先根据该 key的 hashCode() 返回值决定该 Entry 的存储位置：如果两个 Entry 的 key 的 hashCode() 返回值相同，那它们的存储位置相同。如果这两个 Entry 的 key 通过 equals 比较返回 true，新添加 Entry 的 value 将覆盖集合中原有Entry 的 value，但key不会覆盖。如果这两个 Entry 的 key 通过 equals 比较返回 false，新添加的 Entry 将与集合中原有 Entry 形成 Entry 链，而且新添加的 Entry 位于 Entry 链的头部——具体说明继续看 addEntry() 方法的说明。

八.取数据

public V get(Object key) {
if (key == null)
return getForNullKey();
//key != null时
//1.根据key计算出hash和index
int hash = hash(key.hashCode());
//2.从index处的链表头Entry e开始遍历链表，
//如果e满足hash(key.hashCode()) == e.hash && (key == e.key || key.equals(e.key))，就是我们要找的entry
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.equals(k)))    //注释3里的逻辑更好理解
return e.value;
}
return null;
}

//如果key为空，直接从table[0]链表里面遍历寻找value
private V getForNullKey() {
for (Entry<K,V> e = table[0]; e != null; e = e.next) {
if (e.key == null)
return e.value;
}
return null;
}

有了上面存储时的hash算法作为基础，理解起来这段代码就很容易了。从上面的源代码中可以看出：从HashMap中get元素时，首先计算key的hashCode，找到数组中对应位置的某一元素，然后通过key的equals方法在对应位置的链表中找到需要的元素。

3) 归纳起来简单地说，HashMap 在底层将 key-value 当成一个整体进行处理，这个整体就是一个 Entry 对象。HashMap 底层采用一个 Entry[] 数组来保存所有的 key-value 对，当需要存储一个 Entry 对象时，会根据hash算法来决定其在数组中的存储位置，在根据equals方法决定其在该数组位置上的链表中的存储位置；当需要取出一个Entry时，也会根据hash算法找到其在数组中的存储位置，再根据equals方法从该位置上的链表中取出该Entry

九.删数据

public V remove(Object key) {
Entry<K, V> e = removeEntryForKey(key);
return (e == null ? null : e.value);
}

/**
* Removes and returns the entry associated with the specified key in the
* HashMap. Returns null if the HashMap contains no mapping for this key.
*/
final Entry<K, V> removeEntryForKey(Object key) {
// 1.计算hash和index
int hash = (key == null) ? 0 : hash(key.hashCode());
int i = indexFor(hash, table.length);
Entry<K, V> prev = table[i];
Entry<K, V> e = prev;
// 2.遍历i位置的Entry链表
while (e != null) {
Entry<K, V> next = e.next;
Object k;
// 2-1.e满足hash(key.hashCode()) == e.hash && (key == e.key ||
// key.equals(e.key))，找到了要移除的Entry
if (e.hash == hash
&& ((k = e.key) == key || (key != null && key.equals(k)))) {
// 2-2.移除操作modCount++, size--
modCount++;
size--;
// 2-3-1.如果prev和e相等，说明要删除的Entry是链表头，直接将table[i]位置的Entry设置为next，就删除了e
if (prev == e)
table[i] = next;
else
// 2-3-2.如果不相等e =
// prev.next，说明要删除的Entry是除链表头外的其他Entry，将prev.next设置为next，就删除了e
prev.next = next;
e.recordRemoval(this);
return e;
}
// 把prev和e到移到下一个
prev = e;
e = next;
}

return e;
}

/**
* 还是将o的key拿到，然后和removeEntryForKey(Object key)一样了
*
* @param o
*            must be Map.Entry
* @return
*/
final Entry<K, V> removeMapping(Object o) {
if (!(o instanceof Map.Entry))
return null;

Map.Entry<K, V> entry = (Map.Entry<K, V>) o;
Object key = entry.getKey();
......
}

十. HashMap的resize（rehash）：

当HashMap中的元素越来越多的时候，hash冲突的几率也就越来越高，因为数组的长度是固定的。所以为了提高查询的效率，就要对HashMap的数组进行扩容，数组扩容这个操作也会出现在ArrayList中，这是一个常用的操作，而在HashMap数组扩容之后，最消耗性能的点就出现了：原数组中的数据必须重新计算其在新数组中的位置，并放进去，这就是resize。

那么HashMap什么时候进行扩容呢？当HashMap中的元素个数超过数组大小*loadFactor时，就会进行数组扩容，loadFactor的默认值为0.75，这是一个折中的取值。也就是说，默认情况下，数组大小为16，那么当HashMap中元素个数超过16*0.75=12的时候，就把数组的大小扩展为 2*16=32，即扩大一倍，然后重新计算每个元素在数组中的位置，而这是一个非常消耗性能的操作，所以如果我们已经预知HashMap中元素的个数，那么预设元素的个数能够有效的提高HashMap的性能。

十一. HashMap的性能参数：

HashMap 包含如下几个构造器：

HashMap()：构建一个初始容量为 16，负载因子为 0.75 的 HashMap。

HashMap(int initialCapacity)：构建一个初始容量为 initialCapacity，负载因子为 0.75 的 HashMap。

HashMap(int initialCapacity, float loadFactor)：以指定初始容量、指定的负载因子创建一个 HashMap。

HashMap的基础构造器HashMap(int initialCapacity, float loadFactor)带有两个参数，它们是初始容量initialCapacity和加载因子loadFactor。

initialCapacity：HashMap的最大容量，即为底层数组的长度。

loadFactor：负载因子loadFactor定义为：散列表的实际元素数目(n)/ 散列表的容量(m)。

负载因子衡量的是一个散列表的空间的使用程度，负载因子越大表示散列表的装填程度越高，反之愈小。对于使用链表法的散列表来说，查找一个元素的平均时间是O(1+a)，因此如果负载因子越大，对空间的利用更充分，然而后果是查找效率的降低；如果负载因子太小，那么散列表的数据将过于稀疏，对空间造成严重浪费。

HashMap的实现中，通过threshold字段来判断HashMap的最大容量：

threshold = (int)(capacity * loadFactor);

结合负载因子的定义公式可知，threshold就是在此loadFactor和capacity对应下允许的最大元素数目，超过这个数目就重新resize，以降低实际的负载因子。默认的的负载因子0.75是对空间和时间效率的一个平衡选择。当容量超出此最大容量时， resize后的HashMap容量是容量的两倍

if (size++ >= threshold)
resize(2 * table.length);

十二. Fail-Fast机制：

我们知道java.util.HashMap不是线程安全的，因此如果在使用迭代器的过程中有其他线程修改了map，那么将抛出ConcurrentModificationException，这就是所谓fail-fast策略。

这一策略在源码中的实现是通过modCount域，modCount顾名思义就是修改次数，对HashMap内容的修改都将增加这个值，那么在迭代器初始化过程中会将这个值赋给迭代器的expectedModCount

HashIterator() {
expectedModCount = modCount;
if (size > 0) { // advance to first entry
Entry[] t = table;
while (index < t.length && (next = t[index++]) == null)
;
}
}

在迭代过程中，判断modCount跟expectedModCount是否相等，如果不相等就表示已经有其他线程修改了Map：

注意到modCount声明为volatile，保证线程之间修改的可见性。

final Entry<K,V> nextEntry() {
if (modCount != expectedModCount)
throw new ConcurrentModificationException();

在HashMap的API中指出：

由所有HashMap类的“collection 视图方法”所返回的迭代器都是快速失败的：在迭代器创建之后，如果从结构上对映射进行修改，除非通过迭代器本身的 remove 方法，其他任何时间任何方式的修改，迭代器都将抛出ConcurrentModificationException。因此，面对并发的修改，迭代器很快就会完全失败，而不冒在将来不确定的时间发生任意不确定行为的风险。

注意，迭代器的快速失败行为不能得到保证，一般来说，存在非同步的并发修改时，不可能作出任何坚决的保证。快速失败迭代器尽最大努力抛出 ConcurrentModificationException。因此，编写依赖于此异常的程序的做法是错误的，正确做法是：迭代器的快速失败行为应该仅用于检测程序错误。

from:http://zhangshixi.iteye.com/blog/672697

from:/article/3759706.html