Java 中 Comparable 和 Comparator 比较

背景:深入分析Comparable 和Compatator两个接口的区别和具体使用。

本文,先介绍Comparable 和Comparator两个接口,以及它们的差异;接着,通过示例,对它们的使用方法进行说明。

Comparable 简介

Comparable 是排序接口。

若一个类实现了Comparable接口,就意味着“该类支持排序”。  即然实现Comparable接口的类支持排序,假设现在存在“实现Comparable接口的类的对象的List列表(或数组)”,则该List列表(或数组)可以通过 Collections.sort(或 Arrays.sort)进行排序。

此外,“实现Comparable接口的类的对象”可以用作“有序映射(如TreeMap)”中的键或“有序集合(TreeSet)”中的元素,而不需要指定比较器。(不很清楚)

Comparable 定义

Comparable 接口仅仅只包括一个函数,它的定义如下:

package java.lang;
import java.util.*;

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

说明:
假设我们通过 x.compareTo(y) 来“比较x和y的大小”。若返回“负数”,意味着“x比y小”;返回“零”,意味着“x等于y”;返回“正数”,意味着“x大于y”。

Comparator 简介

Comparator 是比较器接口。

我们若需要控制某个类的次序,而该类本身不支持排序(即没有实现Comparable接口);那么,我们可以建立一个“该类的比较器”来进行排序。这个“比较器”只需要实现Comparator接口即可。

也就是说,我们可以通过“实现Comparator类来新建一个比较器”,然后通过该比较器对类进行排序。

Comparator 定义

Comparator 接口仅仅只包括两个个函数,它的定义如下:

package java.util;

public interface Comparator<T> {

    int compare(T o1, T o2);

    boolean equals(Object obj);
}

说明:
(01) 若一个类要实现Comparator接口:它一定要实现compareTo(T o1, T o2) 函数,但可以不实现 equals(Object obj) 函数。

        为什么可以不实现 equals(Object obj) 函数呢? 因为任何类,默认都是已经实现了equals(Object obj)的。 Java中的一切类都是继承于java.lang.Object,在Object.java中实现了equals(Object obj)函数;所以,其它所有的类也相当于都实现了该函数。

(02) int compare(T o1, T o2) 是“比较o1和o2的大小”。返回“负数”,意味着“o1比o2小”;返回“零”,意味着“o1等于o2”;返回“正数”,意味着“o1大于o2”。

 Comparator 和 Comparable 比较

Comparable是排序接口;若一个类实现了Comparable接口,就意味着“该类支持排序”。
而Comparator是比较器;我们若需要控制某个类的次序,可以建立一个“该类的比较器”来进行排序。

我们不难发现:Comparable相当于“内部比较器”,而Comparator相当于“外部比较器”。

ps:外部比较器可以对内部比较器进行补充

我们通过一个测试程序来对这两个接口进行说明。源码如下:

/**
 * Project Name:CreazyJava
 * File Name:CompareComparatorAndComparableTest.java
 * Package Name:com.test.www.d0227
 * Date:2018年2月28日下午3:24:41
 * Copyright (c) 2018, 深圳金融电子结算中心 All Rights Reserved.
 *
*/

package com.test.www.d0227;

import java.util.ArrayList;
import java.util.Collections;
import java.util.Comparator;

/**
 * @desc "Comparator"和“Comparable”的比较程序。
 *   (01) "Comparable"
 *   它是一个排序接口,只包含一个函数compareTo()。
 *   一个类实现了Comparable接口,就意味着“该类本身支持排序”,它可以直接通过Arrays.sort() 或 Collections.sort()进行排序。
 *   (02) "Comparator"
 *   它是一个比较器接口,包括两个函数:compare() 和 equals()。
 *   一个类实现了Comparator接口,那么它就是一个“比较器”。其它的类,可以根据该比较器去排序。
 *
 *   综上所述:Comparable是内部比较器,而Comparator是外部比较器。
 *   一个类本身实现了Comparable比较器,就意味着它本身支持排序;若它本身没实现Comparable,也可以通过外部比较器Comparator进行排序。
 */
public class CompareComparatorAndComparableTest {

