JDK1.8 TreeMap源码学习

TreeMap

底层基于红黑树的集合,其特点就是可排序

红黑树

概念：一种自平衡的二叉查找树。

由来：二叉查找树：特点（左子树<父节点<右节点），其crud效率最高可达O(logn)，但是最低可达O(logn),即退化成链表。

因此出现了平衡二叉树(avl)，任意节点的左右孩子节点高度差<=1,查找时间复杂度为O（logn）,但是删除的维护成本过高，可能需要旋转多次。

在平衡了二叉查找树和avl性能后，出现了红黑树。其有5条性质。其中性质4,5最关键。保证了任意节点到叶子节点的最长路径不大于最短路径的2倍。

因此其crud时间复杂度都近似O(logn)。通过旋转和变色维护其5条性质。

应用：TreeMap,jdk1.8 HashMap(链表长度>8对链表进行树化)

插入节点和删除节点都需要通过旋转或者变色来维护红黑树的5条性质，其中删除节点比较复杂

一篇写的很好的关于红黑树的文章：

红黑树详细分析，看了都说好

源码分析

简单使用

TreeMap<Integer, String> map = new TreeMap<>();
        map.put(1, "AA");
        map.put(22, "BB");
        map.put(13, "cc");
        map.put(2, "DD");
        System.out.println(map);

　　输出结果

{1=AA, 2=DD, 13=cc, 22=BB}

　　

 为什么TreeMap中的数据时有序排列，因为其内部有一个重要的属性，如果创建TreeMap没有指定comparator，则使用key元素默认的comparator属性

private final Comparator<? super K> comparator;

TreeMap其他属性

    private transient Entry<K,V> root;

    // 节点个数，即长度
    private transient int size = 0;

    /**
     * 修改次数，fail-fast思想。多线程情况下，某线程遍历TreeMap时，另一线程remove或者put时，报错
     */
    private transient int modCount = 0;

　　

TreeMap构造函数

这个没啥好说的

    public TreeMap() {
        comparator = null;
    }

    public TreeMap(Comparator<? super K> comparator) {
        this.comparator = comparator;
    }

    public TreeMap(Map<? extends K, ? extends V> m) {
        comparator = null;
        putAll(m);
    }

    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) {
        }
    }

　　

查找算法 就是二分法查找思想

   // 根据key获取Entry 
　　final Entry<K,V> getEntry(Object key) {
        // Offload comparator-based version for sake of performance
　　// 如果comparator不为空，使用comparator；为空使用key的默认comparator
        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;
    }

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

　

插入元素　

    public V put(K key, V value) {
        Entry<K,V> t = root;
　　　　 // 1 root元素为空，则直接将插入节点置为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;
　　　　
　　　　// 2 while循环找到节点插入位置 parent节点为插入节点的父节点
        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);
　　　　　//3 插入新建的节点
        if (cmp < 0)
            parent.left = e;
        else
            parent.right = e;
　　　　 //4 插入节点后，对集合进行调整，使之满足红黑树的5条性质
        fixAfterInsertion(e);
        size++;
        modCount++;
        return null;
    }

　　

红黑树插入节点共5种情况

1. 插入节点是红黑树的根节点
2. 插入节点的父节点是黑色
3. 插入节点N的父节点为红色，其叔叔节点也为红色。通过变色即可。但是可能会导致祖父节点形成连续的红色，需要递归调整
4. 插入节点N的父节点为红色，其叔叔节点为黑色，节点N为父节点右孩子。需要进行旋转+变色
5. 插入节点N的父节点为红色，其叔叔节点为黑色，节点N为父节点左孩子。需要进行旋转+变色

