Java集合，TreeSet底層實現和原理

時間 2019-11-13

標籤 java 集合 treeset 底層實現原理欄目 Java 简体版

原文原文鏈接

概述

文章的內容基於JDK1.7進行分析，之因此選用這個版本，是由於1.8的有些類作了改動，增長了閱讀的難度，雖然是1.7，可是對於1.8作了重大改動的內容，文章也會進行說明。java

TreeSet實現了SortedSet接口，它是一個有序的集合類，TreeSet的底層是經過TreeMap實現的。TreeSet並非根據插入的順序來排序，而是根據實際的值的大小來排序。TreeSet也支持兩種排序方式：安全

天然排序
自定義排序

數據結構

繼承關係

java.lang.Object 
    java.util.AbstractCollection<E> 
        java.util.AbstractSet<E> 
            java.util.TreeSet<E>

實現接口

Serializable, Cloneable, Iterable<E>, Collection<E>, NavigableSet<E>, Set<E>, SortedSet<E>

基本屬性

private transient NavigableMap<E,Object> m;  //存放元素的集合
private static final Object PRESENT = new Object();  //m中key 對應的value

重要方法深度解析

構造方法

//相同包下能夠訪問的構造方法，將指定的m賦值爲m 
TreeSet(NavigableMap<E,Object> m) {
    this.m = m;
}
//無參構造方法，建立一個空的TreeMap對象，並調用上面的構造方法
public TreeSet() {
    this(new TreeMap<E,Object>());
}
//指定比較器，並用指定的比較器建立TreeMap對象
public TreeSet(Comparator<? super E> comparator) {
    this(new TreeMap<>(comparator));
}
//將指定的集合C轉化爲TreeSet
public TreeSet(Collection<? extends E> c) {
    this();
    addAll(c);
}
//將SortedMap中的元素轉化爲TreeMap對象
public TreeSet(SortedSet<E> s) {
    this(s.comparator());
    addAll(s);
}

經過上面的構造方法，能夠看出TreeSet的底層是用TreeMap實現的。在構造方法中會建立一個TreeMap實例，用於存放元素，另外TreeSet是有序的，也提供了制定比較器的構造函數，若是沒有提供比較器，則採用key的天然順序進行比較大小，若是指定的比較器，則採用指定的比較器，進行key值大小的比較。數據結構

add()方法和remove()方法都比較的簡單，都是調用TreeMap的方法進行實現。app

源碼解析

