JDK源码阅读-Comparable接口

概述

Comparable在java.lang包下，阅读源码后发现其内部只有一个方法compareTo()。从词根上分析，Comparable以-able结尾，表示它有自身具备的某种能力的性质，表明了Comparable对象本身是可以与同类型进行比较的，其比较方法为compareTo。

其定义如下：

public interface Comparable<T> {
    public int compareTo(T o);
}
复制代码

关注点

• Comparable接口会对实现它的类施加(impose)一个整体的顺序。这一顺序被认为是类的自然排序，类的compareTo方法被认为是它的自然比较方法。
• 实现此接口的对象列表（和数组）可以通过Collections.sort(和 Arrays.sort）进行自动排序。实现这一接口的对象在有序Map中，有序是按照key进行排序的;在有序Set中，是按照set集合中的元素排序的。而使用这些方法时，我们并不需要指定比较器comparator(说明:这些排序都是默认升序排序，且排序字段只有一个。如果一个类有多个排序字段，要对这个类集合进行排序，则需要重写比较器方法)。
• 对于类C的任意变量e1和e2，当且仅当e1.compareTo(e2) == 0与e1.equals(e2)具有相同的boolean值时，类C的自然排序才叫做与equals一致。注意，null不是任何类的实例，即使 e.equals(null)返回false，e.compareTo(null)也将抛出 NullPointerException。
• 我们强烈建议(尽管并不是必须的)：自然排序应该和equals结果保持一致。是因为自然排序用到了compareTo方法，这里的意思是需要满足关系:e1.compareTo(e2) == 0的和1.equals(e2)有相同的返回。这是因为没有明确比较器的有序set(和有序map)，如果自然排序不能和equals方法保持一致，那么它们会表现出一些诡异的行为。而且，这样的有序set(或者map)和equals中通用规范是矛盾的。
• 举个例子:如果向一个没有明确比较器的有序set中添加2个值a和b。a.equals(b)值为false，而a.compareTo(b) == 0值为true，那么第二次的add操作会失败。因为从有序set的角度看，a和b是等值的。(出现这种事情就很诡异了，明明a在add之后，b再add时，这是两个不同的值，应该被正常添加到集合中，但是却被拒绝了，因为add时，使用到了方法compareTo，去比较插入的值是否存在，而根据返回结果为0，这样二者就被认为是相同的值。所以我们一再强调:为避免这种异常，自然排序要和equals结果保持一致，必须满足e1.compareTo(e2) == 0的和e1.equals(e2)始终有相同的返回值)
• 实质上，所有实现了Comparable接口的java核心类，都满足自然排序的要求。唯一的例外类是:BigDecimal类。它的自然排序要求是:值相等而精度是不等的。所以，精度不同但值相同的两个BigDecimal对象，它们的equals方法返回值应该为true，而compareTo()方法应该返回0:

public static void main(String[] args){
    BigDecimal a = new BigDecimal(2.30);
    BigDecimal b = new BigDecimal(2.3);
    System.out.println("a.eauals(b): " + a.equals(b));
    System.out.println("a.compareTo(b): " + a.compareTo(b));
}

----------------outpout----------------
a.eauals(b): true
a.compareTo(b): 0
复制代码

方法

Comparable接口唯一的方法定义如下：

public int compareTo(T o);
复制代码

对于a.compareTo(b)返回值定义如下：

1. a > b => 整数
2. a == b => 0
3. a < b => 负数

异常情况：

1. NullPointException: 入参为null
2. ClassCastException: 入参类型与被比较类型不兼容，如执行new Integer(1).compareTo(new Double(2.1));时，编译错误：Error:(35, 23) java: 不兼容的类型: java.lang.Double无法转换为java.lang.Integer

看下Integer类实现的compareTo方法和equals方法：

public final class Integer extends Number implements Comparable<Integer> { // 实现Comparable接口时，加上泛型限定，实现编译阶段入参类型检查
    ...
    @Override
    public int compareTo(Integer anotherInteger){
        return (this.vaule < anotherInteger.value) ? -1
            : ((this.value == anotherInteger.value) ? 0 : 1);
    }
    
    @Override
    public boolean equals(Object obj) {
        if (obj instanceof Integer) {
            return value == ((Integer)obj).intValue();
        }
        return false;
    }
    ...
}
复制代码

参考

JDK8中的Comparable接口源码分析