java 记一次Comparator的踩坑经历

一、问题描述：Comparison method violates its general contract!报错

最近开发时遇到了一个坑，在使用Arrays.sort()时爆出了这样的错误

Comparison method violates its general contract!

而且是偶现的，抽象一下当时的代码是这样的：

//需要排序的对象结构
 class Node{
        private Integer num;

        public Integer getNum() {
            return num;
        }

        public void setNum(Integer num) {
            this.num = num;
        }
    }

//待排序列表
List<Node> list = new ArrayList();

//根据num排序
list.sort((a, b) -> {
        
        //a 为空把a放最后
        if(a == null){
             return -1;
          }

         //b 为空把b放最后
          if(b == null){
             return 1;
          }

         //比较 a和b的num值
        return a.num.compareTo(b.num);
 });

看着貌似很合理是吧，但是跑起来确实会报错，经过一顿操作猛如虎（一行一行debug）后发现当这个list存在两个空值时就出现歧义了，比如这个list

[object1,object2,null,null,object5]

当比较元素3和元素4时，会先走到第一个判断条件返回-1，认为元素3小

当比较元素4和元素3时，也会走到第一个判断条件返回-1，认为元素4小

这时就出现歧义了，比较器蒙圈了并不知道到底应该是元素3大于元素4还是元素4大于元素3，这也就是违背了排序的自反性所以抛出了异常

二、解决方案

解决起来也非常简单直接上代码

  list.sort((a, b) -> {
            if(a == null){
                //保证排序的自反性
                if (b == null) {
                    return 0;
                }
                return -1;
            }
            if(b == null){
                return 1;
            }
            return a.num.compareTo(b.num);
        });

像这样在第一个判断条件中加个判断b元素就可以完美解决了，再比较两个null值无论是正着比较还是反着比较都是没问题的

三、jdk1.7之后Comparator 要满足的三大特性

最后补下知识点

在 JDK 7 版本以上， Comparator 要满足自反性，传递性，对称性，不然 Arrays.sort() ，
Collections.sort() 会报 IllegalArgumentException 异常。

1 ） 自反性： x ， y 的比较结果和 y ， x 的比较结果相反。
2 ） 传递性： x > y , y > z ,则 x > z 。
3 ） 对称性： x = y ,则 x , z 比较结果和 y ， z 比较结果相同。