关于java:JDK源码分析TreeMap1

44次阅读

共计 5886 个字符，预计需要花费 15 分钟才能阅读完成。

本文首发于微信公众号【WriteOnRead】，欢送关注。

1. 概述

后面数据结构与算法笔记对红黑树进行了剖析，而 TreeMap 外部就是基于红黑树实现的。示意图：

它的查找、插入、删除操作的工夫复杂度均为 O(logn)。

TreeMap 类的继承构造如下：

类签名：

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

TreeMap 实现了 Map 接口，其外部数据格式是“键 - 值对”的模式（Entry），排列程序是依照键的程序进行的。

2. 代码剖析

2.1 成员变量 

/**
 * The comparator used to maintain order in this tree map, or
 * null if it uses the natural ordering of its keys.
 *
 * TreeMap 外部的比拟器，若为空，则为天然程序
 */
private final Comparator<? super K> comparator;

// 根节点
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;

2.2 结构器

TreeMap 有四个结构器，别离如下：

/**
 * 无参结构器。应用 key 的天然顺序排列（key 要实现 Comparable 接口）*/
public TreeMap() {comparator = null;}

/**
 * 应用指定的 Comparator（比拟器）结构一个空的 TreeMap
 */
public TreeMap(Comparator<? super K> comparator) {this.comparator = comparator;}

/**
 * 应用给定的 Map 结构一个 TreeMap
 */
public TreeMap(Map<? extends K, ? extends V> m) {
    comparator = null;
    putAll(m);
}

/**
 * 应用给定的 SortedMap 结构一个 TreeMap
 *（应用 SortedMap 的程序）*/
public TreeMap(SortedMap<K, ? extends V> m) {comparator = m.comparator();
    try {buildFromSorted(m.size(), m.entrySet().iterator(), null, null);
    } catch (java.io.IOException cannotHappen) {} catch (ClassNotFoundException cannotHappen) {}}

2.3 罕用办法

  • 查找某个 key
// 判断 TreeMap 是否蕴含某个 key
public boolean containsKey(Object key) {return getEntry(key) != null;
}

// 查找 TreeMap 中某个 key 对应的 value（若不存在返回 null）public V get(Object key) {Entry<K,V> p = getEntry(key);
    return (p==null ? null : p.value);
}

因为这两个办法外部都是通过 getEntry 办法实现，因而放在一起剖析，如下：

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

当 Comparator 不为空时，应用如下办法查找：

/**
 * Version of getEntry using comparator. Split off from getEntry
 * for performance. (This is not worth doing for most methods,
 * that are less dependent on comparator performance, but is
 * worthwhile here.)
 */
