JavaSE_HashMap 源码详解 put, get 方法

参考文章:

java 8 Hashmap深入解析 —— put get 方法源码

https://www.cnblogs.com/jzb-blog/p/6637823.html

       一直以来我是对读源码很不理解的,直到昨天去解读了 部分的 HashMap 源码,发现源码中有很多精巧的设计。体现了很多语言层次深入的东西。

  对于普通的程序员,可能仅仅能说出HashMap线程不安全,允许key、value为null,以及不要求线程安全时,效率上比HashTable要快一些。

    稍微好一些的,会对具体实现有过大概了解,能说出HashMap由数组+链表+RBT实现,并了解HashMap的扩容机制。

    但如果你真的有一个刨根问题的热情,那么你肯定会想知道具体是如何一步步实现的。HashMap的源码一共2000多行,很难在这里每一句都说明,但这篇文章会让你透彻的理解到我们平时常用的几个操作下,HashMap是如何工作的。

   要先提一下的是,我看过很多讲解HashMap原理的文章,有一些讲的非常好,但这些文章习惯于把源代码和逻辑分析分开,导致出现了大段的文字讲解代码,阅读起来有些吃力和枯燥。所以我想尝试另一种风格,将更多的内容写进注释里,可能看起来有些啰嗦,但对于一些新手的理解,应该会有好的效果。

 

好了,开始进入源码解读。

 

 

HashMap结构

 

   首先是了解HashMap的几个核心成员变量(以下均为jdk源码):

transient Node<K,V>[] table;                //HashMap的哈希桶数组,非常重要的存储结构,用于存放表示键值对数据的Node元素。

transient Set<Map.Entry<K,V>> entrySet;    //HashMap将数据转换成set的另一种存储形式,这个变量主要用于迭代功能。

transient int size;                        //HashMap中实际存在的Node数量,注意这个数量不等于table的长度,甚至可能大于它,因为在table的每个节点上是一个链表(或RBT)结构,可能不止有一个Node元素存在。

transient int modCount;                    //HashMap的数据被修改的次数,这个变量用于迭代过程中的Fail-Fast机制,其存在的意义在于保证发生了线程安全问题时,能及时的发现(操作前备份的count和当前modCount不相等)并抛出异常终止操作。

int threshold;                            //HashMap的扩容阈值,在HashMap中存储的Node键值对超过这个数量时,自动扩容容量为原来的二倍。

final float loadFactor;                   //HashMap的负载因子,可计算出当前table长度下的扩容阈值:threshold = loadFactor * table.length。

    那么这些变量的默认值都是多少呢?我们再看一下HashMap定义的一些常量:

//默认的初始容量为16,必须是2的幂次
static final int DEFAULT_INITIAL_CAPACITY = 1 << 4; 

//最大容量即2的30次方
static final int MAXIMUM_CAPACITY = 1 << 30;

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

//当put一个元素时,其链表长度达到8时将链表转换为红黑树
static final int TREEIFY_THRESHOLD = 8;

//链表长度小于6时,解散红黑树
static final int UNTREEIFY_THRESHOLD = 6;

//默认的最小的扩容量64,为避免重新扩容冲突,至少为4 * TREEIFY_THRESHOLD=32,即默认初始容量的2倍
static final int MIN_TREEIFY_CAPACITY = 64;

 

  其次 HashMap的底层实现是基于一个Node的数组,那么Node是什么呢?在HashMap的内部可以看见定义了这样一个内部类:

Node类 :

static class Node<K,V> implements Map.Entry<K,V> {
  final int hash;
  final K key;
    V value;
    Node<K,V> next;

    Node(int hash, K key, V value, Node<K,V> next) {
        this.hash = hash;
        this.key = key;
        this.value = value;
        this.next = next;
    }

    public final K getKey()        { return key; }
    public final V getValue()      { return value; }
    public final String toString() { return key + "=" + value; }

    public final int hashCode() {
        return Objects.hashCode(key) ^ Objects.hashCode(value);
    }

    public final V setValue(V newValue) {
        V oldValue = value;
        value = newValue;
        return oldValue;
    }

