HashMap源码分析

目录

• 1. 概述
• 2. 存储结构
  • 2-1. 什么是hash冲突?
  • 2-2. 如何解决hash冲突?
  • 2-3. 负载因子的作用
  • 2-4. HashMap的数组容量(桶容量)为什么必须是2的幂次方?
  • 2-5. hash算法中16的由来?
• 3. 构造函数
• 4. 操作
  • 4-1. 添加
    • 4-1-1. 在数组上添加
    • 4-1-2. 在链表上添加
    • 4-1-3. 在红黑树上添加
    • 添加源码如下
  • 4-2. 删除
    • 删除源码如下
  • 4-3. 查询
  • 4-4. 替换
• 5. 遍历
  • 5-1. 使用foreach进行遍历
  • 5-2. 使用keySet进行遍历
  • 5-3. 遍历所有的key
  • 5-4. 遍历所有的value
• 6. 扩容 & rehash
• 7. 总结

1. 概述

HashMap是一种key/value形式的存储结构. 它综合了数组(查询容易, 插入和删除困难)和链表(插入和删除容易, 查询困难)的特点.

HashMap的核心点就是hash算法和红黑树算法.

HashMap是无序的.

2. 存储结构

HashMap的存储结构为数组 + 链表/红黑树.

其中数组就是普通的数组, 链表是为了解决hash冲突而产生的, 如果冲突元素大于指定值, 就会由链表变为红黑树, 如果冲突元素少于指定的值, 就会由红黑树变为链表.

2-1. 什么是hash冲突?

当产生hash冲突的时候就产生了链表或红黑树, 一个完美的HashMap是单纯的数组结构, 并不会存在链表或红黑树结构的, 不过完美的事是不存在的, 只能尽可能的接近完美.

假设元素A被成功的添加到HashMap中, 存储在数组下标为0的地方, 这时元素B要被添加进来, 但是经过hash算法计算, 元素B要也要存储在数组下标为0的地方上, 这时候就产生了hash冲突.

2-2. 如何解决hash冲突?

出现了hash冲突, 解决方法就是在数组下标0处, 产生一个链表, 元素A为链表的表头, 新元素B放到链表的尾部.

称为拉链法.

2-3. 负载因子的作用

是这样的, 默认负载因子是0.75, 也就是HashMap中的数组填满了75%之后就会进行扩容.

• 如果负载因子过大, 则会导致hash冲突的机会越大, 但是空间使用率高;
• 如果负载因子过小, 则会导致空间的过度浪费, 但是hash冲突的机会越小.

所以, 必须在冲突的机会和空间利用率之间寻求一种平衡, 这种平衡本质上是数据结构中有名的时间和空间的平衡.

2-4. HashMap的数组容量(桶容量)为什么必须是2的幂次方?

首先给出答案: 为了使元素坐落于HashMap的承载量(size)之间.

答案和问题看起来毫无关系, 下面来分析一下是如何联系在一起的?

比如: 把"1"存入HashMap中, 会进行如下几步

1. 计算key的hashCode(key.hashCode()), 得到h
2. 然后对h进行低16位和高16位的异或运算, 得到hash (异或运算: 两个值不同为1, 相同为0)
3. 然后进行 (size - 1) & hash 的运算得到 (与运算: 两个都是1, 结果是1)

第二步中的低16位与高16位进行运算是为了更好的进行散列(如果两个元素的低16位相同, 不进行高低16位运算的话, 出现hash冲突的机会就会变大), 高低16位运算之后, 可以减少hash冲突的机会.

最重要的就是第三步了, 也就是问题的答案, 如果桶容量大小是2的倍数(默认值16), 进行(size - 1)运算之后的值为15, 15的二进制为0001111, 15与第二步得到的hash进行运算后, 只会保留低4位的值, 高于4位的值都被去掉了(运算后为0). 既然只有低4位的值, 那么转化为十进制之后, 必然小于16, 正确的坐落于桶上. 完美!

2-5. hash算法中16的由来?

贴出HashMap中的hash算法源码

static final int hash(Object key) {
	int h;
	return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
}

这段代码就是2-4问题中的第1,2步的实现, 那么这里的这个16数字是怎么来的呢???

