Java集合源码分析-TreeMap

Java集合源码分析-TreeMap_第1张图片

成员变量:

    private final Comparator comparator;
    private transient Entry root;
    private transient int size = 0;
    private transient int modCount = 0;

    private transient EntrySet entrySet;
    private transient KeySet navigableKeySet;
    private transient NavigableMap descendingMap;

    private static final Object UNBOUNDED = new Object();

    private static final boolean RED   = false;
    private static final boolean BLACK = true;

可以看出有一个排序器变量comparator,可以知道TreeMap是可以排序的(默认自然排序,或者自定义排序)。
节点类TreeMap.Entry:

    static final class Entry implements Map.Entry {
        K key;
        V value;
        Entry left;
        Entry right;
        Entry parent;
        boolean color = BLACK;

        Entry(K key, V value, Entry parent) {
            this.key = key;
            this.value = value;
            this.parent = parent;
        }

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

从节点类我们可以看出TreeMap的数据结构是基于红黑树的,关于红黑树可以看下我的这篇文章红黑树。
TreeMap提供四个构造器:

    public TreeMap() {
        comparator = null;
    }

    public TreeMap(Comparator comparator) {
        this.comparator = comparator;
    }

    public TreeMap(Map m) {
        comparator = null;
        putAll(m);
    }

    public TreeMap(SortedMap m) {
        comparator = m.comparator();
        try {
            buildFromSorted(m.size(), m.entrySet().iterator(), null, null);
        } catch (java.io.IOException cannotHappen) {
        } catch (ClassNotFoundException cannotHappen) {
        }
    }

第三个构造器调用putAll,第四个构造器调用buildFromSorted,看下putAll源码先 :

    public void putAll(Map map) {
        int mapSize = map.size();
        if (size==0 && mapSize!=0 && map instanceof SortedMap) {
            Comparator c = ((SortedMap)map).comparator();
            if (c == comparator || (c != null && c.equals(comparator))) {
                ++modCount;
                try {
                    buildFromSorted(mapSize, map.entrySet().iterator(),
                                    null, null);
                } catch (java.io.IOException cannotHappen) {
                } catch (ClassNotFoundException cannotHappen) {
                }
                return;
            }
        }
        super.putAll(map);
    }

可以看出,putAll里的两个if条件也是试图调用buildFromSorted方法然后直接return,不满足这两个if就调用super.putAll(map),那么buildFromSorted究竟干啥的?别慌,先把这两个if条件搞明白先。这两个if条件表示:

  1. 当前红黑树是空的
  2. 要插入的集合必须是有排序的即实现SortedMap接口
  3. 红黑树的排序器comparator和要插入的集合的排序器是相同的

解释了这两个if条件,你应该能明白buildFromSorted是干啥了的吧?没错,就是用来初始化红黑树的。调用super.putAll(map)会循环调用put方法,put方法里判断红黑树根节点root是nil的话也会初始化红黑树,为啥直接调用buildFromSorted而跳过了super.putAll(map)呢?我之前分析红黑树的文章里有提过,红黑树的put操作时间复杂度是,再加上外层的循环,那么super.putAll(map)时间复杂度就是,那么我们来分析下buildFromSorted的时间复杂度吧,看下buildFromSorted的源码:(JDK的作者真是性能优化到牙齿)

    private void buildFromSorted(int size, Iterator it,
                                 java.io.ObjectInputStream str,
                                 V defaultVal)
        throws  java.io.IOException, ClassNotFoundException {
        this.size = size;
        root = buildFromSorted(0, 0, size-1, computeRedLevel(size),
                               it, str, defaultVal);
    }

    private final Entry buildFromSorted(int level, int lo, int hi,
                                             int redLevel,
                                             Iterator it,
                                             java.io.ObjectInputStream str,
                                             V defaultVal)
        throws  java.io.IOException, ClassNotFoundException {
        if (hi < lo) return null;

        int mid = (lo + hi) >>> 1;

        Entry left  = null;
        if (lo < mid)
            left = buildFromSorted(level+1, lo, mid - 1, redLevel, it, str, defaultVal);
        // extract key and/or value from iterator or stream
        K key;
        V value;
        if (it != null) {
            if (defaultVal==null) {
                Map.Entry entry = (Map.Entry)it.next();
                key = (K)entry.getKey();
                value = (V)entry.getValue();
            } else {
                key = (K)it.next();
                value = defaultVal;
            }
        } else { // use stream
            key = (K) str.readObject();
            value = (defaultVal != null ? defaultVal : (V) str.readObject());
        }

        Entry middle =  new Entry<>(key, value, null);

        // color nodes in non-full bottommost level red
        if (level == redLevel)
            middle.color = RED;

        if (left != null) {
            middle.left = left;
            left.parent = middle;
        }

        if (mid < hi) {
            Entry right = buildFromSorted(level+1, mid+1, hi, redLevel, it, str, defaultVal);
            middle.right = right;
            right.parent = middle;
        }
        return middle;
    }

我不知道怎么把文章里的代码显示行数,凑合着解释吧。假设有序的map集合是,那么lo=0,hi=8,mid=4,以mid为根节点middle,将原来的集合分成两个子树left和right,分别作为根节点middle的左子树和右子树,,,再在两个子树上递归调用buildFromSorted方法,这样就构成了一棵树。

从上面的节点类TreeMap.Entry我们知道,节点的默认颜色是黑色,那么我们这棵树的所有节点颜色都是黑色,这棵树肯定满足红黑树的1、2、3、4性质(不清楚红黑树5条性质的话可以看下我的这篇文章红黑树),但是不一定满足性质5,当且仅当这棵树是满二叉树的时候才满足性质5,怎么办呢?我们对这棵树进行着色就好了。怎么着色呢?只需要把树的最底层的节点全部变成红色就行了,简单吧?而方法computeRedLevel就是计算树的最底层数,如果一个节点的层数,表示节点处于最底层,就染成红色,看下computeRedLevel源码:

    private static int computeRedLevel(int sz) {
        int level = 0;
        for (int m = sz - 1; m >= 0; m = m / 2 - 1)
            level++;
        return level;
    }

刚开始分析这个变量时有点晕,以为是树的高度,但是是从0开始计算的,而树的高度是从1开始计算的。

这样我们就成功构造了一个红黑树,我们很清晰的知道这个步骤的时间复杂度是,而super.putAll(map)时间复杂度是,这就是优先调用buildFromSorted的原因。

    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;
        }
        int cmp;
        Entry parent;
        // split comparator and comparable paths
        Comparator 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 {
            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);
        }
        Entry e = new Entry<>(key, value, parent);
        if (cmp < 0)
            parent.left = e;
        else
            parent.right = e;
        fixAfterInsertion(e);
        size++;
        modCount++;
        return null;
    }

