Comparable 接口：用于定义对象的自然排序顺序

Comparable 接口位于 java.lang 包中，它是一个泛型接口，其定义为 interface Comparable<T>。该接口包含一个方法 compareTo(T o)，此方法用于定义对象的自然排序顺序。实现了 Comparable 接口的类的对象可以通过 compareTo 方法进行比较，以确定它们在某种排序规则下的相对顺序。

在 Java 中，许多集合类（如 Arrays.sort() 方法和 Collections.sort() 方法）依赖于元素实现 Comparable接口，以便对元素进行排序。通过实现 Comparable 接口，类的对象可以方便地参与到 Java 标准库的排序操作中。

实现 Comparable 接口的步骤和示例

步骤一：实现 Comparable 接口

首先，在自定义类中声明实现 Comparable 接口，并指定类型参数为当前类。例如，我们创建一个简单的Student 类来演示：

class Student implements Comparable<Student> {
    private String name;
    private int age;
    
    public Student(String name, int age) {
        this.name = name;
        this.age = age;
    }
    
    // 省略getter和setter方法
}

步骤二：重写 compareTo 方法

在 compareTo 方法中，根据自定义的排序规则，返回一个整数值。

• 如果当前对象小于传入的对象，返回一个负数。

• 如果当前对象等于传入的对象，返回 0。

• 如果当前对象大于传入的对象，返回一个正数。

public class Student implements Comparable<Student> {
    
    //...其他代码同步骤一
    @Override
    public int compareTo(Student other) {
        // 按年龄升序排序
        return this.age - other.age;
    }
    
}

完整的 Student 类，代码如下：

package com.hxstrive.java_lang.comparable;

/**
 * Comparable 接口示例
 * @author hxstrive
 */
public class Student implements Comparable<Student> {
    private String name;
    private int age;
    
    public Student(String name, int age) {
        this.name = name;
        this.age = age;
    }

    @Override
    public int compareTo(Student o) {
        // 按年龄升序排序
        return this.age - o.age;
    }

    // 省略getter和setter方法

    @Override
    public String toString() {
        return "Student{" +
                "name='" + name + '\'' +
                ", age=" + age +
                '}';
    }
}

步骤三：使用排序功能

可以使用 Java 标准库的排序方法，如 Arrays.sort() 或 Collections.sort()，对存储 Student 对象的数组或集合进行排序。

package com.hxstrive.java_lang.comparable;

import java.util.Arrays;

/**
 * Comparable 示例
 * @author hxstrive
 */
public class ComparableDemo {
    
    public static void main(String[] args) {
        // 准备数据
        Student[] students = new Student[]{
            new Student("Alice", 22),
            new Student("Bob", 20),
            new Student("Charlie", 25)
        };

        // 根据年龄排序
        Arrays.sort(students);

        // 打印排序结果
        for (Student student : students) {
            System.out.println(student);
        }
    }
    
}

运行结果：

在上述示例中，Student 类实现了 Comparable<Student> 接口，并重写了 compareTo 方法，按照年龄对 Student 对象进行升序排序。当调用 Arrays.sort(students) 时，会根据 compareTo 方法的逻辑对Student 对象数组进行排序。

不同排序规则的实现示例

按姓名长度排序

代码如下：

public class Student implements Comparable<Student> {
    
    //...其他代码同前面的Student类
    
    @Override
    public int compareTo(Student other) {
        // 看这里
        return this.name.length() - other.name.length();
    }
    
}

在这个例子中，compareTo方法根据学生姓名的长度进行比较，按照姓名长度的升序对学生进行排序。

按姓名字典序排序

代码如下：

class Student implements Comparable<Student> {
    
    //...其他代码同前面的Student类
    
    @Override
    public int compareTo(Student other) {
        // 看这里
        return this.name.compareTo(other.name);
    }
    
}

这里使用String类的compareTo方法，根据学生姓名的字典序对学生进行排序。

⚠️注意事项

• 一致性：对于任意的x和y，x.compareTo(y)的多次调用应该产生相同的结果，除非在比较之间修改了x或y的内部状态。

• 传递性：如果x.compareTo(y) > 0且y.compareTo(z) > 0，那么x.compareTo(z) > 0。

• 对称性：对于任意的x和y，x.compareTo(y)和y.compareTo(x)的结果应该大小相等但符号相反。

• 自反性：对于任意的x，x.compareTo(x)应该等于 0。

总结：Comparable 接口是 Java 中实现对象排序的基础，通过重写 compareTo 方法，可以为自定义类定义排序规则，从而让自定义类的对象能方便地参与到 Java 集合框架的排序操作中。