    public final boolean equals(Object o) {
        if (o == this)
            return true;
        if (o instanceof Map.Entry) {
            Map.Entry<?,?> e = (Map.Entry<?,?>)o;
            if (Objects.equals(key, e.getKey()) &&
                Objects.equals(value, e.getValue()))
                return true;
        }
        return false;
    }
}

 

 

       除此之外,在put 的过程中还用到了 TreeNode 类,我们看下 treenode 的源码:

/* ------------------------------------------------------------ */
// Tree bins

/**
 * Entry for Tree bins. Extends LinkedHashMap.Entry (which in turn
 * extends Node) so can be used as extension of either regular or
 * linked node.
 */
static final class TreeNode<K,V> extends LinkedHashMap.Entry<K,V> {
	TreeNode<K,V> parent;  // red-black tree links
	TreeNode<K,V> left;
	TreeNode<K,V> right;
	TreeNode<K,V> prev;    // needed to unlink next upon deletion
	boolean red;
	TreeNode(int hash, K key, V val, Node<K,V> next) {
		super(hash, key, val, next);
	}

	/**
	 * Returns root of tree containing this node.
	 */
	final TreeNode<K,V> root() {
		for (TreeNode<K,V> r = this, p;;) {
			if ((p = r.parent) == null)
				return r;
			r = p;
		}
	}

	/**
	 * Ensures that the given root is the first node of its bin.
	 */
	static <K,V> void moveRootToFront(Node<K,V>[] tab, TreeNode<K,V> root) {
		int n;
		if (root != null && tab != null && (n = tab.length) > 0) {
			int index = (n - 1) & root.hash;
			TreeNode<K,V> first = (TreeNode<K,V>)tab[index];
			if (root != first) {
				Node<K,V> rn;
				tab[index] = root;
				TreeNode<K,V> rp = root.prev;
				if ((rn = root.next) != null)
					((TreeNode<K,V>)rn).prev = rp;
				if (rp != null)
					rp.next = rn;
				if (first != null)
					first.prev = root;
				root.next = first;
				root.prev = null;
			}
			assert checkInvariants(root);
		}
	}

	/**
	 * Finds the node starting at root p with the given hash and key.
	 * The kc argument caches comparableClassFor(key) upon first use
	 * comparing keys.
	 */
	final TreeNode<K,V> find(int h, Object k, Class<?> kc) {
		TreeNode<K,V> p = this;
		do {
			int ph, dir; K pk;
			TreeNode<K,V> pl = p.left, pr = p.right, q;
			if ((ph = p.hash) > h)
				p = pl;
			else if (ph < h)
				p = pr;
			else if ((pk = p.key) == k || (k != null && k.equals(pk)))
				return p;
			else if (pl == null)
				p = pr;
			else if (pr == null)
				p = pl;
			else if ((kc != null ||
					  (kc = comparableClassFor(k)) != null) &&
					 (dir = compareComparables(kc, k, pk)) != 0)
				p = (dir < 0) ? pl : pr;
			else if ((q = pr.find(h, k, kc)) != null)
				return q;
			else
				p = pl;
		} while (p != null);
		return null;
	}

	/**
	 * Calls find for root node.
	 */
	final TreeNode<K,V> getTreeNode(int h, Object k) {
		return ((parent != null) ? root() : this).find(h, k, null);
	}

	/**
	 * Tie-breaking utility for ordering insertions when equal
	 * hashCodes and non-comparable. We don't require a total
	 * order, just a consistent insertion rule to maintain
	 * equivalence across rebalancings. Tie-breaking further than
	 * necessary simplifies testing a bit.
	 */
	static int tieBreakOrder(Object a, Object b) {
		int d;
		if (a == null || b == null ||
			(d = a.getClass().getName().
			 compareTo(b.getClass().getName())) == 0)
			d = (System.identityHashCode(a) <= System.identityHashCode(b) ?
				 -1 : 1);
		return d;
	}

