Java集合框架总结（3）——TreeSet类的排序问题

TreeSet支持两种排序方法：自然排序和定制排序。TreeSet默认采用自然排序。

 

1、自然排序

    TreeSet会调用集合元素的compareTo(Object obj)方法来比较元素之间大小关系，然后将集合元素按升序排列，这种方式就是自然排序。（比较的前提：两个对象的类型相同）。

 

    java提供了一个Comparable接口，该接口里定义了一个compareTo(Object obj)方法，该方法返回一个整数值，实现该接口的类必须实现该方法，实现了该接口的类的对象就可以比较大小。当一个对象调用该方法与另一个对象进行比较，例如obj1.comparTo(obj2),如果该方法返回0，则表明这两个对象相等；如果返回一个正整数，则表明obj1大于obj2；如果该方法返回一个负整数，则表明obj1小于obj2.

 

java常用类实现Comparable接口，并提供了比较大小的标准。实现Comparable接口的常用类：

• BigDecimal、BigIneger以及所有数值型对应包装类：按它们对应的数值的大小进行比较。
• Character：按字符的UNICODE值进行比较。
• Boolean：true对应的包装类实例大于false对应的包装类实例。
• String：按字符串中字符的UNICODE值进行比较。
• Date、Time：后面的时间、日期比前面的时间、日期大。

如果试图把一个对象添加进TreeSet时，则该对象的类必须实现Comparable接口。

如下程序则会报错：

class Err 
{ 
} 
public class TestTreeSetError 
{ 
    public static void main(String[] args) 
    { 
        TreeSet ts = new TreeSet(); 
        //向TreeSet集合中添加两个Err对象 
        ts.add(new Err()); 
        ts.add(new Err()); 
    } 
}

 

说明：

    上面程序试图向TreeSet集合中添加2个Err对象，添加第一个对象时，TreeSet里没有任何元素，所以没有问题；当添加第二个Err对象时，TreeSet就会调用该对象的compareTo(Object obj)方法与集合中其他元素进行比较——如果对应的类没有实现Comparable接口，则会引发ClassCastException异常。而且当试图从TreeSet中取出元素第一个元素时，依然会引发ClassCastException异常。

 

    当采用compareTo(Object obj)方法比较对象时，都需要将被比较对象obj强制类型转换成相同类型，因为只有相同类的两个实例才能比较大小。即向TreeSet中添加的应该是同一个类的对象，否则会引发ClassCastException异常。例如，当向TreeSet中添加一个字符串对象，这个操作完全正常。当添加第二个Date对象时，TreeSet就好调用该对象的compareTo(Object obj)方法与集合中其他元素进行比较，则此时程序会引发异常。

    在实际编程中，程序员可以定义自己的类向TreeSet中添加多种类型的对象，前提是用户自定义类实现了Comparable接口，实现该接口时在实现compareTo(Object obj)方法时没有进行强制类型转换。但当操作TreeSet里的集合数据时，不同类型的元素依然会发生ClassCastExceptio异常。（认真阅读下就会明白)

 

    当把一个对象加入TreeSet集合中时，TreeSet调用该对象的compareTo(Object obj)方法与容器中的其他对象比较大小，然后根据红黑树算法决定它的存储位置。如果两个对象通过compareTo(Object obj)比较相等，TreeSet即认为它们存储同一位置。

    

    对于TreeSet集合而言，它判断两个对象不相等的标准是：两个对象通过equals方法比较返回false，或通过compareTo（Object obj）比较没有返回0——即使两个对象时同一个对象，TreeSet也会把它们当成两个对象进行处理。

如下程序所示：

//Z类，重写了equals方法，总是返回false， 
//重写了compareTo(Object obj)方法，总是返回正整数 
class Z implements Comparable 
{ 
    int age; 
    public Z(int age) 
    { 
        this.age = age; 
    } 
    public boolean equals(Object obj) 
    { 
        return false; 
    } 
    public int compareTo(Object obj) 
    { 
        return 1; 
    } 
} 
public class TestTreeSet 
{ 
    public static void main(String[] args) 
    { 
        TreeSet set = new TreeSet(); 
        Z z1 = new Z(6); 
        set.add(z1); 
        System.out.println(set.add(z1)); 
        //下面输出set集合，将看到有2个元素 
        System.out.println(set); 
        //修改set集合的第一个元素的age属性 
        ((Z)(set.first())).age = 9; 
        //输出set集合的最后一个元素的age属性，将看到也变成了9 
        System.out.println(((Z)(set.last())).age); 
    } 
}

程序运行结果：

true 
[TreeSet.Z@1fb8ee3, TreeSet.Z@1fb8ee3] 
9

说明：

    程序中把同一个对象添加了两次，因为z1对象的equals()方法总是返回false，而且compareTo(Object obj)方法总是返回1。这样TreeSet会认为z1对象和它自己也不相同，因此TreeSet中添加两个z1对象。而TreeSet对象保存的两个元素实际上是同一个元素。所以当修改TreeSet集合里第一个元素的age属性后，该TreeSet集合里最后一个元素的age属性也随之改变了。

 

    总结：当需要把一个对象放入TreeSet中时，重写该对象对应类的equals()方法时，应保证该方法与compareTo(Object obj)方法有一致结果，其规则是：如果两个对象通过equals方法比较返回true时，这两个对象通过compareTo（Object obj）方法比较应返回0.

 

    如果两个对象通过equals方法比较返回true，但这两个对象通过compareTo(Object obj)方法比较不返回0时，这将导致TreeSet将会把这两个对象保存在不同位置，从而两个对象都可以添加成功，这与Set集合的规则有点出入。

 