由于红黑树是基于二叉排序树的,所以插入也是基于二叉排序树的,即:从根节点开始,遇键值较大者就向左,遇键值较小者就向右,一直到末端,就是插入点。

  1. 第一个条件if最简单,但是执行compare(key, key)是什么意思呀?我真搞不懂,求解释;
  2. 第一个条件if表示root不为nil并且排序器comparator不为nil,这和二叉排序树的算法一模一样,不解释了;
  3. 第三个条件else表示root不为nil并且排序器comparator为nil,那么就用自然排序,这和二叉排序树的算法一模一样,不解释了;
  4. 第四个条件if和else是进行插入操作;
  5. 插入完可能破坏红黑树的性质,进行修正操作fixAfterInsertion。

修正操作(左旋、右旋、变色)是一个很有技术含量的过程,我就不解释了,具体看我的这篇文章:红黑树。

    public V remove(Object key) {
        Entry p = getEntry(key);
        if (p == null)
            return null;
        V oldValue = p.value;
        deleteEntry(p);
        return oldValue;
    }

    private void deleteEntry(Entry p) {
        modCount++;
        size--;

        // If strictly internal, copy successor's element to p and then make p
        // point to successor.
        if (p.left != null && p.right != null) {
            Entry s = successor(p);
            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);

        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
            if (p.color == BLACK)
                fixAfterDeletion(replacement);
        } else if (p.parent == null) { // return if we are the only node.
            root = null;
        } else { //  No children. Use self as phantom replacement and unlink.
            if (p.color == BLACK)
                fixAfterDeletion(p);

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

    private void fixAfterDeletion(Entry x) {
        while (x != root && colorOf(x) == BLACK) {
            if (x == leftOf(parentOf(x))) {
                Entry sib = rightOf(parentOf(x));

                if (colorOf(sib) == RED) {
                    setColor(sib, BLACK);
                    setColor(parentOf(x), RED);
                    rotateLeft(parentOf(x));
                    sib = rightOf(parentOf(x));
                }

                if (colorOf(leftOf(sib))  == BLACK &&
                    colorOf(rightOf(sib)) == BLACK) {
                    setColor(sib, RED);
                    x = parentOf(x);
                } else {
                    if (colorOf(rightOf(sib)) == BLACK) {
                        setColor(leftOf(sib), BLACK);
                        setColor(sib, RED);
                        rotateRight(sib);
                        sib = rightOf(parentOf(x));
                    }
                    setColor(sib, colorOf(parentOf(x)));
                    setColor(parentOf(x), BLACK);
                    setColor(rightOf(sib), BLACK);
                    rotateLeft(parentOf(x));
                    x = root;
                }
            } else { // symmetric
                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);
    }

这个删除包括两步:删除和修正,这里不解释了,具体流程看我的这篇文章:红黑树。

TreeMap提供了三个迭代器进行遍历KeyIterator、ValueIterator、EntryIterator,这三个迭代器有一个共同的基类:PrivateEntryIterator,所以遍历操作都是PrivateEntryIterator操作的,
看下PrivateEntryIterator的构造器:

        PrivateEntryIterator(Entry first) {
            expectedModCount = modCount;
            lastReturned = null;
            next = first;
        }

注意first这个参数并不是root节点,看下生成first的方法:

    final Entry getFirstEntry() {
        Entry p = root;
        if (p != null)
            while (p.left != null)
                p = p.left;
        return p;
    }

可以看到迭代器保存的第一个节点next是树的最左边的节点而不是root节点,清楚这一点,那么我们分析迭代器的核心方法nextEntry就简单一些了:

        final Entry nextEntry() {
            Entry e = next;
            if (e == null)
                throw new NoSuchElementException();
            if (modCount != expectedModCount)
                throw new ConcurrentModificationException();
            next = successor(e);
            lastReturned = e;
            return e;
        }

    static  TreeMap.Entry successor(Entry t) {
        if (t == null)
            return null;
        else if (t.right != null) {
            Entry p = t.right;
            while (p.left != null)
                p = p.left;
            return p;
        } else {
            Entry p = t.parent;
            Entry ch = t;
            while (p != null && ch == p.right) {
                ch = p;
                p = p.parent;
            }
            return p;
        }
    }

一般的红黑树提供了中序遍历、前序遍历、后序遍历三种方法,而且是使用递归实现的,但是上面的代码是使用性能更优的while循环操作,这样避免了递归可能导致的OOM问题。

  1. 第一个条件if不解释
  2. 第二个条件elseif表示试图找到当前节点t的右子树最左边的节点,如果找不到就返回右孩子,表示当前节点的下一个节点优先是右子树最左边的节点,其次是右孩子
  3. 第三个条件else表示从当前节点t开始从右下向左上遍历一条斜线,ch表示斜线的顶点,p表示ch的父节点,这么可以肯定的是这条斜线肯定挂载在p的左子树上,意味着肯定是先遍历完一个节点的左子树再遍历这个节点自己,根据上一步骤的判断,最后遍历右子树。

根据上面三个步骤的分析,我们有理由猜测,successor方法就是二叉排序树中序遍历的while循环版本,而二叉排序树的中序遍历就是从小到大的自然排序,由于TreeMap可能有自己的排序器conparator,那么中序遍历的结果就是排序器的结果。

在分析TreeMap的遍历源码之前,我还不知道怎么使用while循环实现中序遍历,递归虽简单但是可能会栈溢出StackOverflowError,每个方法被执行的时候都会同时创建一个栈帧(Stack Frame)用于存储局部变量表、操作栈、动态链接、方法出口等信息,每一个方法被调用直至执行完成的过程,就对应着一个栈帧在虚拟机栈中从入栈到出栈的过程,如果栈深度大于虚拟机所允许的深度,将抛出StackOverflowError异常;如果虚拟机栈可以动态扩展(当前大部分的Java虚拟机都可动态扩展,只不过Java虚拟机规范中也允许固定长度的虚拟机栈),当扩展时无法申请到足够的内存时会抛出OutOfMemoryError异常。看了源码感觉新的装逼技能get到。

由于TreeMap基于红黑树实现的,时间复杂度平均能达到。我的这篇文章Java集合源码分析-HashMap和IdentityHashMap分析了HashMap的时间复杂度得知平均能达到,那么集合不需要排序的话首选HashMap这个类,如果需要排序就只能用TreeMap了。

参考文献
JVM(2):JVM内存结构

你可能感兴趣的:(Java集合源码分析-TreeMap)