Java8集合系列之TreeMap(十)

之前在看java集合类的时候没注意map中还有一个TreeMap这个类,本文主要是对属于java集合类的TreeMap成员,进行源码分析和理解。

继承结构

public class TreeMap<K,V>
extends AbstractMap<K,V>
implements NavigableMap<K,V>, Cloneable, java.io.Serializable

这些继承的父类或者实现的接口保证了TreeMap所具有的一系列特性,比如有序性,可以克隆,可以序列化等等。

重要属性

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
/**
* The comparator used to maintain order in this tree map, or
* null if it uses the natural ordering of its keys.
*/
private final Comparator<? super K> comparator;
//可以认为是TreeMap中tree的根节点
private transient Entry<K,V> root;
/**
* The number of entries in the tree
*/
private transient int size = 0;
/**
* The number of structural modifications to the tree.
*/
private transient int modCount = 0;

构造方法

下面是两个比较基本的构造方法,还有一些其他不列举了。

1
2
3
4
5
6
public TreeMap() {
comparator = null;//可以猜测,应该是在第一次添加值得时候才创建比较器
}
public TreeMap(Comparator<? super K> comparator) {
this.comparator = comparator;//也可以自己设置比较器
}

put

map的类基本最常用的就是put和get方法,就从put方法开始:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
public V put(K key, V value) {
Entry<K,V> t = root;
if (t == null) {
compare(key, key); // type (and possibly null) check
//则创建第一个结点作为根节点
root = new Entry<>(key, value, null);
size = 1;
modCount++;
return null;
}
int cmp;
Entry<K,V> parent;
// split comparator and comparable paths
Comparator<? super K> cpr = comparator;
if (cpr != null) {
//沿着根节点开始比较
do {
parent = t;
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);
}
else {
...//cpr比较器为null
}
//如果没找到相同的key的节点,t=null,parent不为null,就将e作为parent的子节点。
Entry<K,V> e = new Entry<>(key, value, parent);
if (cmp < 0)
parent.left = e;
else
parent.right = e;
fixAfterInsertion(e);
size++;
modCount++;
return null;
}

put方法的结尾有一个方法fixAfterInsertion(e),从名字中看不出任何意思,知道它是在插入元素之后做一些调整工作,实际是每次插入完元素后会将树调整为红黑树,下面是红黑树具体实现代码:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
/** From CLR */
private void fixAfterInsertion(Entry<K,V> x) {
x.color = RED;
while (x != null && x != root && x.parent.color == RED) {
if (parentOf(x) == leftOf(parentOf(parentOf(x)))) {
Entry<K,V> 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<K,V> 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;
}

get

get方法比较简单,用比较器从根节点挨个比较,如果比较结果cmp=0即返回。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
public V get(Object key) {
Entry<K,V> p = getEntry(key);
return (p==null ? null : p.value);
}
final Entry<K,V> getEntry(Object key) {
// Offload comparator-based version for sake of performance
if (comparator != null)
return getEntryUsingComparator(key);
if (key == null)
throw new NullPointerException();
Comparable<? super K> k = (Comparable<? super K>) key;
Entry<K,V> 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;
}

小结

A Red-Black tree based NavigableMap implementation. The map is sorted according to the natural ordering of its keys, or by a Comparator provided at map creation time, depending on which constructor is used.
This implementation provides guaranteed log(n) time cost for the containsKey, get, put and remove operations.

TreeMap自身有以下一些特性:

  • 从TreeMap开始的注释文档中可以看,TreeMap是基于纯粹的红黑树构建的。
  • 相对于HashMap的无序性来说,TreeMap实现了NavigableMap这一接口,而NavigableMap继承了SortedMap接口,因此这保证了它的有序性。
  • 另外,红黑树的结构保证了TreeMap对于get、put、remove等操作都是log(n)的时间复杂度,效率较高。

与HashMap比较而言:

  • HashMap:适用于在Map中插入、删除和定位元素。
  • Treemap:适用于按自然顺序或自定义顺序遍历键(key)。

基于树和哈希表的数据结构使然,HashMap通常比TreeMap快一点,建议多使用HashMap,在需要排序的Map时候才用TreeMap。