通用方法——考虑实现Comparable

╰+哭是因爲堅強的太久メ 2024-03-25 09:42 60阅读 0赞

### 前言 ###

如果自实现的类涉及到内在排序，譬如按字母排序或数字排序或日期排序的，强烈建议实现Comparable接口。

实现了Comparable接口的类，可以和许多的泛型算法以及集合进行协作。譬如，列表或数组中的元素实现了Comparable接口，则排序时可以直接调用Collections.sort(list)或Arrays.sort(array)得到结果。

--------------------

### 通用约定 ###

JDK8文档1中这样描述Comparable接口的规定：  
将一个对象和指定的对象比较排序，返回负数、零和正数分别表示小于、等于和大于指定的对象。如果两个比较的对象之间类型不同，则抛出ClassCastException。

注意事项, 既然实现 Comparable , 最好让他的结果符合大家的默认约定

1.  a = b 则 b = a ( 即 a.compareTo(b) == 0 则 b.compareTo(a) == 0)
2.  a.compareTo(b) 发生异常时, b.compareTo(a) 也应该是相同的异常
3.  a < b 则 b > a
4.  强烈推荐，但不是必须要求。当`x.compareTo(y) == 0`时，`x.equals(y)`返回`true`。
5.  如果你的类实现了 Comparable ,那么最好以后比较的时候就用默认的 compareTo 去做, 而不要调用 Collections.sort(list,Comparable) 类似的api(也就是不要去额外传参一个另外的 Comparable 去覆盖你的默认比较, 除非这里真的是特别特殊)

针对规则4，举个反例：

public class BigDecimalDemo {
    
      public static void main(String[] args) {
        BigDecimal bigDecimal1 = new BigDecimal("4.0");
        BigDecimal bigDecimal2 = new BigDecimal("4.00");
    
        //return 0
        System.out.println(bigDecimal1.compareTo(bigDecimal2));
        //return false
        System.out.println(bigDecimal1.equals(bigDecimal2));
      }
    
    }

--------------------

### 接口使用 ###

**`1、User`类**

@Getter
    @Setter
    public class User implements Comparable<User> {
      private String name;
      private int age;
      private int sex;
      private String phone;
    
      public User() {
      }
    
      public User(String name, int age, int sex, String phone) {
        this.name = name;
        this.age = age;
        this.sex = sex;
        this.phone = phone;
      }
    
      //Getter & Setter
    
      @Override
      public int compareTo(User o) {
        //先比较名字
        int nameCompare = name.compareTo(o.getName());
        if (0 != nameCompare) {
          return nameCompare;
        }
    
        //后比较年龄
        if (age != o.getAge()) {
          return age - o.getAge();
        }
    
        return 0;
      }
    
      @Override
      public String toString() {
        return "User{" +
            "name='" + name + '\'' +
            ", age=" + age +
            ", sex=" + sex +
            ", phone='" + phone + '\'' +
            '}';
      }
    }

2、`UserCompareDemo`类

public class UserCompareDemo {
      
      public static void main(String[] args) {
        List<User> users = new ArrayList();
        users.add(new User("acd", 11, 0, "12345678901"));
        users.add(new User("abc", 10, 0, "12345678901"));
        Collections.sort(users);
        System.out.println(users);
      }
      
    }

输出结果

> \[User\{name='abc', age=10, sex=0, phone='12345678901'\}, User\{name='acd', age=11, sex=0, phone='12345678901'\}\]