如果两个对象通过compareTo(Object obj)方法比较返回0时，但它们通过equals方法比较返回false时将更麻烦：因为两个对象通过compareTo（Object obj）方法比较相等，TreeSet将试图把它们保存在同一个位置，但实际上又不行（否则将只剩下一个对象），所以处理起来比较麻烦。

 

    如果向TreeSet中添加一个可变对象后，并且后面程序修改了该可变对象的属性，导致它与其他对象的大小顺序发生改变，但TreeSet不会再次调整它们的顺序，甚至可能导致TreeSet中保存这两个对象，它们通过equals方法比较返回true，compareTo（Object obj）方法比较返回0.

如下程序所示：

public class D implements Comparable<Object> {

	int count;

	public D(int count) {

		this.count = count;

	}

	@Override
	public boolean equals(Object obj) {
		// TODO Auto-generated method stub
		if (obj instanceof D) {
			D r = (D) obj;
			if (r.count == this.count) {
				return true;
			}
		}
		return false;
	}

	@Override
	public String toString() {
		// TODO Auto-generated method stub
		return "D(属性是" + this.count+")";
	}

	@Override
	public int compareTo(Object obj) {
		// TODO Auto-generated method stub
		if (obj instanceof D) {
			
			D r = (D) obj;
			
			if (r.count == this.count) {
				
				return 0;
				
			} else if (r.count < this.count) {

				return 1;
				
			} else {

				return -1;
			}
		}
		return 0;
	}

}

public class JCFTest {

	/**
	 * @param args
	 */
	public static void main(String[] args) {

		TreeSet<D> tr = new TreeSet<D>();

		tr.add(new D(-3));
		tr.add(new D(-2));
		tr.add(new D(9));
		tr.add(new D(5));

		System.out.println(tr);

		Iterator<D> it = tr.iterator();

		while (it.hasNext()) {

			D d = it.next();

			if (d.equals(new D(-3))) {

				d.count = 20;

			}

			if (d.equals(new D(9))) {

				d.count = -2;

			}
		}

		System.out.println(tr);

		tr.remove(new D(5));

		System.out.println(tr);

		tr.remove(new D(-2));

		System.out.println(tr);

	}

}

运行结果：

[D(属性是-3), D(属性是-2), D(属性是5), D(属性是9)]
[D(属性是20), D(属性是-2), D(属性是5), D(属性是-2)]
[D(属性是20), D(属性是-2), D(属性是5), D(属性是-2)]
[D(属性是20), D(属性是5), D(属性是-2)]

说明：

    上面程序中的R对象是一个正常重写了equals方法和comparable方法类，这两个方法都以R对象的count属性作为判断的依据。可以看到程序第一次输出的结果是有序排列的。当改变R对象的count属性，程序的输出结果也发生了改变，而且包含了重复元素。然后再试图删除集合中的任何元素是会发生混乱，跟添加次序都有关系了，有时可以删除，有时删除不了。

 

    总结：与HashSet在处理这些对象时将非常复杂，而且容易出错。为了让程序更具健壮，推荐HashSet和TreeSet集合中只放入不可变对象。

 

2、定制排序

    TreeSet的自然排序是根据集合元素的大小，TreeSet将他们以升序排列。如果需要实现定制排序，例如降序，则可以使用Comparator接口。该接口里包含一个int compare（T o1， T o2）方法，该方法用于比较o1和o2的大小。

   如果需要实现定制排序，则需要在创建TreeSet集合对象时，并提供一个Comparator对象与该TreeSet集合关联，由该Comparator对象负责集合元素的排序逻辑。

如下程序所示：

class M { 
    int age;

    public M(int age) { 
        this.age = age; 
    }

    public String toString() { 
        return "M对象（age：" + age + ")"; 
    } 
}

public class TestTreeSet3 { 
    public static void main(String[] args) { 
        TreeSet ts = new TreeSet(new Comparator() { 
            public int compare(Object o1, Object o2) {

                M m1 = (M) o1; 
                M m2 = (M) o2;

                if (m1.age > m2.age) { 
                    return -1; 
                } else if (m1.age == m2.age) { 
                    return 0; 
                } else { 
                    return 1; 
                } 
            } 
        }); 
        ts.add(new M(5)); 
        ts.add(new M(-3)); 
        ts.add(new M(9)); 
        System.out.println(ts); 
    } 
}

程序运行结果：

[M对象（age：9), M对象（age：5), M对象（age：-3)]

说明：

    上面程序中创建了一个Comparator接口的匿名内部类对象，该对象负责ts集合的排序。所以当我们把M对象添加到ts集合中时，无须M类实现Comparable接口，因为此时TreeSet无须通过M对象来比较大小，而是由与TreeSet关联的Comparator对象来负责集合元素的排序。使用定制排序时，TreeSet对集合元素排序时不管集合元素本身的大小，而是由Comparator对象负责集合元素的排序规则。