红黑树(三):TreeMap源码解析

java.util.TreeMap 这个类作为一个常用的 key-value 容器类,在JDK中也是比较重要的。从命名上看,这个类的内部实现就是一个树型结构。这个树型结构,其实就是我们之前讲解的红黑树。今天,我们结合代码,总结一下红黑树的实现。

插入数据

之前,在小密圈里,我已经提醒过大家去下载一份JDK的源代码,今天我们就打开这个源代码看一下。TreeMap.java位于 jdk/src/share/classes/java/util/ 这个目录下面。打开它,我们看一下put接口。

    public V put(K key, V value) {
        Entry<K,V> t = root;
        if (t == 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 {
            ....
        }
        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;
    }

前边是插入的过程,循环地向下查找,找到目标位置(t == null),就把新建的Entry e插入到树里,这个过程与普通的二叉树插入并无二致。接下来就是重点了,我们要针对现在的树型进行相应的调整。所以,重点分析一下,fixAfterInsertion 的实现。

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

这个代码,要对照我们前边讲红黑树插入的时候所讲解的三种情况仔细来看。

首先,新插入的结点都是红色的。如果其父结点是黑色的,那就什么都不用做。所以while循环里的条件有一条是 x.parent.color == RED。

我们看进入while以后,第一个 if 条件,这说的是如果x的父亲是x的祖父的左孩子的情况,y显然就是x的叔叔结点了。

如果 y 是红色的,比较简单,那就把父亲和叔叔都变黑,把爷爷变红。然后令 x 指向爷爷结点,继续下一次循环。

如果 y 是黑色的,就要再看 x 是其父亲的左孩子还是右孩子,如果是左孩子,就把父结点变为黑,祖父结点变为红,然后在祖父结点上做一次右旋。

如果 x 是右孩子,那就在其父结点上做一次左旋。让这个孩子变成父亲,让父亲变为左孩子。这样就转成上面那种情况。

下面的 else 是父结点是祖父结点的右孩子的情况,这与前边分析的情况互为镜像,就不再赘述了。说实在的,红黑树的插入看上去复杂,但其实代码,就这么十来行。

当然,最后别忘了要把根结点设为黑色。顺便,我们把之前AVL树那里讲的旋转的代码也放上来吧。

    private void rotateLeft(Entry<K,V> p) {
        if (p != null) {
            Entry<K,V> r = p.right;
            p.right = r.left;
            if (r.left != null)
                r.left.parent = p;
            r.parent = p.parent;
            if (p.parent == null)
                root = r;
            else if (p.parent.left == p)
                p.parent.left = r;
            else
                p.parent.right = r;
            r.left = p;
            p.parent = r;
        }
    }

删除数据

删除确实要是麻烦一些。毕竟我们在讲解的时候就分了6种情况。还是从deleteEntry开始看:

    private void deleteEntry(Entry<K,V> 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<K,V> 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<K,V> 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;
            }
        }
    }

这个代码,我们应该也很熟悉了,这也是普通的二叉树结点删除,如果待删除结点只有一个孩子,那把这个孩子交给祖父,自己就可以去死了。如果待删除结点有两个孩子,那就找到他的中续后继,把那个后继结点的内容拷过来,然后删除后继结点(为什么后继结点一定是最多只有一个孩子?大家可以顺便想一下,这个问题我们前边讲二叉树的时候已经讲过了,想不起来,就再去复习一下:))。

接下来就是删除并且调整,我们这里只分析replacement不为空,也就是待删除结点有一个孩子的情况。这个replacement是我们前边分析的时候所讲的N。如果p是红色,其实是不用调整的,只有当p为黑色的时候,才从replacement开始进行调整,接下来,我们看调整的代码:

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

                // 情况5,兄弟结点为红色,父亲一定是黑色
                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
                 ....
            }
        }
        setColor(x, BLACK);
    }

由于 x 是左孩子与 x 是右孩子的情况互为对称,所以,我们只看是左孩子的那一半就好了。

第一个 if 条件是情况5,如果兄弟结点为红色,那么父亲结点一定是黑色。这时要做的是,把父亲置为红色,把兄弟置为黑色,在父亲结点上左旋。就可以把情况5,转变为其他情况了。

接下来是情况2和6,如果兄弟结点的两个孩子都是黑的,那么,只要把兄弟结点变为红,这里的局部调整就结束了。让 x 指向父结点,这时经过父结点的所有路径的黑色结点就都少1了,那么继续向上进行调整就可以了。如果此时(x 已经指向了父结点了),x 是红的,那也可以跳出循环,并且把 x 置为黑色就可以了。所以这里 2 和 6 可以合并。前一节课,我为了讲解方便,就把这两种情况拆开了。

接下来是情况4,在兄弟结点上做一次右旋,转变为情况3。

接下来是情况3,交换兄弟结点和父结点的颜色(此时兄弟结点是黑色的),并设兄弟结点的右孩子为黑色,然后在父结点上左旋。情况3调整完了以后,局部达到平衡,同时全局也达到了平衡,所以可以令 x = root,立即结束这个循环了。

好了。到此为止,我们就把红黑树介绍完了。

今天的作业:

把上次的从1到10顺序插入的所得到的红黑树,再从1到10,顺序删除,自己画一下。并且写程序,单步调试,看一下,TreeMap里的结果与你自己画的是否相同。

上一节课:红黑树(二):删除

下一节课:Unicode字符集与UTF-8编码

目录:课程目录

编辑于 2017-02-27

文章被以下专栏收录