Collections.sort()报Comparison method violates its general contract异常问题解决

背景

记录下之前调用Collections.sort()造成App Crash的例子。业务原因，需要在主App中的文件进行排序，排序的规则是按照最近的修改时间升序排序，然后删除修改时间较小的文件列表，实现简单的清缓存功能。但是简单的实现后，注解抛出一个java.lang.IllegalArgumentException:Comparison method violates its general contract!。

哈哈 让我们一起摇摆！

分析问题

问题代码如下：

 Collections.sort(child, new Comparator<File>() {
        @Override
        public int compare(File lFile, File rFile) {
            Long lModified = lFile.lastModified();
            Long rModified = rFile.lastModified();
            return lModified.compareTo(rModified);
        }
    });
复制代码

是不是乍一看，觉得代码写的丝毫问题都没有，是的，刚开始我也是这么觉得。但是这篇文章你接着往下看，就知道哪里出了问题了。

说到Collections.sort()和java.lang.IllegalArgumentException:Comparison method violates its general contract！这个崩溃，相信大家都已经百度过大概因为什么原因了。没错，Collections.sort()在JDK6和JDK7中实现的底层排序算法变了，在JDK6中使用的时MergeSort排序，而在JDK7中使用的是TimSort。里面具体的算法自行百度吧,我是实在没看懂里面咋实现的，但是这个传说中的TimSort排序算法对比较大小的要求更高了：

比较器Comparator要求：

1 sgn(compare(x, y)) == -sgn(compare(y, x))
2 ((compare(x, y)>0) && (compare(y, z)>0))
3 如果compare(x, y)==0 那么sgn(compare(x, z))==sgn(compare(y, z))
复制代码

举个例子，比如有下面的代码：

 Collections.sort(child, new Comparator<Integer>() {
        @Override
        public int compare(Integer l, Integer r) {
            return l > r ? 1 : -1;
        }
    });
复制代码

恭喜你，crash了。 为什么呢，因为这里面就违反了自反性第一个规则，比如l的值是1，r的值也是1，那么compare(l,r)和compare(r,l)的结果是不一样的，于是TimSort就会检测到这种异常，就GG了。

但是！但是！

前面说的这段代码：

 Collections.sort(child, new Comparator<File>() {
        @Override
        public int compare(File lFile, File rFile) {
            Long lModified = lFile.lastModified();
            Long rModified = rFile.lastModified();
            return lModified.compareTo(rModified);
        }
    });
复制代码

有什么问题呢？调用的都是SDK内部实现的compareTo，其实吧，这里面确实是没有问题的，但是这里面忽视了一种情况：

File为null的情况！

File为null的情况！

File为null的情况！

那么你就会说，我可以保证这里面的File文件都是非空的啊，我的代码可以保证啊，而且也没有报NullPointException异常呀，为什么要考虑File为null的情况呢。

因为原因很简单，JVM并不知道.就是这么简单粗暴，因为JVM对你的代码是无感知的，它无法感知File文件是否一定非空，所以JVM就会在假设File为null的时候，无法判定比较的正确性，然后抛出异常出来。

解决问题

知道原因，那么解决方法就是对File为null或File不存在的情况进行下兼容处理，处理后的代码如下：

    Collections.sort(child, new Comparator<File>() {
        @Override
        public int compare(File lFile, File rFile) {
            boolean lInValid = (lFile == null || !lFile.exists());
            boolean rInValid = (rFile == null || !rFile.exists());
            boolean bothInValid = lInValid && rInValid;
            if (bothInValid) {
                return 0;
            }

            if (lInValid) {
                return -1;
            }

            if (rInValid) {
                return 1;
            }

            Long lModified = lFile.lastModified();
            Long rModified = rFile.lastModified();
            return lModified.compareTo(rModified);
        }
    });
复制代码

然后问题完美解决。

总结

java.lang.IllegalArgumentException:Comparison method violates its general contract!这个异常确实很坑，在使用Collections.sort排序时，很容易抛异常，所以只能在写里面排序逻辑的时候，小心小心再小心，如果可能的话， 最好使用SDK内部实现的compareTo方法，这样会少很多坑。

转载请标明来源，我的公众号：哈希同学

转载于:https://juejin.im/post/5bcddd7ee51d457a9766197f