    public static void main(String[] args) {
        // 新建ArrayList(动态数组)
        ArrayList<Person> list = new ArrayList<Person>();
        // 添加对象到ArrayList中
        list.add(new Person("ccc", 20));
        list.add(new Person("AAA", 30));
        list.add(new Person("bbb", 10));
        list.add(new Person("ddd", 40));

        // 打印list的原始序列
        System.out.printf("Original  sort, list:%s
", list);

        // 对list进行排序
        // 这里会根据“Person实现的Comparable<String>接口”进行排序,即会根据“name”进行排序
        Collections.sort(list);
        System.out.printf("Name      sort, list:%s
", list);

        // 通过“比较器(AscAgeComparator)”,对list进行排序
        // AscAgeComparator的排序方式是:根据“age”的升序排序
        Collections.sort(list, new AscAgeComparator());
        System.out.printf("Asc(age)  sort, list:%s
", list);

        // 通过“比较器(DescAgeComparator)”,对list进行排序
        // DescAgeComparator的排序方式是:根据“age”的降序排序
        Collections.sort(list, new DescAgeComparator());
        System.out.printf("Desc(age) sort, list:%s
", list);

        // 判断两个person是否相等
        testEquals();
    }

    /**
     * @desc 测试两个Person比较是否相等。
     *   由于Person实现了equals()函数:若两person的age、name都相等,则认为这两个person相等。
     *   所以,这里的p1和p2相等。
     *
     *   TODO:若去掉Person中的equals()函数,则p1不等于p2
     */
    private static void testEquals() {
        Person p1 = new Person("eee", 100);
        Person p2 = new Person("eee", 100);
        if (p1.equals(p2)) {
            System.out.printf("%s EQUAL %s
", p1, p2);
        } else {
            System.out.printf("%s NOT EQUAL %s
", p1, p2);
        }
    }

    /**
     * @desc Person类。
     *       Person实现了Comparable接口,这意味着Person本身支持排序
     */
    private static class Person implements Comparable<Person> {
        int    age;
        String name;

        public Person(String name, int age) {
            this.name = name;
            this.age = age;
        }

        public String getName() {
            return name;
        }

        public int getAge() {
            return age;
        }

        public String toString() {
            return name + " - " + age;
        }

        /**
         * 比较两个Person是否相等:若它们的name和age都相等,则认为它们相等
         */
        boolean equals(Person person) {
            if (this.age == person.age && this.name == person.name)
                return true;
            return false;
        }

        /**
         * @desc 实现 “Comparable<String>” 的接口,即重写compareTo<T t>函数。
         *  这里是通过“person的名字”进行比较的
         */
        @Override
        public int compareTo(Person person) {
            //            return name.compareTo(person.name); //实现name字段的升序
            return age - person.age;// 实现age的升序 与AscAgeComparator效果一致
            //return this.name - person.name;
        }
    }

    /**
     * @desc AscAgeComparator比较器
     *       它是“Person的age的升序比较器”
     */
    private static class AscAgeComparator implements Comparator<Person> {

        @Override
        public int compare(Person p1, Person p2) {
            return p1.getAge() - p2.getAge();
        }
    }

    /**
     * @desc DescAgeComparator比较器
     *       它是“Person的age的升序比较器”
     */
    private static class DescAgeComparator implements Comparator<Person> {

        @Override
        public int compare(Person p1, Person p2) {
            return p2.getAge() - p1.getAge();
        }
    }

}
View Code

下面对这个程序进行说明。


a) Person类定义。如下:

private static class Person implements Comparable<Person>{
    int age;
    String name;
        
        ...

    /** 
     * @desc 实现 “Comparable<String>” 的接口,即重写compareTo<T t>函数。
     *  这里是通过“person的名字”进行比较的
     */
    @Override
    public int compareTo(Person person) {
        return name.compareTo(person.name);
        //return this.name - person.name;
    }   
}

说明:
(01) Person类代表一个人,Persong类中有两个属性:age(年纪) 和 name“人名”。
(02) Person类实现了Comparable接口,因此它能被排序。(在接口中可以按照其name或者age属性进行排序)

b) 在main()中,我们创建了Person的List数组(list)。如下:

// 新建ArrayList(动态数组)
ArrayList<Person> list = new ArrayList<Person>();
// 添加对象到ArrayList中
list.add(new Person("ccc", 20));
list.add(new Person("AAA", 30));
list.add(new Person("bbb", 10));
list.add(new Person("ddd", 40));

c) 接着,我们打印出list的全部元素。如下:

// 打印list的原始序列
System.out.printf("Original sort, list:%s
", list);

d) 然后,我们通过Collections的sort()函数,对list进行排序。

    由于Person实现了Comparable接口,因此通过sort()排序时,会根据Person支持的排序方式,即 compareTo(Person person) 所定义的规则进行排序。如下:

// 对list进行排序
// 这里会根据“Person实现的Comparable<String>接口”进行排序,即会根据“name”进行排序
Collections.sort(list);
System.out.printf("Name sort, list:%s
", list);

e) 对比Comparable和Comparator

    我们定义了两个比较器 AscAgeComparator 和 DescAgeComparator,来分别对Person进行 升序 和 降低 排序。

e.1) AscAgeComparator比较器

它是将Person按照age进行升序排序。代码如下:

/**
 * @desc AscAgeComparator比较器
 *       它是“Person的age的升序比较器”
 */
private static class AscAgeComparator implements Comparator<Person> {

    @Override
    public int compare(Person p1, Person p2) {
        return p1.getAge() - p2.getAge();
    }
}

ps:参数顺序p1-p1和入参顺序一致,为升序排列。

e.2) DescAgeComparator比较器

它是将Person按照age进行降序排序。代码如下:

/**
 * @desc DescAgeComparator比较器
 *       它是“Person的age的升序比较器”
 */
private static class DescAgeComparator implements Comparator<Person> {