	/**
	 * Forms tree of the nodes linked from this node.
	 * @return root of tree
	 */
	final void treeify(Node<K,V>[] tab) {
		TreeNode<K,V> root = null;
		for (TreeNode<K,V> x = this, next; x != null; x = next) {
			next = (TreeNode<K,V>)x.next;
			x.left = x.right = null;
			if (root == null) {
				x.parent = null;
				x.red = false;
				root = x;
			}
			else {
				K k = x.key;
				int h = x.hash;
				Class<?> kc = null;
				for (TreeNode<K,V> p = root;;) {
					int dir, ph;
					K pk = p.key;
					if ((ph = p.hash) > h)
						dir = -1;
					else if (ph < h)
						dir = 1;
					else if ((kc == null &&
							  (kc = comparableClassFor(k)) == null) ||
							 (dir = compareComparables(kc, k, pk)) == 0)
						dir = tieBreakOrder(k, pk);

					TreeNode<K,V> xp = p;
					if ((p = (dir <= 0) ? p.left : p.right) == null) {
						x.parent = xp;
						if (dir <= 0)
							xp.left = x;
						else
							xp.right = x;
						root = balanceInsertion(root, x);
						break;
					}
				}
			}
		}
		moveRootToFront(tab, root);
	}

	/**
	 * Returns a list of non-TreeNodes replacing those linked from
	 * this node.
	 */
	final Node<K,V> untreeify(HashMap<K,V> map) {
		Node<K,V> hd = null, tl = null;
		for (Node<K,V> q = this; q != null; q = q.next) {
			Node<K,V> p = map.replacementNode(q, null);
			if (tl == null)
				hd = p;
			else
				tl.next = p;
			tl = p;
		}
		return hd;
	}

	/**
	 * Tree version of putVal.
	 */
	final TreeNode<K,V> putTreeVal(HashMap<K,V> map, Node<K,V>[] tab,
								   int h, K k, V v) {
		Class<?> kc = null;
		boolean searched = false;
		TreeNode<K,V> root = (parent != null) ? root() : this;
		for (TreeNode<K,V> p = root;;) {
			int dir, ph; K pk;
			if ((ph = p.hash) > h)
				dir = -1;
			else if (ph < h)
				dir = 1;
			else if ((pk = p.key) == k || (k != null && k.equals(pk)))
				return p;
			else if ((kc == null &&
					  (kc = comparableClassFor(k)) == null) ||
					 (dir = compareComparables(kc, k, pk)) == 0) {
				if (!searched) {
					TreeNode<K,V> q, ch;
					searched = true;
					if (((ch = p.left) != null &&
						 (q = ch.find(h, k, kc)) != null) ||
						((ch = p.right) != null &&
						 (q = ch.find(h, k, kc)) != null))
						return q;
				}
				dir = tieBreakOrder(k, pk);
			}

			TreeNode<K,V> xp = p;
			if ((p = (dir <= 0) ? p.left : p.right) == null) {
				Node<K,V> xpn = xp.next;
				TreeNode<K,V> x = map.newTreeNode(h, k, v, xpn);
				if (dir <= 0)
					xp.left = x;
				else
					xp.right = x;
				xp.next = x;
				x.parent = x.prev = xp;
				if (xpn != null)
					((TreeNode<K,V>)xpn).prev = x;
				moveRootToFront(tab, balanceInsertion(root, x));
				return null;
			}
		}
	}

