位置：首页>> 软件编程>> java编程>> Java集合TreeSet用法详解

Java集合TreeSet用法详解

作者：南?墙　　发布时间：2023-11-10 22:53:34　

标签：Java,TreeSet,用法

第1部分 TreeSet介绍

TreeSet简介

TreeSet 是一个有序的集合，它的作用是提供有序的Set集合。它继承于AbstractSet抽象类，实现了NavigableSet<E>, Cloneable, java.io.Serializable接口。

TreeSet 继承于AbstractSet，所以它是一个Set集合，具有Set的属性和方法。

TreeSet 实现了NavigableSet接口，意味着它支持一系列的导航方法。比如查找与指定目标最匹配项。

TreeSet 实现了Cloneable接口，意味着它能被克隆。

TreeSet 实现了java.io.Serializable接口，意味着它支持序列化。

TreeSet是基于TreeMap实现的。TreeSet中的元素支持2种排序方式：自然排序或者根据创建TreeSet 时提供的 Comparator 进行排序。这取决于使用的构造方法。

TreeSet为基本操作（add、remove 和 contains）提供受保证的 log(n) 时间开销。

另外，TreeSet是非同步的。它的iterator 方法返回的迭代器是fail-fast的。

TreeSet的构造函数

// 默认构造函数。使用该构造函数，TreeSet中的元素按照自然排序进行排列。
TreeSet()

// 创建的TreeSet包含collection
TreeSet(Collection<? extends E> collection)

// 指定TreeSet的比较器
TreeSet(Comparator<? super E> comparator)

// 创建的TreeSet包含set
TreeSet(SortedSet<E> set)

TreeSet的API

boolean add(E object)
boolean addAll(Collection<? extends E> collection)
void clear()
Object clone()
boolean contains(Object object)
E first()
boolean isEmpty()
E last()
E pollFirst()
E pollLast()
E lower(E e)
E floor(E e)
E ceiling(E e)
E higher(E e)
boolean remove(Object object)
int size()
Comparator<? super E> comparator()
Iterator<E> iterator()
Iterator<E> descendingIterator()
SortedSet<E> headSet(E end)
NavigableSet<E> descendingSet()
NavigableSet<E> headSet(E end, boolean endInclusive)
SortedSet<E> subSet(E start, E end)
NavigableSet<E> subSet(E start, boolean startInclusive, E end, boolean endInclusive)
NavigableSet<E> tailSet(E start, boolean startInclusive)
SortedSet<E> tailSet(E start)

说明：

(01) TreeSet是有序的Set集合，因此支持add、remove、get等方法。
(02) 和NavigableSet一样，TreeSet的导航方法大致可以区分为两类，一类时提供元素项的导航方法，返回某个元素；另一类时提供集合的导航方法，返回某个集合。

lower、floor、ceiling 和 higher 分别返回小于、小于等于、大于等于、大于给定元素的元素，如果不存在这样的元素，则返回 null。

第2部分 TreeSet数据结构

TreeSet的继承关系

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

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

TreeSet与Collection关系如下图：

从图中可以看出：

(01) TreeSet继承于AbstractSet，并且实现了NavigableSet接口。
(02) TreeSet的本质是一个"有序的，并且没有重复元素"的集合，它是通过TreeMap实现的。TreeSet中含有一个"NavigableMap类型的成员变量"m，而m实际上是"TreeMap的实例"。

第3部分 TreeSet源码解析(基于JDK1.6.0_45)

为了更了解TreeSet的原理，下面对TreeSet源码代码作出分析。

package java.util;