    @Override
    public int compare(Person p1, Person p2) {
        return p2.getAge() - p1.getAge();
    }
}

f) 运行结果
运行程序,输出如下:

Original  sort, list:[ccc - 20, AAA - 30, bbb - 10, ddd - 40]
Name      sort, list:[AAA - 30, bbb - 10, ccc - 20, ddd - 40]
Asc(age)  sort, list:[bbb - 10, ccc - 20, AAA - 30, ddd - 40]
Desc(age) sort, list:[ddd - 40, AAA - 30, ccc - 20, bbb - 10]
eee - 100 EQUAL eee - 100

 关于Comparator的补充

1.为什么写?

  1. comparator 是javase中的接口,位于java.util包下,javase中的所有接口抽象度都很高,有必要重视
  2. 网上太多的文章告诉大家comparator是用来排序;确实,可以用来排序,但不仅限于排序
  3. 工作中实际需求出现很多需要使用comparator去处理的问题,在此总结一下。

2.接口功能

该接口的功能表示一个比较器,比较器当然具有可比性!那为什么一百度全是说是用来排序的?这是因为数组工具类和集合工具类中提供的工具方法sort方法都给出了含有Comparator接口的重载方法,大家见久了都只想到Comparator接口是用来排序的,按照java抽象的尿性来看,该接口如果为排序而生,我估计应该叫类似Sortable,Sortor之类的名字吧!下面是javase中该接口的使用原型:

1 Arrays.sort(T[],Comparator<? super T> c);
2 Collections.sort(List<T> list,Comparator<? super T> c);

3.使用场景

考虑什么场景使用该接口就需要考虑什么时候需要比较,比较常用的场景: 
1. 排序需要比较,需要比较两个对象谁在前谁在后。 
2. 分组需要比较,需要比较两个对象是否是属于同一组。 
3. 待补充

4.举个栗子

1.排序 
在List或数组中的对象如果没有实现Comparable接口时,那么就需要调用者为需要排序的数组或List设置一个Compartor,Compartor的compare方法用来告诉代码应该怎么去比较两个实例,然后根据比较结果进行排序

ps:在没有类内排序的情况下,使用类外排序作为补充。

talk is cheap show me the code

/**
 * Project Name:CreazyJava
 * File Name:SortTest.java
 * Package Name:com.test.www.d0227
 * Date:2018年2月28日上午9:18:21
 * Copyright (c) 2018, 深圳金融电子结算中心 All Rights Reserved.
 *
*/

package com.test.www.d0227;

/**
 * ClassName:SortTest <br/>
 * Function: TODO  <br/>
 * Date:     2018年2月28日 上午9:18:21 <br/>
 * @author   prd-lxw
 * @version   1.0
 * @since    JDK 1.7
 * @see      
 */

import java.util.ArrayList;
import java.util.Collections;
import java.util.Comparator;
import java.util.List;

public class SortTest {
    class Dog {
        public int    age;
        public String name;

        public Dog(int age, String name) {
            super();
            this.age = age;
            this.name = name;
        }

        @Override
        public String toString() {
            return "Dog [age=" + age + ", name=" + name + "]";
        }
    }

    public static void main(String[] args) {
        List<Dog> list = new ArrayList<>();
        list.add(new SortTest().new Dog(5, "DogA"));
        list.add(new SortTest().new Dog(6, "DogB"));
        list.add(new SortTest().new Dog(7, "DogC"));
        Collections.sort(list, new Comparator<Dog>() {

            @Override
            public int compare(Dog o1, Dog o2) {
                //                return o2.age - o1.age;
                return o1.age - o2.age;
            }
        });
        System.out.println("给狗狗按照年龄倒序:" + list);
        Collections.sort(list, new Comparator<Dog>() {

            @Override
            public int compare(Dog o1, Dog o2) {
                return o2.name.compareTo(o1.name);
                //                return o1.name.compareTo(o2.name);
            }
        });
        System.out.println("给狗狗按名字字母顺序排序:" + list);
    }
}

运行结果:

给狗狗按照年龄倒序:[Dog [age=5, name=DogA], Dog [age=6, name=DogB], Dog [age=7, name=DogC]]
给狗狗按名字字母顺序排序:[Dog [age=7, name=DogC], Dog [age=6, name=DogB], Dog [age=5, name=DogA]]