	/**
	 * Removes the given node, that must be present before this call.
	 * This is messier than typical red-black deletion code because we
	 * cannot swap the contents of an interior node with a leaf
	 * successor that is pinned by "next" pointers that are accessible
	 * independently during traversal. So instead we swap the tree
	 * linkages. If the current tree appears to have too few nodes,
	 * the bin is converted back to a plain bin. (The test triggers
	 * somewhere between 2 and 6 nodes, depending on tree structure).
	 */
	final void removeTreeNode(HashMap<K,V> map, Node<K,V>[] tab,
							  boolean movable) {
		int n;
		if (tab == null || (n = tab.length) == 0)
			return;
		int index = (n - 1) & hash;
		TreeNode<K,V> first = (TreeNode<K,V>)tab[index], root = first, rl;
		TreeNode<K,V> succ = (TreeNode<K,V>)next, pred = prev;
		if (pred == null)
			tab[index] = first = succ;
		else
			pred.next = succ;
		if (succ != null)
			succ.prev = pred;
		if (first == null)
			return;
		if (root.parent != null)
			root = root.root();
		if (root == null || root.right == null ||
			(rl = root.left) == null || rl.left == null) {
			tab[index] = first.untreeify(map);  // too small
			return;
		}
		TreeNode<K,V> p = this, pl = left, pr = right, replacement;
		if (pl != null && pr != null) {
			TreeNode<K,V> s = pr, sl;
			while ((sl = s.left) != null) // find successor
				s = sl;
			boolean c = s.red; s.red = p.red; p.red = c; // swap colors
			TreeNode<K,V> sr = s.right;
			TreeNode<K,V> pp = p.parent;
			if (s == pr) { // p was s's direct parent
				p.parent = s;
				s.right = p;
			}
			else {
				TreeNode<K,V> sp = s.parent;
				if ((p.parent = sp) != null) {
					if (s == sp.left)
						sp.left = p;
					else
						sp.right = p;
				}
				if ((s.right = pr) != null)
					pr.parent = s;
			}
			p.left = null;
			if ((p.right = sr) != null)
				sr.parent = p;
			if ((s.left = pl) != null)
				pl.parent = s;
			if ((s.parent = pp) == null)
				root = s;
			else if (p == pp.left)
				pp.left = s;
			else
				pp.right = s;
			if (sr != null)
				replacement = sr;
			else
				replacement = p;
		}
		else if (pl != null)
			replacement = pl;
		else if (pr != null)
			replacement = pr;
		else
			replacement = p;
		if (replacement != p) {
			TreeNode<K,V> pp = replacement.parent = p.parent;
			if (pp == null)
				root = replacement;
			else if (p == pp.left)
				pp.left = replacement;
			else
				pp.right = replacement;
			p.left = p.right = p.parent = null;
		}

		TreeNode<K,V> r = p.red ? root : balanceDeletion(root, replacement);

		if (replacement == p) {  // detach
			TreeNode<K,V> pp = p.parent;
			p.parent = null;
			if (pp != null) {
				if (p == pp.left)
					pp.left = null;
				else if (p == pp.right)
					pp.right = null;
			}
		}
		if (movable)
			moveRootToFront(tab, r);
	}

	/**
	 * Splits nodes in a tree bin into lower and upper tree bins,
	 * or untreeifies if now too small. Called only from resize;
	 * see above discussion about split bits and indices.
	 *
	 * @param map the map
	 * @param tab the table for recording bin heads
	 * @param index the index of the table being split
	 * @param bit the bit of hash to split on
	 */
	final void split(HashMap<K,V> map, Node<K,V>[] tab, int index, int bit) {
		TreeNode<K,V> b = this;
		// Relink into lo and hi lists, preserving order
		TreeNode<K,V> loHead = null, loTail = null;
		TreeNode<K,V> hiHead = null, hiTail = null;
		int lc = 0, hc = 0;
		for (TreeNode<K,V> e = b, next; e != null; e = next) {
			next = (TreeNode<K,V>)e.next;
			e.next = null;
			if ((e.hash & bit) == 0) {
				if ((e.prev = loTail) == null)
					loHead = e;
				else
					loTail.next = e;
				loTail = e;
				++lc;
			}
			else {
				if ((e.prev = hiTail) == null)
					hiHead = e;
				else
					hiTail.next = e;
				hiTail = e;
				++hc;
			}
		}

		if (loHead != null) {
			if (lc <= UNTREEIFY_THRESHOLD)
				tab[index] = loHead.untreeify(map);
			else {
				tab[index] = loHead;
				if (hiHead != null) // (else is already treeified)
					loHead.treeify(tab);
			}
		}
		if (hiHead != null) {
			if (hc <= UNTREEIFY_THRESHOLD)
				tab[index + bit] = hiHead.untreeify(map);
			else {
				tab[index + bit] = hiHead;
				if (loHead != null)
					hiHead.treeify(tab);
			}
		}
	}

	/* ------------------------------------------------------------ */
	// Red-black tree methods, all adapted from CLR

	static <K,V> TreeNode<K,V> rotateLeft(TreeNode<K,V> root,
										  TreeNode<K,V> p) {
		TreeNode<K,V> r, pp, rl;
		if (p != null && (r = p.right) != null) {
			if ((rl = p.right = r.left) != null)
				rl.parent = p;
			if ((pp = r.parent = p.parent) == null)
				(root = r).red = false;
			else if (pp.left == p)
				pp.left = r;
			else
				pp.right = r;
			r.left = p;
			p.parent = r;
		}
		return root;
	}