public class TreeSet<E> extends AbstractSet<E>
implements NavigableSet<E>, Cloneable, java.io.Serializable
{
// NavigableMap对象
private transient NavigableMap<E,Object> m;

// TreeSet是通过TreeMap实现的，
// PRESENT是键-值对中的值。
private static final Object PRESENT = new Object();

// 不带参数的构造函数。创建一个空的TreeMap
public TreeSet() {
this(new TreeMap<E,Object>());
}

// 将TreeMap赋值给 "NavigableMap对象m"
TreeSet(NavigableMap<E,Object> m) {
this.m = m;
}

// 带比较器的构造函数。
public TreeSet(Comparator<? super E> comparator) {
this(new TreeMap<E,Object>(comparator));
}

// 创建TreeSet，并将集合c中的全部元素都添加到TreeSet中
public TreeSet(Collection<? extends E> c) {
this();
// 将集合c中的元素全部添加到TreeSet中
addAll(c);
}

// 创建TreeSet，并将s中的全部元素都添加到TreeSet中
public TreeSet(SortedSet<E> s) {
this(s.comparator());
addAll(s);
}

// 返回TreeSet的顺序排列的迭代器。
// 因为TreeSet时TreeMap实现的，所以这里实际上时返回TreeMap的“键集”对应的迭代器
public Iterator<E> iterator() {
return m.navigableKeySet().iterator();
}

// 返回TreeSet的逆序排列的迭代器。
// 因为TreeSet时TreeMap实现的，所以这里实际上时返回TreeMap的“键集”对应的迭代器
public Iterator<E> descendingIterator() {
return m.descendingKeySet().iterator();
}

// 返回TreeSet的大小
public int size() {
return m.size();
}

// 返回TreeSet是否为空
public boolean isEmpty() {
return m.isEmpty();
}

// 返回TreeSet是否包含对象(o)
public boolean contains(Object o) {
return m.containsKey(o);
}

// 添加e到TreeSet中
public boolean add(E e) {
return m.put(e, PRESENT)==null;
}

// 删除TreeSet中的对象o
public boolean remove(Object o) {
return m.remove(o)==PRESENT;
}

// 清空TreeSet
public void clear() {
m.clear();
}

// 将集合c中的全部元素添加到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);
}

// 返回子Set，实际上是通过TreeMap的subMap()实现的。
public NavigableSet<E> subSet(E fromElement, boolean fromInclusive,
E toElement, boolean toInclusive) {
return new TreeSet<E>(m.subMap(fromElement, fromInclusive,
toElement, toInclusive));
}

// 返回Set的头部，范围是：从头部到toElement。
// inclusive是是否包含toElement的标志
public NavigableSet<E> headSet(E toElement, boolean inclusive) {
return new TreeSet<E>(m.headMap(toElement, inclusive));
}

// 返回Set的尾部，范围是：从fromElement到结尾。
// inclusive是是否包含fromElement的标志
public NavigableSet<E> tailSet(E fromElement, boolean inclusive) {
return new TreeSet<E>(m.tailMap(fromElement, inclusive));
}

// 返回子Set。范围是：从fromElement(包括)到toElement(不包括)。
public SortedSet<E> subSet(E fromElement, E toElement) {
return subSet(fromElement, true, toElement, false);
}

// 返回Set的头部，范围是：从头部到toElement(不包括)。
public SortedSet<E> headSet(E toElement) {
return headSet(toElement, false);
}

// 返回Set的尾部，范围是：从fromElement到结尾(不包括)。
public SortedSet<E> tailSet(E fromElement) {
return tailSet(fromElement, true);
}

// 返回Set的比较器
public Comparator<? super E> comparator() {
return m.comparator();
}

// 返回Set的第一个元素
public E first() {
return m.firstKey();
}

// 返回Set的最后一个元素
public E first() {
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);
}

// 获取第一个元素，并将该元素从TreeMap中删除。
public E pollFirst() {
Map.Entry<E,?> e = m.pollFirstEntry();
return (e == null)? null : e.getKey();
}

// 获取最后一个元素，并将该元素从TreeMap中删除。
public E pollLast() {
Map.Entry<E,?> e = m.pollLastEntry();
return (e == null)? null : e.getKey();
}