final Entry<K,V> getEntryUsingComparator(Object key) {@SuppressWarnings("unchecked")
        K k = (K) key;
    Comparator<? super K> cpr = comparator;
    if (cpr != null) {
        Entry<K,V> 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;
}

能够看到，这两个办法都是二叉查找树的查找过程。

PS: 这里将 Comporator 和 Comparable 两个接口离开进行操作。正文阐明是出于性能思考，尽管大部分办法中不值得这样做，但这里值得。

  • 查找某个 value
public boolean containsValue(Object value) {for (Entry<K,V> e = getFirstEntry(); e != null; e = successor(e))
        if (valEquals(value, e.value))
            return true;
    return false;
}

getFirstEntry() 办法是获取第一个 Entry 节点（中序遍历最右边的节点）：

/**
 * Returns the first Entry in the TreeMap (according to the TreeMap's
 * key-sort function).  Returns null if the TreeMap is empty.
 */
final Entry<K,V> getFirstEntry() {
    Entry<K,V> p = root;
    if (p != null)
        while (p.left != null)
            p = p.left;
    return p;
}

查找某个 Entry 的后继节点：

/**
 * Returns the successor of the specified Entry, or null if no such.
 */
static <K,V> TreeMap.Entry<K,V> successor(Entry<K,V> t) {if (t == null)
        return null;
    // 若右子树不为空，则后继节点就是右子树的最小节点
    else if (t.right != null) {
        Entry<K,V> p = t.right;
        while (p.left != null)
            p = p.left;
        return p;
    } else {
        // 若右子树为空，则向上回溯
        Entry<K,V> p = t.parent;
        Entry<K,V> ch = t;
        while (p != null && ch == p.right) {
            ch = p;
            p = p.parent;
        }
        return p;
    }
}

能够看到，这里判断 TreeMap 是否蕴含某个 value，是依照二叉查找树的中序遍历去比拟是否存在与给定 value 相等的值。

lowerEntry / lowerKey: 查找比指定 key 小的最大 Entry / key

public Map.Entry<K,V> lowerEntry(K key) {return exportEntry(getLowerEntry(key));
}

public K lowerKey(K key) {return keyOrNull(getLowerEntry(key));
}
/**
 * Returns the entry for the greatest key less than the specified key; if
 * no such entry exists (i.e., the least key in the Tree is greater than
 * the specified key), returns {@code null}.
 */
final Entry<K,V> getLowerEntry(K key) {
    Entry<K,V> p = root;
    while (p != null) {int cmp = compare(key, p.key);
        // 给定的 key 大于根节点，持续与右子节点比拟
        if (cmp > 0) {if (p.right != null)
                p = p.right;
            else
                return p;
        } else {
            // 左子节点不为空，则为左子节点
            if (p.left != null) {p = p.left;} else {
                // 左子节点为空，向父节点上溯
                Entry<K,V> parent = p.parent;
                Entry<K,V> ch = p;
                while (parent != null && ch == parent.left) {
                    ch = parent;
                    parent = parent.parent;
                }
                return parent;
            }
        }
    }
    return null;
}

higherEntry / higherKey: 查找比指定 key 大的最小 Entry / key

public Map.Entry<K,V> higherEntry(K key) {return exportEntry(getHigherEntry(key));
}

public K higherKey(K key) {return keyOrNull(getHigherEntry(key));
}

getHigherEntry 办法与 getLowerEntry 办法实现相似，不同之处在于 left 和 right 相同，这里不再贴代码。

  • floorEntry / floorKey
public Map.Entry<K,V> floorEntry(K key) {return exportEntry(getFloorEntry(key));
}

public K floorKey(K key) {return keyOrNull(getFloorEntry(key));
}
/**
 * Gets the entry corresponding to the specified key; if no such entry
 * exists, returns the entry for the greatest key less than the specified
 * key; if no such entry exists, returns {@code null}.
 */
final Entry<K,V> getFloorEntry(K key) {
    Entry<K,V> p = root;
    while (p != null) {int cmp = compare(key, p.key);
        if (cmp > 0) {if (p.right != null)
                p = p.right;
            else
                return p;
        } else if (cmp < 0) {if (p.left != null) {p = p.left;} else {
                Entry<K,V> parent = p.parent;
                Entry<K,V> ch = p;
                while (parent != null && ch == parent.left) {
                    ch = parent;
                    parent = parent.parent;
                }
                return parent;
            }
        } else
            // 与上述办法的区别
            return p;
    }
    return null;
}

查找指定 key 关联的 Entry；若不存在，返回比该 key 小的最大 key 关联的 Entry；若这也不存在则返回 null。

PS: 该办法与下面的 getLowerEntry 办法仅相差 while 循环外部的一个 else。

  • ceilingEntry / ceilKey
public Map.Entry<K,V> ceilingEntry(K key) {return exportEntry(getCeilingEntry(key));
}

public K ceilingKey(K key) {return keyOrNull(getCeilingEntry(key));
}

getCeilingEntry 办法与 getFloorEntry 办法实现相似，也是 left 和 right 相同。就像下面 getLowerEntry 和 getHigherEntry 的区别那样，这里不再贴代码。

查找指定 key 关联的 Entry；若不存在，返回比该 key 大的最小 key 关联的 Entry；若这也不存在则返回 null。

还有几个截取 TreeMap 一部分的办法，别离如下：

public NavigableMap<K,V> headMap(K toKey, boolean inclusive) {
    return new AscendingSubMap<>(this,
                                 true,  null,  true,
                                 false, toKey, inclusive);
}

public NavigableMap<K,V> tailMap(K fromKey, boolean inclusive) {
    return new AscendingSubMap<>(this,
                                 false, fromKey, inclusive,
                                 true,  null,    true);
}

public NavigableMap<K,V> subMap(K fromKey, boolean fromInclusive,
                                K toKey,   boolean toInclusive) {
    return new AscendingSubMap<>(this,
                                 false, fromKey, fromInclusive,
                                 false, toKey,   toInclusive);
}

除此之外，最罕用的插入和删除操作还未剖析，这两局部比较复杂，因而留到前面独自剖析。

3. 小结

  1. TreeMap 实现了 Map 接口，外部节点类型为 Entry；
  2. 基于红黑树实现，具备红黑树的特点；
  3. 有序，依据 Entry 的 key 排序；
  4. 查找、插入、删除操作的工夫复杂度均为 O(logn)。

相干浏览：数据结构与算法笔记（四）

正文完
java
发表至： java
2021-02-07
 0
关于java:RocketMQ总结
使用-chart-部署-skywalking
关于java:java命名规范
关于java:8mybatis的基本工作流程20※