2.分组 

ps:主要是分组的思想,其实也可以用其他的方式,但是这样写代码更简洁易懂,也减少了冗余代码的出现。
使用Comparator和for循环处理列表,来进行分类;通过调用者实现Comparator接口的比较逻辑,来告诉程序应该怎么比较,通过比较之后得结果来进行分组。比如生活中的拳击比赛,会有公斤级的概念,那么程序中应该实现的处理逻辑是只要两个人的体重在同一个区间则为同一组公斤级的选手。下面例子中分别按照狗狗的颜色和体重级别两个维度来进行分组,因此分组的核心逻辑其实就是比较逻辑。相面我抽了一个工具方法:dividerList,第一个参数为需要处理的数据源,第二参数是分组时的比较逻辑。

package com.java.demo;

import java.util.ArrayList;
import java.util.Comparator;
import java.util.List;

/**
 * 
 * @author prd-lxw
 * @version $Id: GroupTest.java, v 0.1 2018年2月28日 上午9:26:15 prd-lxw Exp $
 */
public class GroupTest {
    class Apple {
        public String color;
        public int    weight;

        public Apple(String color, int weight) {
            super();
            this.color = color;
            this.weight = weight;
        }

        @Override
        public String toString() {
            return "Apple [color=" + color + ", weight=" + weight + "]";
        }
    }

    /**
     * @param list 
     * @param comparator 比较是否为同一组的比较器
     * @return List<List<T>>返回值中有多少个子元素就存在多少个分组
     */
    public static <T> List<List<T>> dividerList(List<T> list, Comparator<? super T> comparator) {
        List<List<T>> lists = new ArrayList<>();
        for (int i = 0; i < list.size(); i++) {
            boolean isContain = false;//对list.get(i)的存放进行控制判断
            for (int j = 0; j < lists.size(); j++) {//遍历lists中的子元素,如果compare(lists.get(j).get(0), list.get(i))比中,就将list.get(i)放入lists的子元素
                if (comparator.compare(lists.get(j).get(0), list.get(i)) == 0) {
                    lists.get(j).add(list.get(i));
                    isContain = true; //将list中第i个元素存入lists.get(j)的分组,不会进入下面if方法的判断,存储在lists的子list的后续空间
                    break;
                }
            }
            if (!isContain) {//将遍历的第i个list元素封装成List对象并存入lists中,存储在lsits的子list第一个位置
                List<T> newList = new ArrayList<>();
                newList.add(list.get(i));
                lists.add(newList);
            }
        }
        return lists;
    }

    public static void main(String[] args) {
        List<Apple> list = new ArrayList<>();
        list.add(new GroupTest().new Apple("红", 205));
        list.add(new GroupTest().new Apple("红", 131));
        list.add(new GroupTest().new Apple("绿", 248));
        list.add(new GroupTest().new Apple("绿", 153));
        list.add(new GroupTest().new Apple("黄", 119));
        list.add(new GroupTest().new Apple("黄", 224));
        List<List<Apple>> byColors = dividerList(list, new Comparator<Apple>() {

            @Override
            public int compare(Apple o1, Apple o2) {
                // 按颜色分组
                return o1.color.compareTo(o2.color);
            }
        });
        System.out.println("按颜色分组" + byColors);
        List<List<Apple>> byWeight = dividerList(list, new Comparator<Apple>() {

            @Override
            public int compare(Apple o1, Apple o2) {
                // 按重量级

                return (o1.weight / 100 == o2.weight / 100) ? 0 : 1;
            }
        });
        System.out.println("按重量级分组" + byWeight);
    }
}

运行结果:

按颜色分组[[Apple [color=红, weight=205], Apple [color=红, weight=131]], [Apple [color=绿, weight=248], Apple [color=绿, weight=153]], [Apple [color=黄, weight=119], Apple [color=黄, weight=224]]]
按重量级分组[[Apple [color=红, weight=205], Apple [color=绿, weight=248], Apple [color=黄, weight=224]], [Apple [color=红, weight=131], Apple [color=绿, weight=153], Apple [color=黄, weight=119]]]

5.总结

一般需要做比较的逻辑都可以使用的上Comparator,最常用的场景就是排序和分组,排序常使用Arrays和Collections的sort方法,而分组则可以使用上面提供的dividerList方法。

排序和分组的区别在于: 
排序时,两个对象比较的结果有三种:大于,等于,小于。 
分组时,两个对象比较的结果只有两种:等于(两个对象属于同一组),不等于(两个对象属于不同组)

参考:https://www.cnblogs.com/skywang12345/p/3324788.html

参考:https://www.cnblogs.com/huaixiaonian/p/7508452.html

原文地址:https://www.cnblogs.com/lixuwu/p/8484102.html