集合详解之TreeSet集合--排序及API应用

一.TreeSet集合的介绍
TreeSet集合可以确保集合元素处于排序状态
TreeSet集合并不是根据元素的插入顺序进行排序的,而是根据元素实际指的大小进行排序的
与HashSet集合根据HashCode的值来决定元素的存储位置不同的是TreeSet集合是根据红黑树
的数据结构来存储集合元素的.


二.红黑树介绍
红黑树是一种自平衡排序二叉树，树中每个节点的值，都大于或等于在它的左子树中的所有
节点的值，并且小于或等于在它的右子树中的所有节点的值，这确保红黑树运行时可以快速
地在树中查找和定位的所需节点。


排序二叉树是一种特殊结构的二叉树，可以非常方便地对树中所有节点进行排序和检索。
排序二叉树要么是一棵空二叉树，要么是具有下列性质的二叉树：
若它的左子树不空，则左子树上所有节点的值均小于它的根节点的值；
若它的右子树不空，则右子树上所有节点的值均大于它的根节点的值；
它的左、右子树也分别为排序二叉树。

三.TreeSet集合支持两种排序方法:自然排序和定制排序.
3.1自然排序
TreeSet集合会调用集合元素的comPareTo(Object object)方法来比较元素之间的大小关系,
然后将元素按升序排列,这种方式就是自然排序.
当把一个对象添加到TreeSet集合时,TreeSet集合调用该对象的comPareTo(Object object)方
法与容器中的其他对象进行比较,然后根据红黑树结构找到他的存储位置.如果两个对象通过
comPareTo(Object object)方法比较相等,新对象将无法添加到TreeSet(Set集合元素不能重复)
集合中.


java提供了一个Comparable接口,该接口里提供了一个comPareTo(Object object)的方法,该方
法返回一个整数,实现该接口的类必须实现该方法,实现了该接口的类的对象就可以比较大小.
当一个对象调用该方法与另外一个对象进行比较时,如object1.compareTo(object2),如果该方
法返回0,则这两个对象相等,如果该方法返回一个正整数则表明object1大于object2,如果该方
法返回一个负整数则表明object1小于object2.


错误示例1
package javaDemo;


import java.util.TreeSet;


public class TreeSetDemo2 {
public static void main(String[] args) {
dealData();
}


public static void dealData() {
TreeSet<Student> dataList = new TreeSet<>();
dataList.add(new Student());
}
}
class Student{
private String name;
private int age;
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public int getAge() {
return age;
}
public void setAge(int age) {
this.age = age;
}
}
运行结果:
Exception in thread "main" java.lang.ClassCastException: javaDemo.Student cannot be cast to java.lang.Comparable
at java.util.TreeMap.compare(Unknown Source)
at java.util.TreeMap.put(Unknown Source)
at java.util.TreeSet.add(Unknown Source)
at javaDemo.TreeSetDemo2.dealData(TreeSetDemo2.java:12)
at javaDemo.TreeSetDemo2.main(TreeSetDemo2.java:7)
报异常是因为Student类没有实现Comparable接口.


错误示例2
package javaDemo;


import java.util.TreeSet;


public class TreeSetDemo2 {
public static void main(String[] args) {
dealData();
}


public static void dealData() {
TreeSet<Object> dataList = new TreeSet<>();
// dataList.add(new Student());
dataList.add("1");
dataList.add(1);
}
}
运行结果:
Exception in thread "main" java.lang.ClassCastException: java.lang.String cannot be cast to java.lang.Integer
at java.lang.Integer.compareTo(Unknown Source)
at java.util.TreeMap.put(Unknown Source)
at java.util.TreeSet.add(Unknown Source)
at javaDemo.TreeSetDemo2.dealData(TreeSetDemo2.java:14)
at javaDemo.TreeSetDemo2.main(TreeSetDemo2.java:7)
分析:
大部分类在实现compareTo(Object object)方法时都需要将被比较的对象object强转成相同的类型,
因为只有相同的类的两个实例才会比较大小.当试图把一个对象添加到TreeSet集合中时,TreeSet集合
就会调用该对象compareTo(Object object)方法与集合中的其他元素进行比较,这就要求集合中的其
他元素与该元素是同一个类的实例.
也就是说向TreeSet集合中添加的是同一个类的对象,否则就引发异常.


3.2定制排序
如果需要实现定制排序,如降序排序,则需要通过Comparator接口的帮助.该接口里面包含一个int compare(T o1,T o2)的方法;
该方法用于比较o1与o2的大小,返回0表示二者相等,返回正整数表明o1大于o2,返回负整数表明o1小于o2.
定制排序的代码实现
package javaDemo;


import java.util.Comparator;
import java.util.TreeSet;


