Java基礎系列-Comparable和Comparator

唯一浩哥發表於2019-02-17

原創文章,轉載請標註出處:《Java基礎系列-Comparable和Comparator》

一、概述

        Java中的排序是由Comparable和Comparator這兩個介面來提供的。

        Comparable表示可被排序的,實現該介面的類的物件自動擁有排序功能。

        Comparator則表示一個比較器,實現了該介面的的類的物件是一個針對目標類的物件定義的比較器,一般情況,這個比較器將作為一個引數進行傳遞。

二、Comparable

        Comparable的中文意思就是可被排序的,代表本身支援排序功能。只要我們的類實現了這個介面,那麼這個類的物件就會自動擁有了可被排序的能力。而且這個排序被稱為類的自然順序。這個類的物件的列表可以被Collections.sort和Arrays.sort來執行排序。同時這個類的例項具備作為sorted map的key和sorted set的元素的資格。

        假如a和b都是實現了Comparable介面的類C的例項,那麼只有當a.compareTo(b)的結果與a.equals(b)的結果一致時,才稱類C的自然順序與equals一致。強烈建議將類的自然順序和equals的結果保持一致,因為如果不一致的話,由該類物件為鍵的sorted map和由該類物件為元素的sorted set的行為將會變得很怪異。

        例如對於一個實現了Comparable介面的元素的有序集合sorted set而言,如果a.equals(b)結果為false,並且a.compareTo(b)==0,則第二個元素的新增操作將會失敗,因為在sorted set看來,二者在排序上是一致的,它不報儲存重複的元素。

        事實上,Java中的類基本都是自然順序與equals一致的,除了BigDecimal,因為BigDecimal中的自然順序和值相同但精度不同的元素(例如4和4.00)的equals均一致。

原始碼解析

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

        從原始碼中可以看到,該介面只有一個抽象方法compareTo,這個方法主要就是為了定義我們的類所要排序的方式。compareTo方法用於比較當前元素a與指定元素b,結果為int值,如果a > b,int>0;如果a=b,int=0;如果a<b,int<0。

三、Comparator

        Comparator中文譯為比較器,它可以作為一個引數傳遞到Collections.sort和Arrays.sort方法來指定某個類物件的排序方式。同時它也能為sorted set和sorted map指定排序方式。

        同Comparable類似,指定比較器的時候一般也要保證比較的結果與equals結果一致,不一致的話,對應的sorted set和sorted map的行為同樣會變得怪異。

        推薦實現的比較器類同時實現java.io.Serializable介面,以擁有序列化能力,因為它可能會被用作序列化的資料結構(TreeSet、TreeMap)的排序方法。

原始碼解析

@FunctionalInterface
public interface Comparator<T> {
    // 唯一的抽象方法,用於定義比較方式(即排序方式)
    // o1>o2,返回1;o1=o2,返回0;o1<o2,返回-1
    int compare(T o1, T o2);
    boolean equals(Object obj);
    // 1.8新增的預設方法:用於反序排列
    default Comparator<T> reversed() {
        return Collections.reverseOrder(this);
    }
    // 1.8新增的預設方法:用於構建一個次級比較器,當前比較器比較結果為0,則使用次級比較器比較
    default Comparator<T> thenComparing(Comparator<? super T> other) {
        Objects.requireNonNull(other);
        return (Comparator<T> & Serializable) (c1, c2) -> {
            int res = compare(c1, c2);
            return (res != 0) ? res : other.compare(c1, c2);
        };
    }
    // 1.8新增預設方法:指定次級比較器的
    // keyExtractor表示鍵提取器,定義提取方式
    // keyComparator表示鍵比較器,定義比較方式
    default <U> Comparator<T> thenComparing(
            Function<? super T, ? extends U> keyExtractor,
            Comparator<? super U> keyComparator)
    {
        return thenComparing(comparing(keyExtractor, keyComparator));
    }
    // 1.8新增預設方法:用於執行鍵的比較,採用的是由鍵物件內建的比較方式
    default <U extends Comparable<? super U>> Comparator<T> thenComparing(
            Function<? super T, ? extends U> keyExtractor)
    {
        return thenComparing(comparing(keyExtractor));
    }
    // 1.8新增預設方法:用於比較執行int型別的鍵的比較
    default Comparator<T> thenComparingInt(ToIntFunction<? super T> keyExtractor) {
        return thenComparing(comparingInt(keyExtractor));
    }
    // 1.8新增預設方法:用於比較執行long型別的鍵的比較
    default Comparator<T> thenComparingLong(ToLongFunction<? super T> keyExtractor) {
        return thenComparing(comparingLong(keyExtractor));
    }
    // 1.8新增預設方法:用於比較執行double型別的鍵的比較
    default Comparator<T> thenComparingDouble(ToDoubleFunction<? super T> keyExtractor) {
        return thenComparing(comparingDouble(keyExtractor));
    }
    // 1.8新增靜態方法:用於得到一個相反的排序的比較器,這裡針對的是內建的排序方式(即繼承Comparable)
    public static <T extends Comparable<? super T>> Comparator<T> reverseOrder() {
        return Collections.reverseOrder();
    }
    // 1.8新增靜態方法:用於得到一個實現了Comparable介面的類的比較方式的比較器
    // 簡言之就是將Comparable定義的比較方式使用Comparator實現
    @SuppressWarnings("unchecked")
    public static <T extends Comparable<? super T>> Comparator<T> naturalOrder() {
        return (Comparator<T>) Comparators.NaturalOrderComparator.INSTANCE;
    }
    // 1.8新增靜態方法:得到一個null親和的比較器,null小於非null,兩個null相等,如果全不是null,
    // 則使用指定的比較器比較,若未指定比較器,則非null全部相等返回0
    public static <T> Comparator<T> nullsFirst(Comparator<? super T> comparator) {
        return new Comparators.NullComparator<>(true, comparator);
    }
    // 1.8新增靜態方法:得到一個null親和的比較器,null大於非null,兩個null相等,如果全不是null,
    // 則使用指定的比較器比較,若未指定比較器,則非null全部相等返回0
    public static <T> Comparator<T> nullsLast(Comparator<? super T> comparator) {
        return new Comparators.NullComparator<>(false, comparator);
    }
    // 1.8新增靜態方法:使用指定的鍵比較器用於執行鍵的比較
    public static <T, U> Comparator<T> comparing(
            Function<? super T, ? extends U> keyExtractor,
            Comparator<? super U> keyComparator)
    {
        Objects.requireNonNull(keyExtractor);
        Objects.requireNonNull(keyComparator);
        return (Comparator<T> & Serializable)
            (c1, c2) -> keyComparator.compare(keyExtractor.apply(c1),
                                              keyExtractor.apply(c2));
    }
    // 1.8新增靜態方法:執行鍵比較,採用內建比較方式,key的類必須實現Comparable
    public static <T, U extends Comparable<? super U>> Comparator<T> comparing(
            Function<? super T, ? extends U> keyExtractor)
    {
        Objects.requireNonNull(keyExtractor);
        return (Comparator<T> & Serializable)
            (c1, c2) -> keyExtractor.apply(c1).compareTo(keyExtractor.apply(c2));
    }
    // 1.8新增靜態方法:用於int型別鍵的比較
    public static <T> Comparator<T> comparingInt(ToIntFunction<? super T> keyExtractor) {
        Objects.requireNonNull(keyExtractor);
        return (Comparator<T> & Serializable)
            (c1, c2) -> Integer.compare(keyExtractor.applyAsInt(c1), keyExtractor.applyAsInt(c2));
    }
    // 1.8新增靜態方法:用於long型別鍵的比較
    public static <T> Comparator<T> comparingLong(ToLongFunction<? super T> keyExtractor) {
        Objects.requireNonNull(keyExtractor);
        return (Comparator<T> & Serializable)
            (c1, c2) -> Long.compare(keyExtractor.applyAsLong(c1), keyExtractor.applyAsLong(c2));
    }
    // 1.8新增靜態方法:用於double型別鍵的比較
    public static<T> Comparator<T> comparingDouble(ToDoubleFunction<? super T> keyExtractor) {
        Objects.requireNonNull(keyExtractor);
        return (Comparator<T> & Serializable)
            (c1, c2) -> Double.compare(keyExtractor.applyAsDouble(c1), keyExtractor.applyAsDouble(c2));
    }
}

        老版本的Comparator中只要兩個方法,就是前兩個方法,後面的所有預設方法均為1.8新增的方法,採用的是1.8新增的功能:介面可新增預設方法。即便擁有如此多方法,該介面還是函式式介面,compare用於定義比較方式。

