java - 如何判断一个Java集合是否包含 `null`

Question

我想写一个以集合为参数的方法。但是，该集合不能包含 null。如果它包含 null，这将导致稍后出现 NullPointerException，此时不再清楚 null 的来源。因此，我想验证输入。天真的方法是:

public void doSomething(Collection<?> collection) {
    if (collection.contains(null))
        throw new IllegalArgumentException("collection cannot contain null!");

    // do something
}

但是，如果集合不支持 null 值，Collection.contains 可能会抛出 NullPointerException。事实上，Java 自己的不可变集合就是这样做的。因此，在天真的方法中，以下代码不起作用:

doSomething(List.of("a", "b", "c")); // NullPointerException!

有几种可能的解决方案，但没有一种感觉是正确的。

例如，我可以自己搜索null:

public void doSomething(Collection<?> collection) {
    for (var e : collection) {
        if (e == null)
            throw new IllegalArgumentException("collection cannot contain null!");
    }
    // do something
}

但现在我正在做一个线性搜索，虽然集合可能是一个 HashSet 或一个 TreeSet，提供更好的性能。

或者我可以捕获 NullPointerException:

public void doSomething(Collection<?> collection) {
    try {
        if (collection.contains(null))
            throw new IllegalArgumentException("collection cannot contain null!");
    } catch (NullPointerException e) {
        // Apparently, collection doesn't support null. This is good!
    }
    // do something
}

但是这样感觉很不安全。我真的可以确定 NullPointerException 是由不支持 null 的集合引起的，还是我只是吃了一个可以提供有关错误的有值(value)信息的异常？

有没有什么好的方法可以判断一个集合是否包含null？

Answer 1

我不认为用 IllegalArgumentException 替换 NullPointerException 是一种改进。它要求我们阅读消息以获取专用异常类型本质上告诉我们的信息。

当然，尽早检查传入的参数，以避免将问题的根源与发生异常的地方分离，是一件好事。当我使用时，例如

public static void main(String[] args) {
    new NullCheckExample().doSomething(Arrays.asList("foo", "bar", null));
}

public void doSomething(Collection<?> collection) {
    collection.forEach(Objects::requireNonNull);

    // do something
}

我明白了

Exception in thread "main" java.lang.NullPointerException
    at java.base/java.util.Objects.requireNonNull(Objects.java:208)
    at java.base/java.util.Arrays$ArrayList.forEach(Arrays.java:4204)
    at NullCheckExample.doSomething(NullCheckExample.java:12)
    at NullCheckExample.main(NullCheckExample.java:8)

我认为它具有足够的表现力，有助于追查原因。

现在，当 null 不可能时，有没有办法避免线性搜索的成本？理论上，是的。我们可以做到

public void doSomething(Collection<?> collection) {
    Spliterator<?> sp = collection.spliterator();
    if(sp.hasCharacteristics(Spliterator.NONNULL)) {
        // yeah, null is impossible
    }
    else if(sp.hasCharacteristics(Spliterator.SORTED) && sp.getComparator() == null) {
        // natural order precludes null too
    }
    else {
        // here we have to check,
        // collection.forEach(Objects::requireNonNull)
        // or 
        // if(collection.contains(null)) throw ...
    }

    // do something
}

这对某些集合有效，例如并发集合或 TreeSet。问题是，它不适用于 List.of(...) 或 Set.of(...) 类型的集合。在引用实现(OpenJDK)中，spliterator 方法没有被覆盖，这不仅意味着 Stream 操作效率较低，我们也没有得到 NONNULL 和 IMMUTABLE 特性。

所以在这些情况下，我们最终会进行不必要的线性搜索，或者不得不处理 contains(null) 抛出 NullPointerException(在常见情况下，而不是错误的情况)。

根据你想做什么，你可能会做类似的事情

public void doSomething(Collection<?> collection) {
    List<?> workingCopy = List.copyOf(collection);

    // do something
}

这包含复制操作，但确实可以保护您免受后续修改集合的影响，这可能无论如何都需要，以确保一致性。工作副本保证没有 null 并且不会更改。如果调用者将 List.of(...) 的结果传递给这个已经满足条件的方法，则 copyOf 将变成空操作，只返回参数.因此，当您希望输入在大多数情况下已经是不可变列表时，这是最佳选择。

但如果您要说这两者都不是令人满意的解决方案，我会同意。应该有有效的可能性来排除 null。拒绝查询 null 的尝试很好，但不应以无法有效确保不存在 null 告终。同样令人困惑的是，不可变集合没有高效的 spliterator() 和 forEach 实现，尽管它们的实现非常简单，在大多数情况下都是一行代码。