如果自实现的类涉及到内在排序,譬如按字母排序或数字排序或日期排序的,强烈建议实现Comparable
接口。
实现了Comparable
接口的类,可以和许多的泛型算法以及集合进行协作。譬如,列表或数组中的元素实现了Comparable
接口,则排序时可以直接调用Collections.sort(list)
或Arrays.sort(array)
得到结果。
通用约定
JDK8
文档1中这样描述Comparable
接口的规定:
将一个对象和指定的对象比较排序,返回负数、零和正数分别表示小于、等于和大于指定的对象。如果两个比较的对象之间类型不同,则抛出ClassCastException
。
假设sgn(expression)
表示signum
函数,仅返回-1、0和1。依据返回的结果:
1. 对应任何对象x
和y
,都有sgn(x.compareTo(y)) == -sgn(y.compareTo(x))
2. 对于任何对象x
、y
和z
,如果x.compareTo(y) > 0 && y.compareTo(z) > 0
,则x.compareTo(z) > 0
3. 对于任何对象x
、y
和z
,如果x.compareTo(y) == 0
,则sgn(x.compareTo(z)) == sgn(y.compareTo(z))
4. 强烈推荐,但不是必须要求。当x.compareTo(y) == 0
时,x.equals(y)
返回true
。
针对规则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));
}
}
接口使用
User
类
package indi.latch.effective;
/**
* Title: User
* Description:
*
* @author lin.xu
* @date 2018/5/2
*/
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 + '\'' +
'}';
}
}
UserCompareDemo
类
public class UserCompareDemo {
public static void main(String[] args) {
List<User> users = Lists.newArrayList(
new User("acd", 11, 0, "12345678901", null),
new User("abc", 10, 0, "12345678901", null)
);
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'}]