public class TreeSetCustomSortWay {
public static void main(String[] args) {
// 创建一个实现Comparator接口的对象
Comparator<Child> comparator = new Comparator<Child>() {


@Override
public int compare(Child lhs, Child rhs) {
// 指明按什么 排序
if (lhs.getAge() != rhs.getAge()) {
return rhs.getAge() - lhs.getAge();
} else if (lhs.getBirthDay().getYear() != rhs.getBirthDay().getYear()) {
return rhs.getBirthDay().getYear() - lhs.getBirthDay().getYear();
} else if (lhs.getBirthDay().getMonth() != rhs.getBirthDay().getMonth()) {
return rhs.getBirthDay().getMonth() - lhs.getBirthDay().getMonth();
} else if (lhs.getBirthDay().getDay() != rhs.getBirthDay().getDay()) {
return rhs.getBirthDay().getDay() - lhs.getBirthDay().getDay();
}
return 0;
}
};
// 将Comparator对象作为形参加入到TreeSet构造函数中
TreeSet<Child> data = new TreeSet<>(comparator);
Child child1 = new Child("zhangsan", 27, new BirthDay(1989, 12, 12));
Child child2 = new Child("zhangsan", 27, new BirthDay(1989, 10, 12));
Child child3 = new Child("zhangsan", 27, new BirthDay(1989, 10, 11));
Child child4 = new Child("zhangsan", 26, new BirthDay(1990, 10, 11));
Child child5 = new Child("zhangsan", 24, new BirthDay(1992, 10, 11));
Child child6 = new Child("zhangsan", 27, new BirthDay(1989, 10, 11));
data.add(child1);
data.add(child2);
data.add(child3);
data.add(child4);
data.add(child5);
data.add(child6);
System.out.println(data);
}
}


class Child {


public Child(String name, int age, BirthDay birthDay) {
super();
this.name = name;
this.age = age;
this.birthDay = birthDay;
}


private String name;
private int age;
private BirthDay birthDay;


public int getAge() {
return age;
}


public void setAge(int age) {
this.age = age;
}


public String getName() {
return name;
}


public void setName(String name) {
this.name = name;
}


public BirthDay getBirthDay() {
return birthDay;
}


public void setBirthDay(BirthDay birthDay) {
this.birthDay = birthDay;
}


@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null) {
return false;
}
if (o.getClass() != getClass()) {
return false;
}
Child other = (Child) o;
if (age != other.getAge()) {
return false;
}
if (birthDay == null) {
if (other.getBirthDay() != null) {
return false;
}
} else {
if (other.getBirthDay() == null) {
return false;
}
if (birthDay != other.getBirthDay()) {
return false;
}
}
if (name == null) {
if (other.getName() != null) {
return false;
}
} else {
if (other.getName() == null) {
return false;
}
if (name != other.getName()) {
return false;
}
}
return true;
}


@Override
public int hashCode() {
final int prim = 31;
int result = 1;
result = prim * result + age;
result = prim * result + (birthDay == null ? 0 : birthDay.hashCode());
result = prim * result + (name == null ? 0 : name.hashCode());
return result;
}


@Override
public String toString() {
return "Child[name=" + name + ",age:" + age + ",birthday:" + birthDay + "]";
}
}


class BirthDay {
private int year;
private int month;
private int day;


public BirthDay(int year, int month, int day) {
super();
this.year = year;
this.month = month;
this.day = day;
}


public int getYear() {
return year;
}


public void setYear(int year) {
this.year = year;
}


public int getMonth() {
return month;
}


public void setMonth(int month) {
this.month = month;
}


public int getDay() {
return day;
}


public void setDay(int day) {
this.day = day;
}


@Override
public int hashCode() {
final int prim = 31;
int result = 1;
result = prim * result + year;
result = prim * result + month;
result = prim * result + day;
return result;
}


@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null) {
return false;
}
if (getClass() != o.getClass()) {
return false;
}
BirthDay other = (BirthDay) o;
if (year != other.getYear()) {
return false;
} else if (month != other.getMonth()) {
return false;
} else if (day != other.getDay()) {
return false;
}
return true;
}


@Override
public String toString() {
return "BirthDay[year:" + year + ",month:" + month + ",day:" + day + "]";
}
}

四.TreeSet集合的方法应用及结果分析
package javaDemo;


import java.util.TreeSet;