四、二者比較

        Comparable可以看做是內部比較器,Comparator可以看做是外部比較器。

        一個類,可以通過實現Comparable介面來自帶有序性,也可以通過額外指定Comparator來附加有序性。

        二者的作用其實是一致的,所以不要混用。

        我們看個例子吧:

        首先定義個模型:User

public class User implements Serializable, Comparable<User> {
    private static final long serialVersionUID = 1L;
    private int age;
    private String name;
    public User (){}
    public User (int age, String name){
        this.age = age;
        this.name = name;
    }
    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;
    }
    @Override
    public int compareTo(User o) {
        return this.age - o.age;
    }
    @Override
    public String toString() {
        return "[user={age=" + age + ",name=" + name + "}]";
    }
}

        在定義一個Comparator實現類MyComparator

public class MyComparator implements Comparator<User> {
    @Override
    public int compare(User o1, User o2) {
        return o1.getName().charAt(0)-o2.getName().charAt(0);
    }
}

        最後是測試類:Main

public class Main {
    public static void main(String[] args) {
        User u1 = new User(12, "xiaohua");
        User u2 = new User(10, "abc");
        User u3 = new User(15,"ccc");
        User[] users = {u1,u2,u3};
        System.out.print("陣列排序前:");
        printArray(users);
        System.out.println();
        Arrays.sort(users);
        System.out.print("陣列排序1後:");
        printArray(users);
        System.out.println();
        Arrays.sort(users, new MyComparator());
        System.out.print("陣列排序2後:");
        printArray(users);
        System.out.println();
        Arrays.sort(users, Comparator.reverseOrder());// 針對內建的排序進行倒置
        System.out.print("陣列排序3後:");
        printArray(users);
    }
    public static void printArray (User[] users) {
        for (User user:users) {
            System.out.print(user.toString());
        }
    }
}

        執行結果為:

陣列排序前:[user={age=12,name=xiaohua}][user={age=10,name=abc}][user={age=15,name=ccc}]
陣列排序1後:[user={age=10,name=abc}][user={age=12,name=xiaohua}][user={age=15,name=ccc}]
陣列排序2後:[user={age=10,name=abc}][user={age=15,name=ccc}][user={age=12,name=xiaohua}]
陣列排序3後:[user={age=15,name=ccc}][user={age=12,name=xiaohua}][user={age=10,name=abc}]

        通過上面的例子我們有一個結論,那就是兩種方式定義排序的優先順序,明顯Comparator比較器要優先於內部排序Comparable。

五、總結

  • Comparable為可排序的,實現該介面的類的物件自動擁有可排序功能。
  • Comparator為比較器,實現該介面可以定義一個針對某個類的排序方式。
  • Comparator與Comparable同時存在的情況下,前者優先順序高。

參考:

相關文章