答案就是因为key.hashCode()返回的是一个整数, 占4byte(32bit), 想充分打乱就要右移一半, 那就是16bit.

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);
}

默认的负载因子为: DEFAULT_LOAD_FACTOR(0.75).

用户自定义初始化容量, 但是HashMap会对传入的初始化容量进行校验(tableSizeFor), 需要确保这个值必须是2的幂次方.

4. 操作

4-1. 添加

添加操作分为三种情况:

1. 在数组上添加
2. 在链表上添加
3. 在红黑树上添加(比较菜, 不做讨论)

4-1-1. 在数组上添加

所谓在数组上添加, 就是没有发生hash冲突的情况下进行元素的添加, 这是最好的情况.

4-1-2. 在链表上添加

在链表上添加, 出现了hash冲突, 元素会被添加到链表的尾端

4-1-3. 在红黑树上添加

在红黑树上添加, 就是冲突的元素太多了, 链表的长度大于了指定的长度, 由于对链表的查询比较耗性能, 所以会转变为红黑树.

有红黑树生成的情况下是HashMap性能最差的情况.

添加源码如下

/**
 * Implements Map.put and related methods
 *
 * @param hash hash for key
 * @param key the key
 * @param value the value to put
 * @param onlyIfAbsent if true, don't change existing value
 * @param evict if false, the table is in creation mode.
 * @return previous value, or null if none
 */
final V putVal(int hash, K key, V value, boolean onlyIfAbsent, boolean evict) {

	HashMap.Node<K,V>[] tab; // 引用HashMap的table
	HashMap.Node<K,V> p; // HashMap中的一个节点
	int n, i; // n:HashMap中元素的个数; i:新元素的在数组中的下标

	// 如果table没有进行初始化, 先进行初始化操作
	if ((tab = table) == null || (n = tab.length) == 0) {
		n = (tab = resize()).length;
	}

	// 通过上面的说明: (n - 1) & hash 这段代码就是进行数组下标的运算
	if ((p = tab[i = (n - 1) & hash]) == null) {
		// 这是最好的情况: 没有出现hash冲突, 直接在创建一个节点放到该位置上
		tab[i] = newNode(hash, key, value, null);
	} else {
		// 出现了hash冲突, 需要区分几种情况: 
		// 1. 判断p的hash, key是否与传入的相同, 如果相同, 则默认会使用传入的value替换原先的value值.
		// 2. 如果有不同, 判断p节点是否是树, 如果是, 则进行红黑树的添加操作.
		// 3. 如果有不同, 并且不是树, 则只能是链表, 使用循环找到链表的最后一个元素, 链接在链表的尾部, 如果链表的长度大于一定长度, 就会由链表变为红黑树
		HashMap.Node<K,V> e;
		K k;

		// 这里比较了 hash, key 是否相同
		if (p.hash == hash && ((k = p.key) == key || (key != null && key.equals(k)))) {
			e = p;
		} else if (p instanceof HashMap.TreeNode) {
			// 进行红黑树的添加操作
			e = ((HashMap.TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
		} else {
			// 循环找到链表的最后一个元素, 并进行计数
			for (int binCount = 0; ; ++binCount) {
				if ((e = p.next) == null) {
					// 链接到最后一个元素
					p.next = newNode(hash, key, value, null);
					// 判断是否需要转为红黑树
					if (binCount >= TREEIFY_THRESHOLD - 1) { // -1 for 1st
						treeifyBin(tab, hash);
					}
					
					// 找到最后一个元素后即退出
					break;
				}
				
				// 每次循环时都要判断一下链表上元素的hash, key是否与传入的相同, 如果相同, 则默认会使用传入的value替换原先的value值.
				// 相同时, e对象即为冲突元素
				if (e.hash == hash && ((k = e.key) == key || (key != null && key.equals(k)))) {
					break;
				}
				p = e;
			}
		}
		
		// 如果e不为空, 则表示发生了冲突
		if (e != null) { // existing mapping for key
			V oldValue = e.value;
			if (!onlyIfAbsent || oldValue == null) {
				e.value = value;
			}
			// 这个在HashMap中实现为空, LinkedHashMap需要实现它
			afterNodeAccess(e);
			return oldValue;
		}
	}

	// HashMap结构的改变次数
	++modCount;

	// 判断是否需要扩容
	if (++size > threshold) {
		resize();
	}

	// 这个在HashMap中实现为空, LinkedHashMap需要实现它
	afterNodeInsertion(evict);
	return null;
}

4-2. 删除

由HashMap的数据结构可以想得到, 删除分为三种情况

1. 在数组上删除, 这种情况是最简单的, 只需指向null即可.
2. 在链表上删除, 由于链表对删除比较擅长, 直接让
3. 在红黑树上删除, 母鸡呀.

删除源码如下

/**
 * Implements Map.remove and related methods
 *
 * @param hash hash for key
 * @param key the key
 * @param value the value to match if matchValue, else ignored
 * @param matchValue if true only remove if value is equal
 * @param movable if false do not move other nodes while removing
 * @return the node, or null if none
 */
final Node<K,V> removeNode(int hash, Object key, Object value,
						   boolean matchValue, boolean movable) {
	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<K,V> node = null, e; 
		K k; 
		V v;
		
		// hash, key相同, 说明要删除该元素, 这种情况: node = p
		if (p.hash == hash && ((k = p.key) == key || (key != null && key.equals(k)))) {
			node = p;
		} else if ((e = p.next) != null) { // 如果hash,key不同, 判断是否有下一个元素
		
			// 如果下一个元素的节点类型是 TreeNode, 则去获取红黑树的节点
			if (p instanceof TreeNode)
				node = ((TreeNode<K,V>)p).getTreeNode(hash, key);
			else {
				// 是链表, 循环, 依次判断链表上的元素的hash和key是否相同, 找到即退出.
				do {
					if (e.hash == hash && ((k = e.key) == key || (key != null && key.equals(k)))) {
						node = e;
						break;
					}
					// p的值永远是相同节点的上一个节点
					p = e;
				} while ((e = e.next) != null);
			}
		}
		
		// 上面只是进行元素的查找, 这里才是真正的删除
		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;
			
			// 集合元素数量减1
			--size;
			
			// 这个在HashMap中实现为空, LinkedHashMap需要实现它
			afterNodeRemoval(node);
			
			// 返回删除的节点, 具体返回删除节点的value值.
			return node;
		}
	}
	return null;
}

