实现 Comparable 接口完成排序

1. 写在前面

之前看了一下实现 Iterable 接口,自己手写了一个 ReverseList 集合类,最终可以反向遍历这个 集合类。
然后就让我想到了 Comparable 接口,这里看一下如何通过实现,从而完成排序。


2. Comparable 接口实现

一些基本的类型,可以直接调用 Arrays.sort() / Collections.sort() 来完成,但是对于自己写的一些类,编译器实际上是不知道根据什么规则来对其排序的。
因此,如果自己的类需要直接进行排序,则需要告诉编译器如何进行排序。

这里有两种实现方式:

  • 类和排序放在一起,即类实现Comparable 接口
  • 类和排序分开,即重新编写一个 xxxComparator 来实现 Comparator 接口

直接上代码,这里完成一个对 Student 类 的排序,分别使用两种方法。

/**
 * 实现了 Comparable 的 Student 类
 * @author mikeshine
 */
@Data
public class Student implements Comparable<Student>{

    private Integer age;
    private String name;
    private Double height;

    public Student(Integer age, String name, Double height){
        this.age = age;
        this.name = name;
        this.height = height;
    }

    /**
     * 这里是需要重写的 compareTo() 方法
     * 这个方法规定比较的规则
     * @param student
     * @return
     */
    @Override
    public int compareTo(Student student) {
        return (int)(this.age - student.getAge());
    }
}

/**
 * 实现了 Comparator 的 Student 比较器
 * @author mikeshine
 * @date 2022-01-10
 */
public class StudentComparator implements Comparator<Student> {
    @Override
    public int compare(Student o1, Student o2) {
        return (int)(o1.getHeight()-o2.getHeight());
    }
}

两种方式在调用时候有一些区别,后者需要作为参数传入,前者直接调用即可。

 public static void main(String[] args) {
        Student ming = new Student(12,"ming",168.00);
        Student hong = new Student(13,"hong",167.00);
        Student xing = new Student(14,"xing",165.00);
        List<Student> students = new ArrayList<>(Arrays.asList(ming,hong,xing));
        // 按照Student类中的规则,即按照age 的升序
        Collections.sort(students);
        // 按照StudentComparator 类中的规则,即按照 height 的升序
        Collections.sort(students, new StudentComparator());
    }

除了上述两种调用方式之外,更为常用的用法是通过 stream().sorted()方法来调用,这种调用方式对于后者的实现更加便捷,通过 lambda 表达式即可实现。
代码如下

 public static void main(String[] args) {
        Student ming = new Student(12,"ming",168.00);
        Student hong = new Student(13,"hong",167.00);
        Student xing = new Student(14,"xing",165.00);
        List<Student> students = new ArrayList<>(Arrays.asList(ming,hong,xing));
        // 通过 Student 类中的规则
        List<Student> sortedStudents = students.stream().sorted(Comparator.comparing(Student::getHeight)).collect(Collectors.toList());
        // 通过自己编写的规则,height 升序
        List<Student> defaultSortedStudents = students.stream().sorted((t1,t2)-> (int)(t1.getHeight()- t2.getHeight())).collect(Collectors.toList());;
    }

3. 重写 equals() & hasCode() 方法

为什么把这一部分放到这里来看呢,因为事实上 equals() 也是一种比较,不过只是来比较是否相等,并不比较大小。

3.1 为什么要重写 equals() 方法

同上面说的重写 comparator() 方法 一样,你自己写的类,也需要知道如何判断 equals()相等与否,我们需要告诉编译器一种标准。
一般来说,重写 equals() 方法按照如下的步骤进行:

  • 对于 null,返回 false
  • 对于 非本类,返回 false
  • 对于 自身,返回 true
  • 写比较标准
/**
 * 重写 equals & hashCode 的类
 * @author mikeshine
 * @date 2021-01-10
 */
@Data
public class Employee {

    private int id;
    private String firstName;
    private String lastName;
    private String department;

    /**
     * 这里需要规定一下该类的 equals 方法的具体比较规则
     * @param obj
     * @return
     */
    @Override
    public boolean equals(Object obj) {
        if(obj==null){
            return false;
        }
        if(!(obj instanceof Employee)){
            return false;
        }
        if(this == obj){
            return true;
        }
        Employee employee = (Employee)obj;
        return (this.getId().equals(employee.getId()));
    }
}

3.2 为什么要写 hashCode() 方法

貌似只要有 equals() 方法就行了,但是看下面一个 case

        Employee em1 = new Employee();
        Employee em2 = new Employee();

        em1.setId(100);
        em2.setId(100);
        System.out.println(em1.equals(em2));

        Set set = new HashSet<>();
        set.add(em1);
        set.add(em2);
        System.out.println(set);

那么可以看到,这里的 haseSet 中,是有两个元素的,但是这两个元素其实是 equal 的,即一个对象
问题原因
java 中有如下的要求:

  • equals 的对象, hash 值必须相同
  • hash 相同的时候,equals 不必为 true。 hash碰撞 的 case

为什么有这样奇怪的要求
事实上,这样是为了快速判断对象是否相同。

// hashMap 中插入时做的判断
if (p.hash == hash &&
               ((k = p.key) == key || (key != null && key.equals(k))))

从上面来看,这里判断首先判断插入对象和已有对象的 hashCode是否相等,如果相等,则再去看 对象是否 equals;如果不想等,则直接结束判断。

因为 equals 的对象,hash 值一定是相同的。

回头看上面的例子,正是因为没有写 hashCod() 方法,因此两个 Employee 对象的 hash 值不同,所以就和插入进去了。

如何重写 hashCode()

这里其实没有一种标准的写法,其核心诉求是,返回与变量相关的 独一无二 的 hash 值。
这里看一个case。通用的写法是,根据一些经典的素数来搞。变量是 String等包装类,则直接掉用其本身的 hash(),否则直接将该变量加入。

@override
public int hashCode(){
      // 先定义一个 hash 值
      int hash = 17;
      // 根据比较变量(用在equals 中的)加入hash值
      hash = hash * 31 + getId();
      hash = hash * 31 + getName.hash();
      return hash;
}
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,658评论 6 496
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,482评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,213评论 0 350
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,395评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,487评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,523评论 1 293
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,525评论 3 414
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,300评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,753评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,048评论 2 330
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,223评论 1 343
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,905评论 5 338
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,541评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,168评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,417评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,094评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,088评论 2 352