	static <K,V> TreeNode<K,V> rotateRight(TreeNode<K,V> root,
										   TreeNode<K,V> p) {
		TreeNode<K,V> l, pp, lr;
		if (p != null && (l = p.left) != null) {
			if ((lr = p.left = l.right) != null)
				lr.parent = p;
			if ((pp = l.parent = p.parent) == null)
				(root = l).red = false;
			else if (pp.right == p)
				pp.right = l;
			else
				pp.left = l;
			l.right = p;
			p.parent = l;
		}
		return root;
	}

	static <K,V> TreeNode<K,V> balanceInsertion(TreeNode<K,V> root,
												TreeNode<K,V> x) {
		x.red = true;
		for (TreeNode<K,V> xp, xpp, xppl, xppr;;) {
			if ((xp = x.parent) == null) {
				x.red = false;
				return x;
			}
			else if (!xp.red || (xpp = xp.parent) == null)
				return root;
			if (xp == (xppl = xpp.left)) {
				if ((xppr = xpp.right) != null && xppr.red) {
					xppr.red = false;
					xp.red = false;
					xpp.red = true;
					x = xpp;
				}
				else {
					if (x == xp.right) {
						root = rotateLeft(root, x = xp);
						xpp = (xp = x.parent) == null ? null : xp.parent;
					}
					if (xp != null) {
						xp.red = false;
						if (xpp != null) {
							xpp.red = true;
							root = rotateRight(root, xpp);
						}
					}
				}
			}
			else {
				if (xppl != null && xppl.red) {
					xppl.red = false;
					xp.red = false;
					xpp.red = true;
					x = xpp;
				}
				else {
					if (x == xp.left) {
						root = rotateRight(root, x = xp);
						xpp = (xp = x.parent) == null ? null : xp.parent;
					}
					if (xp != null) {
						xp.red = false;
						if (xpp != null) {
							xpp.red = true;
							root = rotateLeft(root, xpp);
						}
					}
				}
			}
		}
	}

	static <K,V> TreeNode<K,V> balanceDeletion(TreeNode<K,V> root,
											   TreeNode<K,V> x) {
		for (TreeNode<K,V> xp, xpl, xpr;;)  {
			if (x == null || x == root)
				return root;
			else if ((xp = x.parent) == null) {
				x.red = false;
				return x;
			}
			else if (x.red) {
				x.red = false;
				return root;
			}
			else if ((xpl = xp.left) == x) {
				if ((xpr = xp.right) != null && xpr.red) {
					xpr.red = false;
					xp.red = true;
					root = rotateLeft(root, xp);
					xpr = (xp = x.parent) == null ? null : xp.right;
				}
				if (xpr == null)
					x = xp;
				else {
					TreeNode<K,V> sl = xpr.left, sr = xpr.right;
					if ((sr == null || !sr.red) &&
						(sl == null || !sl.red)) {
						xpr.red = true;
						x = xp;
					}
					else {
						if (sr == null || !sr.red) {
							if (sl != null)
								sl.red = false;
							xpr.red = true;
							root = rotateRight(root, xpr);
							xpr = (xp = x.parent) == null ?
								null : xp.right;
						}
						if (xpr != null) {
							xpr.red = (xp == null) ? false : xp.red;
							if ((sr = xpr.right) != null)
								sr.red = false;
						}
						if (xp != null) {
							xp.red = false;
							root = rotateLeft(root, xp);
						}
						x = root;
					}
				}
			}
			else { // symmetric
				if (xpl != null && xpl.red) {
					xpl.red = false;
					xp.red = true;
					root = rotateRight(root, xp);
					xpl = (xp = x.parent) == null ? null : xp.left;
				}
				if (xpl == null)
					x = xp;
				else {
					TreeNode<K,V> sl = xpl.left, sr = xpl.right;
					if ((sl == null || !sl.red) &&
						(sr == null || !sr.red)) {
						xpl.red = true;
						x = xp;
					}
					else {
						if (sl == null || !sl.red) {
							if (sr != null)
								sr.red = false;
							xpl.red = true;
							root = rotateLeft(root, xpl);
							xpl = (xp = x.parent) == null ?
								null : xp.left;
						}
						if (xpl != null) {
							xpl.red = (xp == null) ? false : xp.red;
							if ((sl = xpl.left) != null)
								sl.red = false;
						}
						if (xp != null) {
							xp.red = false;
							root = rotateRight(root, xp);
						}
						x = root;
					}
				}
			}
		}
	}

