item14:实现Comparable接口

Comparable接口

Comparable接口提供一个用比较的方法compareTo，该方法的入参为泛型
源码

public interface Comparable<T> {
    public int compareTo(T o);
}

方法说明：
1.入参为泛型
2.如果两种不同类型的对象进行比较，该方法会抛出ClassCastException异常

该接口的用途

当你需要编写一个“值”类，即该类有明显的内在排序关系，比如按字母、数字、年代进行排序，那么你就需要实现该接口

该接口的返回结果

x.compareTo(y)
x<y 返回负数
x=y 返回0
x>y 返回正数

实现compareTo方法需要遵守的准则

与equals方法一样，该方法也遵守自反性、对称性和传递性。

自反性
sgn(x.compareTo(y)) == -sgn(y.compareTo(x))
对称性
如果 x.compareTo(y) == 0 ，可推出 sgn(x.compareTo(z)) == sgn(y.compareTo(z))
传递性
如果 (x.compareTo(y) > 0 && y.compareTo(z) > 0)，可得到x.compareTo(z) > 0

该方法还有额外的一条非强制性约束，即

(x.compareTo(y)==0) == (x.equals(y))
如果违反了该约束的话，最好注明：该类具有自然排序功能，但是与equals方法不一致

注意：

• 当你想为一个实现了Comparable接口的类添加一个新的值组件的时候，不要去实现该类，而是重新写一个类，利用组合持有该类的引用，提供一个方法返回该类的实例。这样的好处是可以自由实现compareTo方法。

• 编写compareTo方法和equals方法不同之处
  1.不需要对参数进行类型检查和类型转换。如果调用类型错误，编译器会提示

• Java 7提供为原生类型的包装类提供了静态的compare方法，因此不再推荐在compareTo方法中使用<或>对整数类型进行进行比较（本书之前的版本是如此推荐的），可以查看Integer的compareTo方法源码如下：

public int compareTo(Integer anotherInteger) {
        return compare(this.value, anotherInteger.value);
    }
public static int compare(int x, int y) {
        return (x < y) ? -1 : ((x == y) ? 0 : 1);
    }    

• compareTo是顺序比较而非同等性比较，如果一个域没有实现Comparable接口或者我们需要一个非标准顺序的比较时，用Comparator来代替
• 尽量使用基于静态比较方法的构造器（比如原生类型的包装类提供了静态的compare方法）或比较器构造方法

实现该接口的好处

鉴于许多集合类都实现了该接口，实现该接口的类就可以与集合类进行很好的协作（依赖比较的集合包括TreeSet、TreeMap和工具类Collections、Arrays）。比如实现了Comparable接口的类的对象的列表或数组可以通过Collections.sort或Arrays.sort进行自动排序。

Comparator接口

该接口提供了许多比较构造方法，支持比较器的流式构造。如下列子，对手机号进行比较

public class PhoneNumber {

    private final short areaCode, prefix, lineNum;

    public PhoneNumber(short areaCode, short prefix, short lineNum) {
        this.areaCode = rangeCheck(areaCode, 999, "areaCode");
        this.prefix = rangeCheck(prefix, 999, "prefix");
        this.lineNum = rangeCheck(lineNum, 9999, "lineNum");
    }

    private static short rangeCheck(int val, int max, String arg) {
        if (val < 0 || val > max)
            try {
                throw new IllegalAccessException(arg + ":" + val);
            } catch (IllegalAccessException e) {
                e.printStackTrace();
            }
        return (short) val;
    }
    
    //使用包装类的静态比较方法
    public int compareTo(PhoneNumber pn) {
        int result = Short.compare(areaCode, pn.areaCode);
        if (result == 0) {
            result = Short.compare(prefix, pn.prefix);
            if (result == 0) {
                result = Short.compare(lineNum, pn.lineNum);
            }
        }
        return result;
    }
}

上述的compareTo接口可以用下列Comparator接口提供的比较构造方法来实现

//使用Comparator接口提供的比较构造方法
    private static final Comparator<PhoneNumber> COMPARATOR = Comparator.comparingInt((PhoneNumber pn) -> pn.areaCode)
            .thenComparingInt(pn->pn.prefix)
            .thenComparingInt(pn->pn.lineNum);
    
    public int  compareTo(PhoneNumber pn){
       return COMPARATOR.compare(this, pn);
   }

总结

1. 当实现一个有顺序的“值”类时，应该实现Comparable接口，这样，该类的实例就很容易被排序、搜索，并且在基于比较的集合类中使用。
2. 在实现compareTo方法中比较域值（属性值）时，避免使用<和>。相反，使用原生类型提供的静态比较方法或Comparator接口的比较构造函数。