TreeMap源码解析（基于JDK1.8）
TreeMap源码解析（基于JDK1.8）
目录
一、继承关系
二、基本属性
三、构造方法
四、Entry介绍(红黑树)
1、基本属性与构造方法源码
2、常用方法
put
fixAfterInsertion
rotateLeft和rotateRight
get
getEntry
getEntryUsingComparator
remove
deleteEntry
fixAfterDeletion方法
deleteEntry删除的流程
clear
一、继承关系
非线程安全的不可重复元素的可排序键值对，继承关系的UML图如下：
1.TreeMap存储K-V键值对，通过红黑树（R-B tree）实现；
2.TreeMap实现igableMap接口，NavigableMap接口继承了SortedMap接口，可支持一系列的导航定位以及导航操作的方法，当然只是提供了接口，需要TreeMap自己去实现；
3.TreeMap实现了Cloneable接口，可被克隆，实现了Serializable接口，可序列化；
4.TreeMap因为是通过红黑树实现，红黑树结构天然支持排序，默认情况下通过Key值的自然顺序进行排序；
二、基本属性
//使用比较器进行排序
private final Comparator comparator;
//红黑树结构的根节点
private transient Entry root;
/**
* The number of entries in the tree
* Map中key-val对的数量，也即是红黑树中节点Entry的数量
*/
private transient int size = 0;
/**
* The number of structural modifications to the tree.
* 变化的次数
*/
private transient int modCount = 0;
三、构造方法
1.构造一个新的空树映射,使用的自然排序键
public TreeMap() {
comparator = null;
}
2.构造一个新的、空的树图,根据给定的命令比较器排序。
public TreeMap(Comparator comparator) {
this.comparator = comparator;
}
3. 构造一个新的树形映射，其中包含与给定映射相同的映射映射，根据其键的自然排序排序。
public TreeMap(Map m) {
comparator = null;
putAll(m);
}
4.一个新的树包含相同的映射和map使用与指定的排序映射相同的顺序
public TreeMap(SortedMap m) {
comparator = m.comparator();
try {
buildFromSorted(m.size(), m.entrySet().iterator(), null, null);
} catch (java.io.IOException cannotHappen) {
} catch (ClassNotFoundException cannotHappen) {
}
}
四、Entry介绍(红黑树)
1、基本属性与构造方法源码
// Red-black mechanics
private static final boolean RED = false;
private static final boolean BLACK = true;
/**
* Node in the Tree. Doubles as a means to pass key-value pairs back to
* user (see Map.Entry).
*/
//树的节点
static final class Entry implements Map.Entry {
K key;
V value;
//左节点
Entry left;
//右节点
Entry right;
//父节点
Entry parent;
//当前节点属性，默认为黑色
boolean color = BLACK;
/**
* Make a new cell with given key, value, and parent, and with
* {@code null} child links, and BLACK color.
*/
//构造方法
Entry(K key, V value, Entry parent) {
this.key = key;
this.value = value;
this.parent = parent;
}
/**
* Returns the key.
*
* @return the key
*/
public K getKey() {
return key;
}
/**
* Returns the value associated with the key.
*
* @return the value associated with the key
*/
public V getValue() {
return value;
}
/**
* Replaces the value currently associated with the key with the given
* value.
*
* @return the value associated with the key before this method was
* called
*/
//替换旧值
public V setValue(V value) {
V oldValue = this.value;
this.value = value;
return oldValue;
}
public boolean equals(Object o) {
if (!(o instanceof Map.Entry))
return false;
Map.Entry e = (Map.Entry)o;
return valEquals(key,e.getKey()) && valEquals(value,e.getValue());
}
public int hashCode() {
int keyHash = (key==null ? 0 : key.hashCode());
int valueHash = (value==null ? 0 : value.hashCode());
return keyHash ^ valueHash;
}
public String toString() {
return key + "=" + value;
}
}
2、常用方法
put
将此映射中的指定值与指定键关联。如果以前的映射包含键的映射，则旧的值被替换。
public V put(K key, V value) {
//定义根节点
Entry t = root;
//如果还没有根节点，就进行红黑树根节点的初始化
if (t == null) {
compare(key, key); // type (and possibly null) check
root = new Entry<>(key, value, null);
size = 1;
modCount++;
return null;
}
//定义cmp变量，在二分查找时作比较使用，放置值的时候使用
int cmp;
Entry parent;
// split comparator and comparable paths
//定义比较器，根据有无分两种情况遍历
Comparator cpr = comparator;
//如果存在传入的比较器（自定义的排序算法）按照该规则进行比较
if (cpr != null) {
//从根节点开始二分向下遍历，找到确定的位置放置
do {
parent = t;
//比较传入key和根节点的key大小
cmp = cpr.compare(key, t.key);
//如果传入的值小，则在左子树中找
if (cmp < 0)
t = t.left;
//如果传入的值大， 则在右子树中找
else if (cmp > 0)
t = t.right;
else
//如果相等，则新值覆盖老值
return t.setValue(value);
} while (t != null);
//注意：这里并没有对key是否为null进行判断，建议自己的实现Comparator时应该要考虑在内
}
else {
//没有自定义的排序规则，进行默认的排序。且key不能为null
if (key == null)
throw new NullPointerException();
@SuppressWarnings("unchecked")
Comparable k = (Comparable) key;
//相同的查找方式
do {
parent = t;
cmp = k.compareTo(t.key);
if (cmp < 0)
t = t.left;
else if (cmp > 0)
t = t.right;
else
return t.setValue(value);
} while (t != null);
}
//执行到这里说明都没有相等的key，是一个新节点
Entry e = new Entry<>(key, value, parent);
//new一个Entry放到parent下面即可，但放到左子节点上还是右子节点上，就需要按照红黑树的规则来。
if (cmp < 0)
parent.left = e;
else
parent.right = e;
//为保证红黑树的属性，需要进行旋转和变色的操作
fixAfterInsertion(e);
size++;
modCount++;
return null;
}
fixAfterInsertion
自平衡原则：
/** From CLR */
private void fixAfterInsertion(Entry x) {
//新插入的节点默认为红色节点
x.color = RED;
//当节点不是根节点且节点的父节点的颜色为红色时，需要调整
while (x != null && x != root && x.parent.color == RED) {
//如果父节点是左节点，对应上表中情况1和情况2
if (parentOf(x) == leftOf(parentOf(parentOf(x)))) {
Entry y = rightOf(parentOf(parentOf(x)));
//如果叔父节点为红色，对应于“父节点和叔父节点都为红色”，此时通过变色即可实现平衡
//此时父节点和叔父节点都设置为黑色，祖父节点设置为红色
if (colorOf(y) == RED) {
setColor(parentOf(x), BLACK);
setColor(y, BLACK);
setColor(parentOf(parentOf(x)), RED);
x = parentOf(parentOf(x));
} else {
//如果插入节点是黑色，插入的是右子节点，通过【左右节点旋转】（这里先进行父节点左旋）
if (x == rightOf(parentOf(x))) {
x = parentOf(x);
rotateLeft(x);
}
//设置父节点和祖父节点颜色
setColor(parentOf(x), BLACK);
setColor(parentOf(parentOf(x)), RED);
//进行祖父节点右旋（这里【变色】和【旋转】并没有严格的先后顺序，达成目的就行）
rotateRight(parentOf(parentOf(x)));
}
} else {
//父节点是右节点的情况
Entry y = leftOf(parentOf(parentOf(x)));
//对应于“父节点和叔父节点都为红色”，此时通过变色即可实现平衡
if (colorOf(y) == RED) {
setColor(parentOf(x), BLACK);
setColor(y, BLACK);
setColor(parentOf(parentOf(x)), RED);
x = parentOf(parentOf(x));
} else {
//如果插入节点是黑色，插入的是左子节点，通过【右左节点旋转】（这里先进行父节点右旋）
if (x == leftOf(parentOf(x))) {
x = parentOf(x);
rotateRight(x);
}
setColor(parentOf(x), BLACK);
setColor(parentOf(parentOf(x)), RED);
//进行祖父节点左旋（这里【变色】和【旋转】并没有严格的先后顺序，达成目的就行）
rotateLeft(parentOf(parentOf(x)));
}
}
}
//根节点必须为黑色
root.color = BLACK;
}
rotateLeft和rotateRight
【左旋】规则如下：“逆时针旋转两个节点，让一个节点被其右子节点取代，而该节点成为右子节点的左子节点”。
/** From CLR */
private void rotateLeft(Entry p) {
if (p != null) {
/**
* 断开当前节点p与其右子节点的关联，重新将节点p的右子节点的地址指向节点p的右子节点的左子节点
* 这个时候节点r没有父节点
*/
Entry r = p.right;
p.right = r.left;
//将节点p作为节点r的父节点
if (r.left != null)
r.left.parent = p;
//将节点p的父节点和r的父节点指向同一处
r.parent = p.parent;
//p的父节点为null，则将节点r设置为root
if (p.parent == null)
root = r;
//如果节点p是左子节点，则将该左子节点替换为节点r
else if (p.parent.left == p)
p.parent.left = r;
//如果节点p为右子节点，则将该右子节点替换为节点r
else
p.parent.right = r;
//重新建立p与r的关系
r.left = p;
p.parent = r;
}
}
【右旋】规则如下：“顺时针旋转两个节点，让一个节点被其左子节点取代，而该节点成为左子节点的右子节点”。
/** From CLR */
private void rotateRight(Entry p) {
if (p != null) {
Entry l = p.left;
p.left = l.right;
if (l.right != null) l.right.parent = p;
l.parent = p.parent;
if (p.parent == null)
root = l;
else if (p.parent.right == p)
p.parent.right = l;
else p.parent.left = l;
l.right = p;
p.parent = l;
}
}
get
内部调用getEntry方法
public V get(Object key) {
Entry p = getEntry(key);
return (p==null ? null : p.value);
}
getEntry
final Entry getEntry(Object key) {
// Offload comparator-based version for sake of performance
//如果比较器不为空，调用比较器的获取方法的值
if (comparator != null)
return getEntryUsingComparator(key);
if (key == null)
throw new NullPointerException();
@SuppressWarnings("unchecked")
Comparable k = (Comparable) key;
//从根节点向下开始遍历
Entry p = root;
while (p != null) {
int cmp = k.compareTo(p.key);
//如果小于根节点的值，则在左子树
if (cmp < 0)
p = p.left;
else if (cmp > 0)
//如果大于根节点的值，则在右子树
p = p.right;
else
//相等，返回该节点
return p;
}
return null;
}
getEntryUsingComparator
从比较器中获取值
使用比较器的getEntry版本。从getEntry中分离出来性能。
final Entry getEntryUsingComparator(Object key) {
@SuppressWarnings("unchecked")
K k = (K) key;
//赋值比较器
Comparator cpr = comparator;
if (cpr != null) {
Entry p = root;
while (p != null) {
int cmp = cpr.compare(k, p.key);
if (cmp < 0)
p = p.left;
else if (cmp > 0)
p = p.right;
else
return p;
}
}
return null;
}
remove
删除原理是
1通过getEntry确定节点是否存在，
2.不存在，返回null
2.再调用deleteEntry方法进行删除，返回被删除的值
public V remove(Object key) {
Entry p = getEntry(key);
if (p == null)
return null;
V oldValue = p.value;
deleteEntry(p);
return oldValue;
}
deleteEntry
/**
* Delete node p, and then rebalance the tree.
*/
private void deleteEntry(Entry p) {
modCount++;
size--;
// If strictly internal, copy successor's element to p and then make p
// point to successor.
//当左右子节点都不为null时，通过successor(p)遍历红黑树找到前驱或者后继
if (p.left != null && p.right != null) {
Entry s = successor(p);
//将前驱或者后继的key和value复制到当前节点p中，然后删除节点s(通过将节点p引用指向s)
p.key = s.key;
p.value = s.value;
p = s;
} // p has 2 children
// Start fixup at replacement node, if it exists.
Entry replacement = (p.left != null ? p.left : p.right);
/**
* 至少有一个子节点不为null，直接用这个有值的节点替换掉当前节点，给replacement的parent属性赋值,给
* parent节点的left属性和right属性赋值，同时要记住叶子节点必须为null,然后用fixAfterDeletion方法
* 进行自平衡处理
*/
if (replacement != null) {
// Link replacement to parent
//将待删除节点的子节点挂到待删除节点的父节点上。
replacement.parent = p.parent;
if (p.parent == null)
root = replacement;
else if (p == p.parent.left)
p.parent.left = replacement;
else
p.parent.right = replacement;
// Null out links so they are OK to use by fixAfterDeletion.
p.left = p.right = p.parent = null;
// Fix replacement
//如果p为黑色节点的话，那么其父节点以及子节点都可能是红色的，那么很明显可能会存在红色相连的情况，因此需要进行自平衡的调整
//为红色不影响
if (p.color == BLACK)
//自平衡
fixAfterDeletion(replacement);
} else if (p.parent == null) { // return if we are the only node.
//如果只有一个节点，则返回null
root = null;
} else { // No children. Use self as phantom replacement and unlink.
//如果p节点为黑色，那么p节点删除后，就可能违背每个节点到其叶子节点路径上黑色节点数量一致的规则，因此需要进行自平衡的调整
if (p.color == BLACK)
fixAfterDeletion(p);
//将父节点的左右节点设置为null
if (p.parent != null) {
if (p == p.parent.left)
p.parent.left = null;
else if (p == p.parent.right)
p.parent.right = null;
p.parent = null;
}
}
}
fixAfterDeletion方法
private void fixAfterDeletion(Entry x) {
/**
* 当x不是root节点且颜色为黑色时
*/
while (x != root && colorOf(x) == BLACK) {
/**
* 首先分为两种情况，当前节点x是左节点或者当前节点x是右节点，这两种情况下面都是四种场景,这里通过
* 代码分析一下x为左节点的情况，右节点可参考左节点理解，因为它们非常类似
*/
if (x == leftOf(parentOf(x))) {
Entry sib = rightOf(parentOf(x));
/**
* 场景1：当x是左黑色节点，兄弟节点sib是红色节点
* 兄弟节点由红转黑，父节点由黑转红，按父节点左旋，
* 左旋后树的结构变化了，这时重新赋值sib，这个时候sib指向了x的兄弟节点
*/
if (colorOf(sib) == RED) {
setColor(sib, BLACK);
setColor(parentOf(x), RED);
rotateLeft(parentOf(x));
sib = rightOf(parentOf(x));
}
/**
* 场景2：节点x、x的兄弟节点sib、sib的左子节点和右子节点都为黑色时，需要将该节点sib由黑变
* 红，同时将x指向当前x的父节点
*/
if (colorOf(leftOf(sib)) == BLACK &&
colorOf(rightOf(sib)) == BLACK) {
setColor(sib, RED);
x = parentOf(x);
} else {
/**
* 场景3：节点x、x的兄弟节点sib、sib的右子节点都为黑色，sib的左子节点为红色时，
* 需要将sib左子节点设置为黑色，sib节点设置为红色，同时按sib右旋，再将sib指向x的
* 兄弟节点
*/
if (colorOf(rightOf(sib)) == BLACK) {
setColor(leftOf(sib), BLACK);
setColor(sib, RED);
rotateRight(sib);
sib = rightOf(parentOf(x));
}
/**
* 场景4：节点x、x的兄弟节点sib都为黑色，而sib的左右子节点都为红色或者右子节点为红色、
* 左子节点为黑色，此时需要将sib节点的颜色设置成和x的父节点p相同的颜色，
* 设置x的父节点为黑色，设置sib右子节点为黑色，左旋x的父节点p，然后将x赋值为root
*/
setColor(sib, colorOf(parentOf(x)));
setColor(parentOf(x), BLACK);
setColor(rightOf(sib), BLACK);
rotateLeft(parentOf(x));
x = root;
}
} else {//x是右节点的情况
Entry sib = leftOf(parentOf(x));
if (colorOf(sib) == RED) {
setColor(sib, BLACK);
setColor(parentOf(x), RED);
rotateRight(parentOf(x));
sib = leftOf(parentOf(x));
}
if (colorOf(rightOf(sib)) == BLACK &&
colorOf(leftOf(sib)) == BLACK) {
setColor(sib, RED);
x = parentOf(x);
} else {
if (colorOf(leftOf(sib)) == BLACK) {
setColor(rightOf(sib), BLACK);
setColor(sib, RED);
rotateLeft(sib);
sib = leftOf(parentOf(x));
}
setColor(sib, colorOf(parentOf(x)));
setColor(parentOf(x), BLACK);
setColor(leftOf(sib), BLACK);
rotateRight(parentOf(x));
x = root;
}
}
}
setColor(x, BLACK);
}
deleteEntry删除的流程
1.如果删除的是根节点，则直接将根节点置为null;
2.待删除节点的左右子节点都为null，删除时将该节点置为null;
3.待删除节点的左右子节点有一个有值，则用有值的节点替换该节点即可；
4.待删除节点的左右子节点都不为null，则找前驱或者后继，将前驱或者后继的值复制到该节点中，
然后删除前驱或者后继（前驱：左子树中值最大的节点，后继：右子树中值最小的节点）；
clear
直接删除所有的映射值，清空size
/**
* Removes all of the mappings from this map.
* The map will be empty after this call returns.
*/
public void clear() {
modCount++;
size = 0;
root = null;
}