public class TreeSetDemo {
public static void main(String[] args) {
dealTreeSet();
dealTreeSet2();
dealTreeSet3();
dealTreeSet4();
}


/**
* Integer型数据
*/
public static void dealTreeSet() {
TreeSet<Object> treeSetData = new TreeSet<>();
treeSetData.add(1);
treeSetData.add(0);
treeSetData.add(-2);
treeSetData.add(2);
treeSetData.add(10);
treeSetData.add(8);
treeSetData.add(3);
treeSetData.add(9);
treeSetData.add(4);
treeSetData.add(-1);
System.out.println("TreeSet集合的元素为:" + treeSetData);
dealData(treeSetData);
// 被比较的是集合中的元素
System.out.println("TreeSet集合小于2的元素集合:" + treeSetData.lower(2));
// 被比较的不是集合中的元素
System.out.println("TreeSet集合小于5的元素集合:" + treeSetData.lower(5));
// 被比较的是集合中的元素
System.out.println("TreeSet集合大于5的元素集合:" + treeSetData.higher(5));
System.out.println("TreeSet集合大于2的元素集合:" + treeSetData.higher(2));
System.out.println("TreeSet集合中处于2到5的元素:" + treeSetData.subSet(2, 5));
System.out.println("TreeSet集合中处于2到8的元素:" + treeSetData.subSet(2, 8));
System.out.println("TreeSet集合中headSet()方法" + treeSetData.headSet(5));
System.out.println("TreeSet集合中headSet()方法" + treeSetData.headSet(8));
System.out.println("TreeSet集合中tailSet()方法" + treeSetData.tailSet(5));
System.out.println("TreeSet集合中tailSet()方法" + treeSetData.tailSet(8));


}


/**
* String型数据
*/
public static void dealTreeSet2() {
TreeSet<Object> treeSetData = new TreeSet<>();
treeSetData.add("java");
treeSetData.add("safe");
treeSetData.add("android");
treeSetData.add("androidw");
treeSetData.add("anquan");
System.out.println("TreeSet集合2的元素为:" + treeSetData);
dealData(treeSetData);
}


/**
* Boolean型数据
*/
public static void dealTreeSet3() {
TreeSet<Object> treeSetData = new TreeSet<>();
treeSetData.add(true);
treeSetData.add(false);
System.out.println("TreeSet集合3的元素为:" + treeSetData);
dealData(treeSetData);
}


/**
* Boolean型数据
*/
public static void dealTreeSet4() {
TreeSet<Object> treeSetData = new TreeSet<>();
treeSetData.add(true);
treeSetData.add(false);
System.out.println("TreeSet集合4的元素为:" + treeSetData);
dealData(treeSetData);
}


/**
* 输出集合第一个和最后一个元素
* 
* @param treeSetData
*/
public static void dealData(TreeSet<Object> treeSetData) {
System.out.println("集合第一个元素:" + treeSetData.first());
System.out.println("集合最后一个元素:" + treeSetData.last());
}


}


运行结果:
TreeSet集合的元素为:[-2, -1, 0, 1, 2, 3, 4, 8, 9, 10]  //该结果说明TreeSet集合元素处于排序状态
集合第一个元素:-2   //返回集合中第一个元素
集合最后一个元素:10   //返回集合中最后一个元素
TreeSet集合小于2的元素:1                               //返回集合中位于指定元素之前的元素
TreeSet集合小于5的元素:4                               //该结果说明TreeSet集合的lower()方法参数可以不是集合中的元素
TreeSet集合大于2的元素:3   //返回集合中位于指定元素之后的元素
TreeSet集合大于5的元素合:8   //该结果说明TreeSet集合的higher()方法参数可以不是集合中的元素
TreeSet集合中处于2到5的元素集合:[2, 3, 4]              //返回该set集合的子集合,该结果说明subSet()方法参数可以不是集合中的元素
TreeSet集合中处于2到8的元素集合:[2, 3, 4]   //返回该set集合的子集合,该结果说明subSet()方法包含左边不包含右边
TreeSet集合中headSet()方法[-2, -1, 0, 1, 2, 3, 4]   //返回该set集合的子集合,由小于参数的元素组成,该方法的参数可以不是集合中的元素
TreeSet集合中headSet()方法[-2, -1, 0, 1, 2, 3, 4]   //返回该set集合的子集合,由小于参数的元素组成,并且不包含该参数
TreeSet集合中tailSet()方法[8, 9, 10]   //返回该set集合的子集合,由小于参数的元素组成,该方法的参数可以不是集合中的元素
TreeSet集合中tailSet()方法[8, 9, 10]   //返回该set集合的子集合,由小于参数的元素组成,并且包含该参数
TreeSet集合2的元素为:[android, androidw, anquan, java, safe]
集合第一个元素:android
集合最后一个元素:safe
TreeSet集合3的元素为:[false, true]
集合第一个元素:false
集合最后一个元素:true
TreeSet集合4的元素为:[false, true]
集合第一个元素:false
集合最后一个元素:true


最后注意,TreeSet集合的这几个方法的参数都指的不是集合元素的角标,而是元素.