4-3. 查询

通过分析上面的删除操作, 很明显, 在删除操作的前半部分是一个常规的查询操作.

4-4. 替换

替换操作也可以想象的到, 先找到要替换的元素(就是查询操作), 然后把value替换了即可.

5. 遍历

HashMap的的遍历有几种

5-1. 使用foreach进行遍历

实际上这种方式被编译之后是Iterator的方式.

例如

HashMap<String, String> map = new HashMap<>();
for (Map.Entry<String, String> entry : map.entrySet()) {
	System.out.println(entry.getKey() + ":" + entry.getValue());
}

反编译class文件

HashMap<String, String> map = new HashMap();
Iterator var2 = map.entrySet().iterator();
while(var2.hasNext()) {
	Entry<String, String> entry = (Entry)var2.next();
	System.out.println((String)entry.getKey() + ":" + (String)entry.getValue());
}

可以看到实际上是使用的entrySet().iterator()的方式, 语法糖?

5-2. 使用keySet进行遍历

这种方式不如使用foreach的性能好, 可以发现, 这种方式还要进行一次map.get(key)操作.

Iterator<String> iterator = map.keySet().iterator();
while (iterator.hasNext()) {
	String key = iterator.next();
	System.out.println(key + ":" + map.get(key));
}

5-3. 遍历所有的key

这种方式就可以简单的通过map.keySet()进行实现.

5-4. 遍历所有的value

这种方式可以通过map.values()进行获取.

6. 扩容 & rehash

这是一个比较重要的点, 扩容的同时还会带有rehash操作.

正常状态下, 会进行2倍扩容.

/**
 * Initializes or doubles table size.  If null, allocates in
 * accord with initial capacity target held in field threshold.
 * Otherwise, because we are using power-of-two expansion, the
 * elements from each bin must either stay at same index, or move
 * with a power of two offset in the new table.
 * 
 * @return the table
 */