	/**
	 * Recursive invariant check
	 */
	static <K,V> boolean checkInvariants(TreeNode<K,V> t) {
		TreeNode<K,V> tp = t.parent, tl = t.left, tr = t.right,
			tb = t.prev, tn = (TreeNode<K,V>)t.next;
		if (tb != null && tb.next != t)
			return false;
		if (tn != null && tn.prev != t)
			return false;
		if (tp != null && t != tp.left && t != tp.right)
			return false;
		if (tl != null && (tl.parent != t || tl.hash > t.hash))
			return false;
		if (tr != null && (tr.parent != t || tr.hash < t.hash))
			return false;
		if (t.red && tl != null && tl.red && tr != null && tr.red)
			return false;
		if (tl != null && !checkInvariants(tl))
			return false;
		if (tr != null && !checkInvariants(tr))
			return false;
		return true;
	}
}

 

可以看到TreeNode 其实就是红黑树的一个实现:

 

 

 

需要注意的点:

     在HashMap内部定义的几个变量,包括桶数组本身都是transient修饰的,这代表了他们无法被序列化,而HashMap本身是实现了Serializable接口的。这很容易产生疑惑:

HashMap是如何序列化的呢?

      查了一下源码发现,HashMap内有两个用于序列化的函数 readObject(ObjectInputStream s) 和 writeObject(ObjectOutputStreams),通过这个函数将table序列化。

 

 

HashMap 的 put 方法解析


  以上就是我们对HashMap的初步认识,下面进入正题,看看HashMap是如何添加、查找与删除数据的。

  首先来看put方法,我尽量在每行都加注释阐明这一行的含义,让阅读起来更容易理解。

 

public V put(K key, V value) {
	return putVal(hash(key), key, value, false, true); 
}

