TreeMap及Set源码解析

1、本文主要内容

  • TreeMap及Set介绍
  • TreeMap源码解析
  • Set源码解析

2、TreeMap及Set介绍

首先我们查看Set接口,Set接口定义了add方法,remove方法,唯独没有定义get方法,用户是无法单独获取set的某元素,只能通过遍历获取。

Set是接口,本期主要讲述其中两个实现,HashSet以及TreeSet。顾名思义,HashSet使用哈希表存储元素,而TreeSet使用树结构存储元素。接下来的源码分析可以知道,HashSet利用了成员变量HashMap存储元素,而TreeSet使用成员变量TreeMap来存储元素,这也是本文要介绍TreeMap的原因。

TreeMap使用红黑树来存储元素,不过它实现的接口是Map,它存储的是键值对。

3、TreeMap源码解析

红黑树 前期已有介绍,本文不再重复红黑树添加修复以及删除修复内容的介绍了,不过先回忆下红黑树的5大特性:

  • 节点非黑即红
  • 根节点为黑
  • 叶结点(NIL结点,空结点)为黑
  • 红色结点的子结点一定是黑色的,也就是说没有两个相连的红色结点
  • 从根结点开始到每一个叶结点(NIL结点,空结点)之间的黑色结点数量相等

以上是红黑树的5大特性,依靠着上述特性,红黑树成为了相对平衡的二叉搜索树。

//put方法,存储元素
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
    //如果比较器不为null,则使用比较器来比较key之间的大小
    Comparator<? super K> cpr = comparator;
    if (cpr != null) {
        do {
            parent = t;
            cmp = cpr.compare(key, t.key);
            //如果key小于当前节点key,则将当前节点置为它的左子节点,反之则右子节点
            //这是二叉搜索树的性质,左子节点小于父节点,父节点小于右子节点
            if (cmp < 0)
                t = t.left;
            else if (cmp > 0)
                t = t.right;
            else
                return t.setValue(value);
        } while (t != null);
    }
    else {
        //如果比较器为null,则将key转化为Comparable比较,逻辑同上一样
        if (key == null)
            throw new NullPointerException();
        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);
    }
    //此时找到的parent即是新节点的parent节点
    Entry<K,V> e = new Entry<>(key, value, parent);
    //最后根据cmp的结果,确认新节点是左还是右子结点
    if (cmp < 0)
        parent.left = e;
    else
        parent.right = e;
    //修复红黑树
    fixAfterInsertion(e);
    size++;
    modCount++;
    return null;
}

put方法比较简单,结合二叉搜索树的性质,找到正确的位置,插入新节点即可。在红黑树中,为了尽量少违背那5条特性,一律将新插入的节点颜色置为红色,最后修复红黑树,使之仍然是一颗正常的红黑树,如何修复新增节点的红黑树,请参考以前写的红黑树一文。

private void deleteEntry(Entry<K,V> p) {
    modCount++;
    //删除节点,所以size减一
    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.
    //经过上面的判断,此时p不可能左右子树都存在,将存在的其中一个或者空指针,替换要被删除的节点
    Entry<K,V> replacement = (p.left != null ? p.left : p.right);

    if (replacement != null) {
        //如果替换的节点不为空,则将替换节点代替p结点
        // 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结点的关系斩断
        p.left = p.right = p.parent = null;

        // Fix replacement
        if (p.color == BLACK)
            //如果p结点是黑色的,现在删除p,性质5会违背,所以需要修复红黑树
            fixAfterDeletion(replacement);
    } else if (p.parent == null) { // return if we are the only node.
        //如果p没有父节点,则说明p结点为根结点,将root置空
        root = null;
    } else { //  No children. Use self as phantom replacement and unlink.
        if (p.color == BLACK)
            //同理,p颜色为黑色,那么修复红黑树
            fixAfterDeletion(p);

        if (p.parent != null) {
            //p的替代节点为null,但父节点不为null的情况下,处理p父节点相关信息
            if (p == p.parent.left)
                p.parent.left = null;
            else if (p == p.parent.right)
                p.parent.right = null;
            p.parent = null;
        }
    }
}

删除节点比添加节点稍复杂一些,尤其需要理解后继节点的含义,在删除节点p时,并不是直接删除节点p,如果p的两个子节点都存在的情况下,需要找出中序遍历下的p的后继节点,用后继节点代替p节点,最后删除的其实是后续节点。因为后继节点肯定最多只有一个子节点,位于树的底层,更加好删除一些。但删除后红黑树的修复更加复杂了,情况更多了。

4、Set源码解析

Set是接口,本期主要讲两个实现类,HashSet和TreeSet,但阅读源码后才知道,这两个实现类超级简单,因为它们所有的逻辑都是基于自身的成员变量HashMap和TreeMap,存、删除等都是调用成员变量的实现。

另外Set存储的不是键值对,但它们的成员变量存储的都是键值对,这是因为Set只用到了key值,value是一个默认值。

下面看看HashSet的存储和删除:

private transient HashMap<E,Object> map;
private static final Object PRESENT = new Object();
public boolean add(E e) {
    return map.put(e, PRESENT)==null;
}
public boolean remove(Object o) {
    return map.remove(o)==PRESENT;
}
public boolean contains(Object o) {
    return map.containsKey(o);
}

代码实在太简单了,就不再介绍了。现在来看看TreeSet的方法:

private transient NavigableMap<E,Object> m;
TreeSet(NavigableMap<E,Object> m) {
    this.m = m;
}
public TreeSet() {
    this(new TreeMap<E,Object>());
}

由上述方法可知,TreeSet中的成员变量其实是TreeMap。

public boolean add(E e) {
    return m.put(e, PRESENT)==null;
}
public boolean remove(Object o) {
    return m.remove(o)==PRESENT;
}

添加和删除同HashSet一样。

那么HashSet和TreeSet之间有什么不同呢?TreeSet它是基于红黑树的,红黑树是二叉搜索树,如果采用中序遍历的话,它的key会从大到小按顺序排列,所以TreeSet它是有序的。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 162,475评论 4 372
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 68,744评论 2 307
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 112,101评论 0 254
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,732评论 0 221
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 53,141评论 3 297
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 41,049评论 1 226
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 32,188评论 2 320
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,965评论 0 213
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,716评论 1 250
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,867评论 2 254
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,341评论 1 265
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,663评论 3 263
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,376评论 3 244
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,200评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,990评论 0 201
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 36,179评论 2 285
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,979评论 2 279

推荐阅读更多精彩内容

  • 一、基本数据类型 注释 单行注释:// 区域注释:/* */ 文档注释:/** */ 数值 对于byte类型而言...
    龙猫小爷阅读 4,214评论 0 16
  • Java集合类可用于存储数量不等的对象,并可以实现常用的数据结构如栈,队列等,Java集合还可以用于保存具有映射关...
    小徐andorid阅读 1,852评论 0 13
  • 安装ionic、安装cordova 同时卸载ionic、卸载cordova 只卸载ionic 安装指定版本ioni...
    星辰大海_王阅读 739评论 0 5
  • 新增概念,原癌基因,是人类机体可以永生的奥秘么? (时间背景2496年)三月的奥斯陆,气温终于爬到到了零上,沉寂了...
    鱼丸粗面纸包鸡阅读 576评论 0 0
  • 今天又是周日,一个周末又要过完了。今天最大的突破就是英语了,早上一大早起来刷懂你,终于把第二单元的给过了,进入了第...
    大白兔_X阅读 133评论 0 0