final Node<K,V>[] resize() {

	// 获取桶引用
	Node<K,V>[] oldTab = table;
	
	// new HashMap()时oldCap=0
	// 有元素时, oldCap即为oldTab.length
	int oldCap = (oldTab == null) ? 0 : oldTab.length;
	
	// new HashMap()时threshold为0
	// 有元素时, threshold为桶长度的0.75
	int oldThr = threshold;
	
	// 定义新的桶容量, 新的threshold
	int newCap, newThr = 0;
	
	// new HashMap()时不会进入if
	// 有元素时, 旧桶的容量大于0, 会进入
	if (oldCap > 0) {
		
		// 旧桶的容量是否大于MAXIMUM_CAPACITY(1 << 30, 也就是Integer.MAX_VALUE / 2 + 1)
		// 直接返回 Integer.MAX_VALUE, 这里校验是防止 oldCap * 2 之后发生整型溢出.
		if (oldCap >= MAXIMUM_CAPACITY) {
			threshold = Integer.MAX_VALUE;
			return oldTab;
		}
		
		// 新桶的大小是旧桶大小的2倍(2倍扩容).
		else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&
				// 旧桶的长度大于等于16了
				oldCap >= DEFAULT_INITIAL_CAPACITY) {
				 
			// 2倍, 桶的长度扩大2倍,threshold也同时扩大2倍, 保持0.75不变.
			newThr = oldThr << 1; // double threshold
		}
	}
	
	// oldCap = 0 & oldThr > 0; 这种情况是使用 new HashMap(int initialCapacity) 
	// 或 new HashMap(int initialCapacity, float loadFactor)产生的
	else if (oldThr > 0) { // initial capacity was placed in threshold
		newCap = oldThr;
	}
		
	// new HashMap()时, 走这里
	else {               // zero initial threshold signifies using defaults
		newCap = DEFAULT_INITIAL_CAPACITY; // 16
		newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);  // 16 * 0.75 = 12
	}
	
	// 如果newThr还是为0, 可能是走了else if (oldThr > 0)这个条件
	if (newThr == 0) {
		float ft = (float)newCap * loadFactor;
		newThr = (newCap < MAXIMUM_CAPACITY && ft < (float)MAXIMUM_CAPACITY ?
				  (int)ft : Integer.MAX_VALUE);
	}
	
	// new HashMap()时 threshold = 12
	threshold = newThr;
	
	// 根据newCap创建新的桶
	@SuppressWarnings({"rawtypes","unchecked"})
	Node<K,V>[] newTab = (Node<K,V>[])new Node[newCap];
	
	// 改变table的指向
	table = newTab;
	
	// 进行旧桶中元素的rehash
	if (oldTab != null) {
		
		// 循环整个旧数组(桶)
		for (int j = 0; j < oldCap; ++j) {
			
			// 临时存储当前节点
			Node<K,V> e;
			
			// 节点不为null, 进行处理
			if ((e = oldTab[j]) != null) {
			
				// 先将桶的该位置置为null
				oldTab[j] = null;
			
				// 如果该节点的next属性为null, 说明这个节点处既没有链表也没有红黑树.
				// 直接用其hash值与新数组的长度进行一次与运算, 得到新的下标, 将该元素填充到这里
				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 { // preserve order
				
					// 将原先的一条链表拆分为两条链表
					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;
						}
						
						// 构造计算之后不等于0的一条链表
						else {
							if (hiTail == null)
								hiHead = e;
							else
								hiTail.next = e;
							hiTail = e;
						}
					} while ((e = next) != null);
					
					// 等于0的这条链表放在原先的位置不变
					if (loTail != null) {
						loTail.next = null;
						newTab[j] = loHead;
					}
					
					// 不等于0的这条链表放在 j+oldCap 的位置上
					if (hiTail != null) {
						hiTail.next = null;
						newTab[j + oldCap] = hiHead;
					}
				}
			}
		}
	}
	return newTab;
}

7. 总结

1. HashMap是无序的, 有序的Map可以参考LinkedHashMap.
2. HashMap是线程不安全的, 安全的Map可以参考ConcurrentHashMap.
3. HashMap的存储结构是数组 + 链表/红黑树.
4. 不要随便更改HashMap的负载因子: loadFactor.
5. 遍历HashMap时, 尽可能使用foreach语法或者使用entry().iterator().
6. HashMap扩容是2倍扩容, 并且伴随着rehash操作.