// 克隆一个TreeSet，并返回Object对象
public Object clone() {
TreeSet<E> clone = null;
try {
clone = (TreeSet<E>) super.clone();
} catch (CloneNotSupportedException e) {
throw new InternalError();
}

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

// java.io.Serializable的写入函数
// 将TreeSet的“比较器、容量，所有的元素值”都写入到输出流中
private void writeObject(java.io.ObjectOutputStream s)
throws java.io.IOException {
s.defaultWriteObject();

// 写入比较器
s.writeObject(m.comparator());

// 写入容量
s.writeInt(m.size());

// 写入“TreeSet中的每一个元素”
for (Iterator i=m.keySet().iterator(); i.hasNext(); )
s.writeObject(i.next());
}

// java.io.Serializable的读取函数：根据写入方式读出
// 先将TreeSet的“比较器、容量、所有的元素值”依次读出
private void readObject(java.io.ObjectInputStream s)
throws java.io.IOException, ClassNotFoundException {
// Read in any hidden stuff
s.defaultReadObject();

// 从输入流中读取TreeSet的“比较器”
Comparator<? super E> c = (Comparator<? super E>) s.readObject();

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

// 从输入流中读取TreeSet的“容量”
int size = s.readInt();

// 从输入流中读取TreeSet的“全部元素”
tm.readTreeSet(size, s, PRESENT);
}

// TreeSet的序列版本号
private static final long serialVersionUID = -9L;
}

总结：

(01) TreeSet实际上是TreeMap实现的。当我们构造TreeSet时；若使用不带参数的构造函数，则TreeSet的使用自然比较器；若用户需要使用自定义的比较器，则需要使用带比较器的参数。
(02) TreeSet是非线程安全的。
(03) TreeSet实现java.io.Serializable的方式。当写入到输出流时，依次写入“比较器、容量、全部元素”；当读出输入流时，再依次读取。

第4部分 TreeSet遍历方式

4.1 Iterator顺序遍历

for(Iterator iter = set.iterator(); iter.hasNext(); ) {
iter.next();
}

4.2 Iterator顺序遍历

// 假设set是TreeSet对象

for(Iterator iter = set.descendingIterator(); iter.hasNext(); ) {
iter.next();
}

4.3 for-each遍历HashSet

// 假设set是TreeSet对象，并且set中元素是String类型

String[] arr = (String[])set.toArray(new String[0]);
for (String str:arr)
System.out.printf("for each : ％s\n", str);

TreeSet不支持快速随机遍历，只能通过迭代器进行遍历！

TreeSet遍历测试程序如下：

1 import java.util.*;
2
3 /**
4 * @desc TreeSet的遍历程序
5 *
6 * @author skywang
7 * @email kuiwu-wang@163.com
8 */
9 public class TreeSetIteratorTest {
10
11 public static void main(String[] args) {
12 TreeSet set = new TreeSet();
13 set.add("aaa");
14 set.add("aaa");
15 set.add("bbb");
16 set.add("eee");
17 set.add("ddd");
18 set.add("ccc");
19
20 // 顺序遍历TreeSet
21 ascIteratorThroughIterator(set) ;
22 // 逆序遍历TreeSet
23 descIteratorThroughIterator(set);
24 // 通过for-each遍历TreeSet。不推荐！此方法需要先将Set转换为数组
25 foreachTreeSet(set);
26 }
27
28 // 顺序遍历TreeSet
29 public static void ascIteratorThroughIterator(TreeSet set) {
30 System.out.print("\n ---- Ascend Iterator ----\n");
31 for(Iterator iter = set.iterator(); iter.hasNext(); ) {
32 System.out.printf("asc : ％s\n", iter.next());
33 }
34 }
35
36 // 逆序遍历TreeSet
37 public static void descIteratorThroughIterator(TreeSet set) {
38 System.out.printf("\n ---- Descend Iterator ----\n");
39 for(Iterator iter = set.descendingIterator(); iter.hasNext(); )
40 System.out.printf("desc : ％s\n", (String)iter.next());
41 }
42
43 // 通过for-each遍历TreeSet。不推荐！此方法需要先将Set转换为数组
44 private static void foreachTreeSet(TreeSet set) {
45 System.out.printf("\n ---- For-each ----\n");
46 String[] arr = (String[])set.toArray(new String[0]);
47 for (String str:arr)
48 System.out.printf("for each : ％s\n", str);
49 }
50 }