final V putVal(int hash, K key, V value, boolean onlyIfAbsent,          //这里onlyIfAbsent表示只有在该key对应原来的value为null的时候才插入,也就是说如果value之前存在了,就不会被新put的元素覆盖。
			   boolean evict) {                                              //evict参数用于LinkedHashMap中的尾部操作,这里没有实际意义。
	Node<K,V>[] tab; Node<K,V> p; int n, i;                    //定义变量tab是将要操作的Node数组引用,p表示tab上的某Node节点,n为tab的长度,i为tab的下标。
	if ((tab = table) == null || (n = tab.length) == 0)                    //判断当table为null或者tab的长度为0时,即table尚未初始化,此时通过resize()方法得到初始化的table。                        
		n = (tab = resize()).length;                        //这种情况是可能发生的,HashMap的注释中提到:The table, initialized on first use, and resized as necessary。
	if ((p = tab[i = (n - 1) & hash]) == null)                               //此处通过(n - 1) & hash 计算出的值作为tab的下标i,并另p表示tab[i],也就是该链表第一个节点的位置。并判断p是否为null。
		tab[i] = newNode(hash, key, value, null);                 //当p为null时,表明tab[i]上没有任何元素,那么接下来就new第一个Node节点,调用newNode方法返回新节点赋值给tab[i]。
	else {                                              //下面进入p不为null的情况,有三种情况:p为链表节点;p为红黑树节点;p是链表节点但长度为临界长度TREEIFY_THRESHOLD,再插入任何元素就要变成红黑树了。
		Node<K,V> e; K k;                               //定义e引用即将插入的Node节点,并且下文可以看出 k = p.key。
		if (p.hash == hash &&                             //HashMap中判断key相同的条件是key的hash相同,并且符合equals方法。这里判断了p.key是否和插入的key相等,如果相等,则将p的引用赋给e。
			((k = p.key) == key || (key != null && key.equals(k))))           //这一步的判断其实是属于一种特殊情况,即HashMap中已经存在了key,于是插入操作就不需要了,只要把原来的value覆盖就可以了。
			e = p;                                    //这里为什么要把p赋值给e,而不是直接覆盖原值呢?答案很简单,现在我们只判断了第一个节点,后面还可能出现key相同,所以需要在最后一并处理。
		else if (p instanceof TreeNode)                                       //现在开始了第一种情况,p是红黑树节点,那么肯定插入后仍然是红黑树节点,所以我们直接强制转型p后调用TreeNode.putTreeVal方法,返回的引用赋给e。
			e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);   //你可能好奇,这里怎么不遍历tree看看有没有key相同的节点呢?其实,putTreeVal内部进行了遍历,存在相同hash时返回被覆盖的TreeNode,否则返回null。
		else {                                                  //接下里就是p为链表节点的情形,也就是上述说的另外两类情况:插入后还是链表/插入后转红黑树。另外,上行转型代码也说明了TreeNode是Node的一个子类。
			for (int binCount = 0; ; ++binCount) {                 //我们需要一个计数器来计算当前链表的元素个数,并遍历链表,binCount就是这个计数器。
				if ((e = p.next) == null) {                     //遍历过程中当发现p.next为null时,说明链表到头了,直接在p的后面插入新的链表节点,即把新节点的引用赋给p.next,插入操作就完成了。注意此时e赋给p。
					p.next = newNode(hash, key, value, null);          //最后一个参数为新节点的next,这里传入null,保证了新节点继续为该链表的末端。
					if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st     //插入成功后,要判断是否需要转换为红黑树,因为插入后链表长度加1,而binCount并不包含新节点,所以判断时要将临界阈值减1。
						treeifyBin(tab, hash);                     //当新长度满足转换条件时,调用treeifyBin方法,将该链表转换为红黑树。
					break;                                //当然如果不满足转换条件,那么插入数据后结构也无需变动,所有插入操作也到此结束了,break退出即可。
				}
				if (e.hash == hash &&                         //在遍历链表的过程中,我之前提到了,有可能遍历到与插入的key相同的节点,此时只要将这个节点引用赋值给e,最后通过e去把新的value覆盖掉就可以了。
					((k = e.key) == key || (key != null && key.equals(k))))   //老样子判断当前遍历的节点的key是否相同。
					break;                                //找到了相同key的节点,那么插入操作也不需要了,直接break退出循环进行最后的value覆盖操作。
				p = e;                                  //在第21行我提到过,e是当前遍历的节点p的下一个节点,p = e 就是依次遍历链表的核心语句。每次循环时p都是下一个node节点。
			}
		}
		if (e != null) { // existing mapping for key                //左边注释为jdk自带注释,说的很明白了,针对已经存在key的情况做处理。
			V oldValue = e.value;                           //定义oldValue,即原存在的节点e的value值。
			if (!onlyIfAbsent || oldValue == null)                 //前面提到,onlyIfAbsent表示存在key相同时不做覆盖处理,这里作为判断条件,可以看出当onlyIfAbsent为false或者oldValue为null时,进行覆盖操作。
				e.value = value;                              //覆盖操作,将原节点e上的value设置为插入的新value。
			afterNodeAccess(e);                            //这个函数在hashmap中没有任何操作,是个空函数,他存在主要是为了linkedHashMap的一些后续处理工作。
			return oldValue;                              //这里很有意思,他返回的是被覆盖的oldValue。我们在使用put方法时很少用他的返回值,甚至忘了它的存在,这里我们知道,他返回的是被覆盖的oldValue。
		}
	}                                            
	++modCount;                                      //收尾工作,值得一提的是,对key相同而覆盖oldValue的情况,在前面已经return,不会执行这里,所以那一类情况不算数据结构变化,并不改变modCount值。
	if (++size > threshold)                               //同理,覆盖oldValue时显然没有新元素添加,除此之外都新增了一个元素,这里++size并与threshold判断是否达到了扩容标准。
		resize();                                     //当HashMap中存在的node节点大于threshold时,hashmap进行扩容。
	afterNodeInsertion(evict);                             //这里与前面的afterNodeAccess同理,是用于linkedHashMap的尾部操作,HashMap中并无实际意义。1
	return null;                                        //最终,对于真正进行插入元素的情况,put函数一律返回null。
}

 

   在上述代码中的第十行,HashMap根据 (n - 1) & hash 求出了元素在node数组的下标。这个操作非常精妙,下面我们仔细分析一下计算下标的过程,主要分三个阶段:计算hashcode、高位运算和取模运算。

  首先,传进来的hash值是由put方法中的hash(key)产生的(上述第2行),我们来看一下hash()方法的源码:

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

  这里通过key.hashCode()计算出key的哈希值,然后将哈希值h右移16位,再与原来的h做异或^运算——这一步是高位运算。设想一下,如果没有高位运算,那么hash值将是一个int型的32位数。而从2的-31次幂到2的31次幂之间,有将近几十亿的空间,如果我们的HashMap的table有这么长,内存早就爆了。所以这个散列值不能直接用来最终的取模运算,而需要先加入高位运算,将高16位和低16位的信息"融合"到一起,也称为"扰动函数"。这样才能保证hash值所有位的数值特征都保存下来而没有遗漏,从而使映射结果尽可能的松散。最后,根据 n-1 做与操作的取模运算。这里也能看出为什么HashMap要限制table的长度为2的n次幂,因为这样,n-1可以保证二进制展示形式是(以16为例)0000 0000 0000 0000 0000 0000 0000 1111。在做"与"操作时,就等同于截取hash二进制值得后四位数据作为下标。这里也可以看出"扰动函数"的重要性了,如果高位不参与运算,那么高16位的hash特征几乎永远得不到展现,发生hash碰撞的几率就会增大,从而影响性能。

  HashMap的put方法的源码实现就是这样了,整理思路非常连贯。这里面有几个函数的源码(比如resize、putTreeValue、newNode、treeifyBin)限于篇幅原因,就不贴了,后面应该还会更新在其他博客里,有兴趣的同学也可以自己挖掘一下。

 

 

