Java - TreeMap 源码阅读笔记

in Tech Java

简介

提供红黑树结构的Map。此前根据旧金山大学JS版,实现了Java的红黑树。详细介绍可参阅红黑树

构造方法

    public TreeMap() {
        comparator = null;
    }
    // 可自定义 Key 的比较器
    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) {
        }
    }

节点定义

    static final class Entry<K,V> implements Map.Entry<K,V> {
        K key;
        V value;
        // 左子节点
        Entry<K,V> left;
        // 右子节点
        Entry<K,V> right;
        // 父节点
        Entry<K,V> parent;
        // 节点颜色
        boolean color = BLACK;
    }

新增or修改节点

    private transient Entry<K,V> root;
    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;
        // 使用自定义比较器
        if (cpr != null) {
            // 递归查找节点
            do {
                // 当t为null时,说明已经找到了节点要插入的位置
                parent = t;
                cmp = cpr.compare(key, t.key);
                if (cmp < 0)
                    t = t.left;
                else if (cmp > 0)
                    t = t.right;
                else
                    // Key 相等的节点,更新操作
                    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
                    // Key 相等的节点,更新操作
                    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;
    }

fixAfterInsertion() 方法

    private void fixAfterInsertion(Entry<K,V> x) {
        // 默认新插入的节点为红色
        x.color = RED;
        // 当节点不为null且不等于根节点且父节点为红色(父节点如果为黑色,则符合要求,无需变更)
        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;
    }

rotateLeft() 方法

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

rotateRight() 方法

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

查找节点

get() 方法

    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;
        // 循环比较key,左<跟<右
        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;
    }

删除节点

remove() 方法

    public V remove(Object key) {
        Entry<K,V> p = getEntry(key);
        if (p == null)
            return null;

        V oldValue = p.value;
        deleteEntry(p);
        return oldValue;
    }

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