JAVA学习-TreeMap详解

1.定义

TreeMap是基于红黑树的实现,也是记录了key-value的映射关系,该映射根据key的自然排序进行排序或者根据构造方法中传入的比较器进行排序,也就是说TreeMap是有序的key-value集合。
通过TreeMap的定义可以看出以下几点:

1.TreeMap的内部实现是红黑树实现的,关于红黑树的内容可以参考JAVA学习-红黑树详解

2.TreeMap是有序的key-value集合。

下面就通过源码去了解下TreeMap的内部实现,本文源码来自与JDK_1.8.0_131

2.结构

2.1 类图结构

TreeMap

如上图所示是TreeMap的类图结构,其继承、实现的接口如下所示:

  • 1.Map 接口: 定义将键值映射到值的对象,Map规定不能包含重复的键值,每个键最多可以映射一个值,这个接口是用来替换Dictionary类。
  • 2.AbstractMap 类: 提供了一个Map骨架的实现,尽量减少了实现Map接口所需要的工作量
  • 3.SortedMap 接口: 定义按照key排序的Map结构,规定key-value是根据键key值的自然排序进行排序的,或者根据构造key-value时设定的构造器进行排序。
  • 4.NavigableMap 接口: 是SortedMap接口的子接口,在其基础上扩展了针对搜索目标返回最近匹配项的导航方法,例如方法lowEntry、floorEntry、ceilingEntry等,如果不存在这样的键,则返回null
  • 5.Cloneable 接口: 实现了该接口的类可以显示的调用Object.clone()方法,合法的对该类实例进行字段复制,如果没有实现Cloneable接口的实例上调用Obejct.clone()方法,会抛出CloneNotSupportException异常。正常情况下,实现了Cloneable接口的类会以公共方法重写Object.clone()
  • 6.Serializable 接口: 实现了该接口标示了类可以被序列化和反序列化,具体的 查询序列化详解

2.2 构造方法及基本属性

2.2.1 构造方法

如下TreeMap提供了如下的构造方法:

  • public TreeMap() :空的构造方法,默认容量为0
  • public TreeMap(Comparator<? super K> comparator):需要一个Comparator比较器作为参数,其实这一点很好理解因为TreeMap是一个有序的key-value集合,所以可以自定义比较器进行设定元素的排序规则
  • public TreeMap(Map<? extends K, ? extends V> m):将一个Map构建成一个TreeMap
  • public TreeMap(SortedMap<K, ? extends V> m):将一个SortedMap构建成一个TreeMap
2.2.2 基本属性

如下代码所示,是TreeMap的基本属性,其实TreeMap的属性相对来说比较简单如下所示,如下也有Entry节点的源码。

//比较器
private final Comparator<? super K> comparator;
// Entry节点,这个表示红黑树的根节点
private transient Entry<K,V> root;
// TreeMap中元素的个数
private transient int size = 0;
// TreeMap修改次数
private transient int modCount = 0;

static final class Entry<K,V> implements Map.Entry<K,V> {
    K key;//对于key值
    V value;//对于value值
    Entry<K,V> left;//指向左子树的引用
    Entry<K,V> right;//指向右子树的引用
    Entry<K,V> parent;//指向父节点的引用
    boolean color = BLACK;//节点的颜色默认是黑色
    
    // 省略部分代码
}

如下图所示,是TreeMap(key:为[4,2,5,6,8,7,9])的一个内部结构示意图,其中每个节点都是Entry类型的


TreeMap

3.实现

下面会详细介绍TreeMap中的put(K key,V value)方法及get(Object key)方法

3.1 put方法

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;
        //有特殊指定的比较器则使用比较器进行比较,否则使用key的比较器进行比较
        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 {
            if (key == null)
                throw new NullPointerException();
            @SuppressWarnings("unchecked")
                Comparable<? super K> k = (Comparable<? super K>) 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);
        }
        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方法的源码,可能看起来相对来说比较长,但是我们来详细分析下如以下步骤

  • 1.校验根节点:校验根节点是否为空,若为空则根据传入的key-value的值创建一个新的节点,若根节点不为空则继续第二步
  • 2.寻找插入位置:其实这点很好理解,由于TreeMap内部是红黑树实现的则插入元素时,实际上是会去遍历左子树,或者右子树(具体遍历哪颗子树是根据当前插入key-value与根节点的比较判定的,这部在代码里面其实分为两步来体现是否指定比较器,若指定了则使用指定的比较器比较,否则使用默认key的比较器进行比较(这里有一点需要注意是TreeMap是不允许key-value为NULL)
  • 3.新建并恢复:在第二步中实际上是需要确定当前插入节点的位置,而这一步是实际的插入操作,而插入之后为啥还需要调用fixAfterInsertion方法,这里是因为红黑树插入一个节点后可能会破坏红黑树的性质,则通过修改的代码使得红黑树从新达到平衡,具体可以参考JAVA学习-红黑树详解

其实从上面的分析来讲TreeMap插入一个节点的流程不是太复杂,只要深刻的理解红黑树的原理,这个流程就相对简单很多,其实这里本人存在一点疑问(为什么要引入红黑树来做TreeMap的结构,需要看到本文的大神指导指导),

3.2 get方法

如下所示是get方法的源码,其实际是调用了getEntry方法

public V get(Object key) {
    //获取元素,若为空则返回null否则返回其值
    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();
    @SuppressWarnings("unchecked")
        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;
    }

getEntry方法主要流程如下:

  • 1.构造器校验:判断是否指定构造器,若指定则调用getEntryUsingComparator,若没有则进行第二步
  • 2.空值校验:key若为空直接抛出NullPointerException,从这点可以看出TreeMap是不允许Key-value为空的
  • 3.遍历返回:遍历整个红黑树若找到对应的值则返回,否则返回null值
    以上就是getEntry方法的主要流程,在步骤一中提到了getEntryUsingComparator方法,其实该方法与步骤三中的操作并无太大差异,存在的区别就是使用了构造器进行比较。

3.总结

本文主要介绍了TreeMap的实现及其特点,还有一些方法及代码没有详解介绍,若想深入了解可以查看源码做更深入的探究。若有问题,请指正。

  • 1.TreeMap的内部实现是红黑树,关于红黑树的详解请查看JAVA学习-红黑树详解
  • 2.TreeMap特点有些是源于红黑树的一些特点,比如TreeMap是有序的,TreeMap不允许key-value为空等

推荐阅读更多精彩内容