HashMap 的 get 方法解析


   读完了put的源码,其实已经可以很清晰的理清HashMap的工作原理了。接下来再看get方法的源码,就非常的简单:

public V get(Object key) {
	Node<K,V> e;
	return (e = getNode(hash(key), key)) == null ? null : e.value;      //根据key及其hash值查询node节点,如果存在,则返回该节点的value值。
}

final Node<K,V> getNode(int hash, Object key) {                  //根据key搜索节点的方法。记住判断key相等的条件:hash值相同 并且 符合equals方法。
	Node<K,V>[] tab; Node<K,V> first, e; int n; K k;
	if ((tab = table) != null && (n = tab.length) > 0 &&            //根据输入的hash值,可以直接计算出对应的下标(n - 1)& hash,缩小查询范围,如果存在结果,则必定在table的这个位置上。
		(first = tab[(n - 1) & hash]) != null) {
		if (first.hash == hash && // always check first node
			((k = first.key) == key || (key != null && key.equals(k))))    //判断第一个存在的节点的key是否和查询的key相等。如果相等,直接返回该节点。
			return first;
		if ((e = first.next) != null) {                       //遍历该链表/红黑树直到next为null。
			if (first instanceof TreeNode)                       //当这个table节点上存储的是红黑树结构时,在根节点first上调用getTreeNode方法,在内部遍历红黑树节点,查看是否有匹配的TreeNode。
				return ((TreeNode<K,V>)first).getTreeNode(hash, key);
			do {
				if (e.hash == hash &&                        //当这个table节点上存储的是链表结构时,用跟第11行同样的方式去判断key是否相同。
					((k = e.key) == key || (key != null && key.equals(k))))
					return e;
			} while ((e = e.next) != null);                      //如果key不同,一直遍历下去直到链表尽头,e.next == null。
		}
	}
	return null;
}

        因为查询过程不涉及到HashMap的结构变动,所以get方法的源码显得很简洁。核心逻辑就是遍历table某特定位置上的所有节点,分别与key进行比较看是否相等。

 

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

 

  以上便是HashMap最常用API的源码分析,除此之外,HashMap还有一些知识需要重点学习:扩容机制、并发安全问题、内部红黑树的实现。这些内容我也会在之后陆续发文分析,希望可以帮读者彻底理解HashMap的原理。

  • 1
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值