情况4.5不是插入节点导致的，是经过调整（旋转，变色）后出现的情况

    private void fixAfterInsertion(Entry<K,V> x) {
　　　　// 新节点默认颜色为红色
        x.color = RED;
　　　　// 当前节点x为null或者是根节点或者其父亲节点颜色为黑色（如果经过一轮调整后，x的父节点仍为红色，则需继续调整），则退出循环
        while (x != null && x != root && x.parent.color == RED) {
　　　　　　// x节点的父节点为祖父节点的左孩子
            if (parentOf(x) == leftOf(parentOf(parentOf(x)))) {
　　　　　　　　　//y为叔叔节点
                Entry<K,V> y = rightOf(parentOf(parentOf(x)));
　　　　　　　　　　// 情况3
                if (colorOf(y) == RED) {
                    setColor(parentOf(x), BLACK);
                    setColor(y, BLACK);
                    setColor(parentOf(parentOf(x)), RED);
                    x = parentOf(parentOf(x));
                } else {
　　　　　　　　　　  // 情况4
                    if (x == rightOf(parentOf(x))) {
                        x = parentOf(x);
                        rotateLeft(x);
                    }
　　　　　　　　　　　　// 情况5
                    setColor(parentOf(x), BLACK);
                    setColor(parentOf(parentOf(x)), RED);
                    rotateRight(parentOf(parentOf(x)));
                }
            } else {
　　　　　　　　 // x节点的父节点为祖父节点的右孩子，同理
                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;
    }

　　

删除节点

红黑树删除节点和普通的二叉查找树删除节点类似。共分为以下三种情况

1 该节点为叶子节点=>直接删除

2 该节点有一个子节点=>删除该节点，使用子节点替换原来的节点，原来节点的颜色也继承过来的

3 该节点有两个子节点=>删除该节点，使用后继节点来替换原来的节点，原来节点颜色也继承过来,后继节点只有一个孩子节点

 删除节点后，需要对树进行再平衡。当前节点为红色，直接删除；为黑色，需要调整

    /**
     * Delete node p, and then rebalance the tree.
     */
    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. 
// 情况3
        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.
// 情况2
        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.

// 情况1
            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;
            }
        }
    }

　　

寻找元素后继节点

后继节点：大于该节点的最小节点

Java容器TreeMap的successor方法

后继节点比然没有左孩子（为什么，自己推导去吧）

一个节点的后继节点存在两种情况

1. 该节点有右孩子，后继节点为右孩子的左孩子，
2. 该节点没有右孩子，则为该节点的父节点

    static <K,V> TreeMap.Entry<K,V> successor(Entry<K,V> t) {
        if (t == null)
            return null;

       // 情况1
        else if (t.right != null) {
            Entry<K,V> p = t.right;
            while (p.left != null)
                p = p.left;
            return p;
        } else {

            // 情况2
            Entry<K,V> p = t.parent;
            Entry<K,V> ch = t;
            while (p != null && ch == p.right) {
                ch = p;
                p = p.parent;
            }
            return p;
        }
    }

　　

删除节点后，对树进行调整，使之满足红黑树的5条性质

仅对下图情况进行分析

 共有6种情况

 1、N是新的根

 2、S节点为红色，其他节点为黑色

3、N的父节点，兄弟节点及其子节点都为黑色.此时经过P节点黑高-1，需要对P节点进行再平衡

4.、N的父节点为红色，S和S的孩子为红色

5、 S为黑色，S的左节点为红色

6、S为黑色，S的右节点为红色

    private void fixAfterDeletion(Entry<K,V> x) {
// x不为根节点并且x节点为黑色（x为红色，直接删除，不需要再平衡）
        while (x != root && colorOf(x) == BLACK) {
// x为左子树
            if (x == leftOf(parentOf(x))) {

// sib叔叔节点，对应上面的S节点
                Entry<K,V> sib = rightOf(parentOf(x));
//情况2
                if (colorOf(sib) == RED) {
                    setColor(sib, BLACK);
                    setColor(parentOf(x), RED);
                    rotateLeft(parentOf(x));
                    sib = rightOf(parentOf(x));
                }
//情况3，情况4
                if (colorOf(leftOf(sib))  == BLACK &&
                    colorOf(rightOf(sib)) == BLACK) {
                    setColor(sib, RED);
                    x = parentOf(x);
                } else {
//情况5
                    if (colorOf(rightOf(sib)) == BLACK) {
                        setColor(leftOf(sib), BLACK);
                        setColor(sib, RED);
                        rotateRight(sib);
                        sib = rightOf(parentOf(x));
                    }
//情况6
                    setColor(sib, colorOf(parentOf(x)));
                    setColor(parentOf(x), BLACK);
                    setColor(rightOf(sib), BLACK);
                    rotateLeft(parentOf(x));
                    x = root;
                }
            } else { // symmetric

// x为右子树
                Entry<K,V> 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);
    }