如何简化null安全的compareTo()实现？

有关使用Guava的更新(2013)解决方案,请参阅本答案的底部.

这就是我最终的目标.事实证明我们已经有了一个用于null安全字符串比较的实用方法,所以最简单的解决方案就是利用它.(这是一个很大的代码库;容易错过这种事:)

public int compareTo(Metadata other) {
    int result = StringUtils.compare(this.getName(), other.getName(), true);
    if (result != 0) {
        return result;
    }
    return StringUtils.compare(this.getValue(), other.getValue(), true);
}

这就是帮助器的定义方式(它是重载的,这样你也可以定义空值是第一个还是最后一个,如果你愿意的话):

public static int compare(String s1, String s2, boolean ignoreCase) { ... }

因此,这与Eddie的答案(尽管我不会将静态辅助方法称为比较器)和uzhin 的答案基本相同.

无论如何,总的来说,我会强烈支持Patrick的解决方案,因为我认为尽可能使用已建立的库是一种很好的做法.(知道并使用 Josh Bloch所说的库.)但在这种情况下,不会产生最干净,最简单的代码.

编辑(2009):Apache Commons Collections版本

实际上,这是一种使基于Apache Commons的解决方案NullComparator更简单的方法.将它与类中提供的不区分大小写相Comparator结合String:

public static final Comparator NULL_SAFE_COMPARATOR 
    = new NullComparator(String.CASE_INSENSITIVE_ORDER);

@Override
public int compareTo(Metadata other) {
    int result = NULL_SAFE_COMPARATOR.compare(this.name, other.name);
    if (result != 0) {
        return result;
    }
    return NULL_SAFE_COMPARATOR.compare(this.value, other.value);
}

我觉得现在这很优雅.(只剩下一个小问题:Commons NullComparator不支持泛型,所以有一个未经检查的任务.)

更新(2013年):番石榴版

差不多5年后,这就是我如何处理我原来的问题.如果用Java编码,我(当然)会使用Guava.(当然不是 Apache Commons.)

把它保持在某个地方,例如在"StringUtils"类中:

public static final Ordering CASE_INSENSITIVE_NULL_SAFE_ORDER =
    Ordering.from(String.CASE_INSENSITIVE_ORDER).nullsLast(); // or nullsFirst()

然后,在public class Metadata implements Comparable:

@Override
public int compareTo(Metadata other) {
    int result = CASE_INSENSITIVE_NULL_SAFE_ORDER.compare(this.name, other.name);
    if (result != 0) {
        return result;
    }
    return CASE_INSENSITIVE_NULL_SAFE_ORDER.compare(this.value, other.value);
}    

当然,这几乎与Apache Commons版本(都使用JDK的CASE_INSENSITIVE_ORDER)完全相同,使用的nullsLast()是唯一的Guava特定的东西.这个版本更可取,因为Guava是Commons Collections的优先选择.(正如大家都同意的那样.)

如果你想知道Ordering,请注意它实现Comparator.它非常方便,特别是对于更复杂的排序需求,例如,您可以使用链接连接多个订单compound().阅读订购说明了解更多!

我总是建议使用Apache commons,因为它很可能比你自己编写的更好.此外,您可以做"真正的"工作,而不是重新发明.

您感兴趣的课程是Null Comparator.它允许您使空值高或低.当两个值不为空时,您还可以使用自己的比较器.

在你的情况下,你可以有一个静态成员变量进行比较,然后你的compareTo方法只引用它.

有点像

class Metadata implements Comparable {
private String name;
private String value;

static NullComparator nullAndCaseInsensitveComparator = new NullComparator(
        new Comparator() {

            @Override
            public int compare(String o1, String o2) {
                // inputs can't be null
                return o1.compareToIgnoreCase(o2);
            }

        });

@Override
public int compareTo(Metadata other) {
    if (other == null) {
        return 1;
    }
    int res = nullAndCaseInsensitveComparator.compare(name, other.name);
    if (res != 0)
        return res;

    return nullAndCaseInsensitveComparator.compare(value, other.value);
}

}

即使你决定自己动手,也要记住这个类,因为它在订购包含null元素的列表时非常有用.

我知道它可能不是直接回答你的问题,因为你说必须支持空值.

但我只想指出,在compareTo中支持空值与在Comparable的官方javadoc中描述的compareTo契约不一致:

请注意,null不是任何类的实例,并且即使e.equals(null)返回false,e.compareTo(null)也应抛出NullPointerException.

所以我要么显式地抛出NullPointerException,要么只是在取消引用null参数时抛出它.