运行结果：

---- Ascend Iterator ----
asc : aaa
asc : bbb
asc : ccc
asc : ddd
asc : eee

---- Descend Iterator ----
desc : eee
desc : ddd
desc : ccc
desc : bbb
desc : aaa

---- For-each ----
for each : aaa
for each : bbb
for each : ccc
for each : ddd
for each : eee

第5部分 TreeSet示例

下面通过实例学习如何使用TreeSet

import java.util.*;

/**
* @desc TreeSet的API测试
*
* @author skywang
* @email kuiwu-wang@3.com
*/
public class TreeSetTest {

public static void main(String[] args) {
testTreeSetAPIs();
}

// 测试TreeSet的api
public static void testTreeSetAPIs() {
String val;

// 新建TreeSet
TreeSet tSet = new TreeSet();
// 将元素添加到TreeSet中
tSet.add("aaa");
// Set中不允许重复元素，所以只会保存一个“aaa”
tSet.add("aaa");
tSet.add("bbb");
tSet.add("eee");
tSet.add("ddd");
tSet.add("ccc");
System.out.println("TreeSet:"+tSet);

// 打印TreeSet的实际大小
System.out.printf("size : ％d\n", tSet.size());

// 导航方法
// floor(小于、等于)
System.out.printf("floor bbb: ％s\n", tSet.floor("bbb"));
// lower(小于)
System.out.printf("lower bbb: ％s\n", tSet.lower("bbb"));
// ceiling(大于、等于)
System.out.printf("ceiling bbb: ％s\n", tSet.ceiling("bbb"));
System.out.printf("ceiling eee: ％s\n", tSet.ceiling("eee"));
// ceiling(大于)
System.out.printf("higher bbb: ％s\n", tSet.higher("bbb"));
// subSet()
System.out.printf("subSet(aaa, true, ccc, true): ％s\n", tSet.subSet("aaa", true, "ccc", true));
System.out.printf("subSet(aaa, true, ccc, false): ％s\n", tSet.subSet("aaa", true, "ccc", false));
System.out.printf("subSet(aaa, false, ccc, true): ％s\n", tSet.subSet("aaa", false, "ccc", true));
System.out.printf("subSet(aaa, false, ccc, false): ％s\n", tSet.subSet("aaa", false, "ccc", false));
// headSet()
System.out.printf("headSet(ccc, true): ％s\n", tSet.headSet("ccc", true));
System.out.printf("headSet(ccc, false): ％s\n", tSet.headSet("ccc", false));
// tailSet()
System.out.printf("tailSet(ccc, true): ％s\n", tSet.tailSet("ccc", true));
System.out.printf("tailSet(ccc, false): ％s\n", tSet.tailSet("ccc", false));

// 删除“ccc”
tSet.remove("ccc");
// 将Set转换为数组
String[] arr = (String[])tSet.toArray(new String[0]);
for (String str:arr)
System.out.printf("for each : ％s\n", str);

// 打印TreeSet
System.out.printf("TreeSet:％s\n", tSet);

// 遍历TreeSet
for(Iterator iter = tSet.iterator(); iter.hasNext(); ) {
System.out.printf("iter : ％s\n", iter.next());
}

// 删除并返回第一个元素
val = (String)tSet.pollFirst();
System.out.printf("pollFirst=％s, set=％s\n", val, tSet);

// 删除并返回最后一个元素
val = (String)tSet.pollLast();
System.out.printf("pollLast=％s, set=％s\n", val, tSet);

// 清空HashSet
tSet.clear();

// 输出HashSet是否为空
System.out.printf("％s\n", tSet.isEmpty()?"set is empty":"set is not empty");
}
}