public class TreeSet<E> extends AbstractSet<E>
    implements NavigableSet<E>, Cloneable, java.io.Serializable {

    //存放元素的map對象
    private transient NavigableMap<E,Object> m;

    //key-value ,不一樣的鍵都會對象相同的value, value = PRESENT
    private static final Object PRESENT = new Object();

    //指定的map對象
    TreeSet(NavigableMap<E,Object> m) {
        this.m = m;
    }

    //無參構造方法，初始化一個TreeMap對象
    public TreeSet() {
        this(new TreeMap<E,Object>());
    }

    //構造方法，指定比較器
    public TreeSet(Comparator<? super E> comparator) {
        this(new TreeMap<>(comparator));
    }

    //將集合中的元素轉化爲TreeSet存儲
    public TreeSet(Collection<? extends E> c) {
        this();
        addAll(c);
    }

    //構造方法，SortedSet轉化爲TreeSet存儲，並使用SortedSet的比較器
    public TreeSet(SortedSet<E> s) {
        this(s.comparator());
        addAll(s);
    }

    //遍歷方法，返回m.keyset集合
    public Iterator<E> iterator() {
        return m.navigableKeySet().iterator();
    }

    //逆序排序的迭代器
    public Iterator<E> descendingIterator() {
        return m.descendingKeySet().iterator();
    }

    /**
     * @since 1.6
     */
    public NavigableSet<E> descendingSet() {
        return new TreeSet<>(m.descendingMap());
    }

    //返回 m 包含的鍵值對的數量
    public int size() {
        return m.size();
    }

    //是否爲空
    public boolean isEmpty() {
        return m.isEmpty();
    }

    //是否包含指定的key
    public boolean contains(Object o) {
        return m.containsKey(o);
    }

    //添加元素，調用m.put方法實現
    public boolean add(E e) {
        return m.put(e, PRESENT)==null;
    }

    //刪除方法，調用m.remove()方法實現
    public boolean remove(Object o) {
        return m.remove(o)==PRESENT;
    }

    //清除集合
    public void clear() {
        m.clear();
    }

    //將一個集合中的全部元素添加到TreeSet中
    public  boolean addAll(Collection<? extends E> c) {
        // Use linear-time version if applicable
        if (m.size()==0 && c.size() > 0 &&
            c instanceof SortedSet &&
            m instanceof TreeMap) {
            SortedSet<? extends E> set = (SortedSet<? extends E>) c;
            TreeMap<E,Object> map = (TreeMap<E, Object>) m;
            Comparator<? super E> cc = (Comparator<? super E>) set.comparator();
            Comparator<? super E> mc = map.comparator();
            if (cc==mc || (cc != null && cc.equals(mc))) {
                map.addAllForTreeSet(set, PRESENT);
                return true;
            }
        }
        return super.addAll(c);
    }

    //返回子集合，經過 m.subMap()方法實現
    public NavigableSet<E> subSet(E fromElement, boolean fromInclusive,
                                  E toElement,   boolean toInclusive) {
        return new TreeSet<>(m.subMap(fromElement, fromInclusive,
                                       toElement,   toInclusive));
    }

    //返回set的頭部
    public NavigableSet<E> headSet(E toElement, boolean inclusive) {
        return new TreeSet<>(m.headMap(toElement, inclusive));
    }

    //返回尾部
    public NavigableSet<E> tailSet(E fromElement, boolean inclusive) {
        return new TreeSet<>(m.tailMap(fromElement, inclusive));
    }

    //返回子Set
    public SortedSet<E> subSet(E fromElement, E toElement) {
        return subSet(fromElement, true, toElement, false);
    }

    //返回set的頭部
    public SortedSet<E> headSet(E toElement) {
        return headSet(toElement, false);
    }

    //返回set的尾部
    public SortedSet<E> tailSet(E fromElement) {
        return tailSet(fromElement, true);
    }
    //返回m使用的比較器
    public Comparator<? super E> comparator() {
        return m.comparator();
    }

    //返回第一個元素
    public E first() {
        return m.firstKey();
    }
    //返回最後一個元素
    public E last() {
        return m.lastKey();
    }

    //返回set中小於e的最大的元素
    public E lower(E e) {
        return m.lowerKey(e);
    }

    //返回set中小於/等於e的最大元素
    public E floor(E e) {
        return m.floorKey(e);
    }

    //返回set中大於/等於e的最大元素
    public E ceiling(E e) {
        return m.ceilingKey(e);
    }

    //返回set中大於e的最小元素
    public E higher(E e) {
        return m.higherKey(e);
    }

    //獲取TreeSet中第一個元素，並從Set中刪除該元素
    public E pollFirst() {
        Map.Entry<E,?> e = m.pollFirstEntry();
        return (e == null) ? null : e.getKey();
    }

    //獲取TreeSet中最後一個元素，並從Set中刪除該元素
    public E pollLast() {
        Map.Entry<E,?> e = m.pollLastEntry();
        return (e == null) ? null : e.getKey();
    }

    //克隆方法
    public Object clone() {
        TreeSet<E> clone = null;
        try {
            clone = (TreeSet<E>) super.clone();
        } catch (CloneNotSupportedException e) {
            throw new InternalError();
        }

        clone.m = new TreeMap<>(m);
        return clone;
    }

    //將對象寫入到輸出流中。
    private void writeObject(java.io.ObjectOutputStream s)
        throws java.io.IOException {
        // Write out any hidden stuff
        s.defaultWriteObject();

        // Write out Comparator
        s.writeObject(m.comparator());

        // Write out size
        s.writeInt(m.size());

        // Write out all elements in the proper order.
        for (E e : m.keySet())
            s.writeObject(e);
    }

    //從輸入流中讀取對象的信息
    private void readObject(java.io.ObjectInputStream s)
        throws java.io.IOException, ClassNotFoundException {
        // Read in any hidden stuff
        s.defaultReadObject();

        // Read in Comparator
        Comparator<? super E> c = (Comparator<? super E>) s.readObject();

        // Create backing TreeMap
        TreeMap<E,Object> tm;
        if (c==null)
            tm = new TreeMap<>();
        else
            tm = new TreeMap<>(c);
        m = tm;

        // Read in size
        int size = s.readInt();

        tm.readTreeSet(size, s, PRESENT);
    }
    //序列化版本號
    private static final long serialVersionUID = -2479143000061671589L;
}