死磕 java集合之TreeMap源碼分析（二）- 內含紅黑樹分析全過程

插入元素

插入元素，如果元素在樹中存在，則替換value；如果元素不存在，則插入到對應的位置，再平衡樹。

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;
    }
    // key比較的結果
    int cmp;
    // 用來尋找待插入節點的父節點
    Entry<K,V> parent;
    // 根據是否有comparator使用不同的分支
    Comparator<? super K> cpr = comparator;
    if (cpr != null) {
        // 如果使用的是comparator方式，key值可以為null，只要在comparator.compare()中允許即可
        // 從根節點開始遍歷尋找
        do {
            parent = t;
            cmp = cpr.compare(key, t.key);
            if (cmp < 0)
                // 如果小于0從左子樹尋找
                t = t.left;
            else if (cmp > 0)
                // 如果大于0從右子樹尋找
                t = t.right;
            else
                // 如果等于0，說明插入的節點已經存在了，直接更換其value值并返回舊值
                return t.setValue(value);
        } while (t != null);
    }
    else {
        // 如果使用的是Comparable方式，key不能為null
        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)
                // 如果小于0從左子樹尋找
                t = t.left;
            else if (cmp > 0)
                // 如果大于0從右子樹尋找
                t = t.right;
            else
                // 如果等于0，說明插入的節點已經存在了，直接更換其value值并返回舊值
                return t.setValue(value);
        } while (t != null);
    }
    // 如果沒找到，那么新建一個節點，并插入到樹中
    Entry<K,V> e = new Entry<>(key, value, parent);
    if (cmp < 0)
        // 如果小于0插入到左子節點
        parent.left = e;
    else
        // 如果大于0插入到右子節點
        parent.right = e;

    // 插入之后的平衡
    fixAfterInsertion(e);
    // 元素個數加1（不需要擴容）
    size++;
    // 修改次數加1
    modCount++;
    // 如果插入了新節點返回空
    return null;
}

插入再平衡

插入的元素默認都是紅色，因為插入紅色元素只違背了第4條特性，那么我們只要根據這個特性來平衡就容易多了。

根據不同的情況有以下幾種處理方式：

1. 插入的元素如果是根節點，則直接涂成黑色即可，不用平衡；

2. 插入的元素的父節點如果為黑色，不需要平衡；

3. 插入的元素的父節點如果為紅色，則違背了特性4，需要平衡，平衡時又分成下面三種情況：

（如果父節點是祖父節點的左節點）

（如果父節點是祖父節點的右節點，則正好與上面反過來）

讓我們來看看TreeMap中的實現：

/**
 * 插入再平衡
 *（1）每個節點或者是黑色，或者是紅色。
 *（2）根節點是黑色。
 *（3）每個葉子節點（NIL）是黑色。（注意：這里葉子節點，是指為空(NIL或NULL)的葉子節點！）
 *（4）如果一個節點是紅色的，則它的子節點必須是黑色的。
 *（5）從一個節點到該節點的子孫節點的所有路徑上包含相同數目的黑節點。
 */
private void fixAfterInsertion(Entry<K,V> x) {
    // 插入的節點為紅節點，x為當前節點
    x.color = RED;

    // 只有當插入節點不是根節點且其父節點為紅色時才需要平衡（違背了特性4）
    while (x != null && x != root && x.parent.color == RED) {
        if (parentOf(x) == leftOf(parentOf(parentOf(x)))) {
            // a）如果父節點是祖父節點的左節點
            // y為叔叔節點
            Entry<K,V> y = rightOf(parentOf(parentOf(x)));
            if (colorOf(y) == RED) {
                // 情況1）如果叔叔節點為紅色
                // （1）將父節點設為黑色
                setColor(parentOf(x), BLACK);
                // （2）將叔叔節點設為黑色
                setColor(y, BLACK);
                // （3）將祖父節點設為紅色
                setColor(parentOf(parentOf(x)), RED);
                // （4）將祖父節點設為新的當前節點
                x = parentOf(parentOf(x));
            } else {
                // 如果叔叔節點為黑色
                // 情況2）如果當前節點為其父節點的右節點
                if (x == rightOf(parentOf(x))) {
                    // （1）將父節點設為當前節點
                    x = parentOf(x);
                    // （2）以新當前節點左旋
                    rotateLeft(x);
                }
                // 情況3）如果當前節點為其父節點的左節點（如果是情況2）則左旋之后新當前節點正好為其父節點的左節點了）
                // （1）將父節點設為黑色
                setColor(parentOf(x), BLACK);
                // （2）將祖父節點設為紅色
                setColor(parentOf(parentOf(x)), RED);
                // （3）以祖父節點為支點進行右旋
                rotateRight(parentOf(parentOf(x)));
            }
        } else {
            // b）如果父節點是祖父節點的右節點
            // y是叔叔節點
            Entry<K,V> y = leftOf(parentOf(parentOf(x)));
            if (colorOf(y) == RED) {
                // 情況1）如果叔叔節點為紅色
                // （1）將父節點設為黑色
                setColor(parentOf(x), BLACK);
                // （2）將叔叔節點設為黑色
                setColor(y, BLACK);
                // （3）將祖父節點設為紅色
                setColor(parentOf(parentOf(x)), RED);
                // （4）將祖父節點設為新的當前節點
                x = parentOf(parentOf(x));
            } else {
                // 如果叔叔節點為黑色
                // 情況2）如果當前節點為其父節點的左節點
                if (x == leftOf(parentOf(x))) {
                    // （1）將父節點設為當前節點
                    x = parentOf(x);
                    // （2）以新當前節點右旋
                    rotateRight(x);
                }
                // 情況3）如果當前節點為其父節點的右節點（如果是情況2）則右旋之后新當前節點正好為其父節點的右節點了）
                // （1）將父節點設為黑色
                setColor(parentOf(x), BLACK);
                // （2）將祖父節點設為紅色
                setColor(parentOf(parentOf(x)), RED);
                // （3）以祖父節點為支點進行左旋
                rotateLeft(parentOf(parentOf(x)));
            }
        }
    }
    // 平衡完成后將根節點設為黑色
    root.color = BLACK;
}

插入元素舉例

我們依次向紅黑樹中插入 4、2、3 三個元素，來一起看看整個紅黑樹平衡的過程。

三個元素都插入完成后，符合父節點是祖父節點的左節點，叔叔節點為黑色，且當前節點是其父節點的右節點，即情況2）。

情況2）需要做以下兩步處理：

（1）將父節點作為新的當前節點；

（2）以新當節點為支點進行左旋，進入情況3）；

情況3）需要做以下三步處理：

（1）將父節點設為黑色；

（2）將祖父節點設為紅色；

（3）以祖父節點為支點進行右旋，進入下一次循環判斷；

下一次循環不符合父節點為紅色了，退出循環，插入再平衡完成。

未完待續，下一節我們一起探討紅黑樹刪除元素的操作。