Collections.emptyList() 与新实例答案

【问题标题】：Collections.emptyList() vs. new instanceCollections.emptyList() 与新实例
【发布时间】：2011-07-29 23:08:44
【问题描述】：

实际上，返回一个空列表是否更好，例如this：

return Collections.emptyList();

或者喜欢this:

return new ArrayList<Foo>();

或者这完全取决于您要如何处理返回的列表？

【问题讨论】：

标签： java collections empty-list

【解决方案1】：

Collections.emptyList 是不可变的，因此两个版本之间存在差异，因此您必须考虑返回值的用户。

返回new ArrayList<Foo> 总是会创建一个对象的新实例，因此它会产生非常小的额外成本，这可能会让您有理由使用Collections.emptyList。我喜欢使用emptyList 只是因为它更具可读性。

【讨论】：

【解决方案2】：

主要区别在于Collections.emptyList() 返回一个不可变 列表，即不能向其中添加元素的列表。（同样适用于 Java 9 中引入的List.of()。）

在您确实想要修改返回列表的极少数情况下，Collections.emptyList() 和 List.of() 因此不是一个好的选择。

我想说，只要合同（文档）没有明确说明不同，返回一个不可变列表是完全可以的（甚至是首选方式）。

另外，emptyList()might not create a new object with each call.

此方法的实现不需要为每个调用创建一个单独的 List 对象。使用这种方法的成本可能与使用同名字段的成本相当。（与此方法不同，该字段不提供类型安全。）

emptyList 的实现如下：

public static final <T> List<T> emptyList() {
    return (List<T>) EMPTY_LIST;
}

因此，如果您的方法（返回一个空列表）被频繁调用，这种方法甚至可以在 CPU 和内存方面为您提供稍微更好的性能。

【讨论】：

那么，Collections.emptyList() 是否更适合比如说错误检查之类的？
API 客户端不会通过返回Collections.emptyList() 而不是null 来获得NullPointerException。
@PK_J 提出了一个重要的观点。 Collections.emptyList() 是可迭代的并返回一个长度，因此它可以在 for 循环中使用而不会引发异常。
用List.of()怎么样？
@AJW，是的。但与new ArrayList<>() 相比，它也使设计决策更加清晰；元素不会添加到此列表中。

【解决方案3】：

如果返回的列表没有被以任何方式修改（因为列表是不可变的），我会选择 Collections.emptyList()，否则我会选择选项 2。

Collections.emptyList() 的好处是每次都返回相同的静态实例，因此每次调用都不会创建实例。

【讨论】：

【解决方案4】：

从 Java 5.0 开始，您可以指定容器中元素的类型：

Collections.<Foo>emptyList()

我同意其他回复，对于想要返回空列表但仍为空的情况，您应该使用这种方法。

【讨论】：

从Java 7开始，可以让编译器从目标类型推断泛型方法调用的类型参数：List<Foo> list = Collections.emptyList()

【解决方案5】：

如果您想确保返回的列表永远不会被修改，请使用Collections.emptyList()。

这是调用emptyList()时返回的内容：

/**
 * The empty list (immutable). 
 */
public static final List EMPTY_LIST = new EmptyList();

【讨论】：

我来到这里是想了解拨打Collections.emptyList() 是否有建设成本。查看实现细节（尽管在所有 JVM 上可能不一样）确认它没有。 @Atul，这是来自哪个 JVM？

【解决方案6】：

给定的答案强调emptyList() 返回一个不可变的List 但不提供替代方案。构造函数ArrayList(int initialCapacity) 特殊情况0 所以返回new ArrayList<>(0) 而不是new ArrayList<>() 也可能是一个可行的解决方案：

/**
 * Shared empty array instance used for empty instances.
 */
private static final Object[] EMPTY_ELEMENTDATA = {};

[...]

/**
 * Constructs an empty list with the specified initial capacity.
 *
 * @param  initialCapacity  the initial capacity of the list
 * @throws IllegalArgumentException if the specified initial capacity
 *         is negative
 */
public ArrayList(int initialCapacity) {
    if (initialCapacity > 0) {
        this.elementData = new Object[initialCapacity];
    } else if (initialCapacity == 0) {
        this.elementData = EMPTY_ELEMENTDATA;
    } else {
        throw new IllegalArgumentException("Illegal Capacity: "+
                                           initialCapacity);
    }
}

（来自 Java 1.8.0_72）

【讨论】：

我不同意你的做法。您在初始化时节省了一些内存和 CPU，但是如果您返回的列表曾经被修改过，那么当列表重新分配一个新数组时，您就会失去那个时间。如果随着时间的推移将大量元素添加到列表中，这可能会因the much slower growth rate 而堆积成更多的性能瓶颈。我更喜欢坚持不可修改的空列表或可用的可修改列表的约定。
当我试图用我的措辞强调时（可能是可行的）：这完全取决于你的用例。我通常会要么返回可变的或不可变的集合，而不是混合，这取决于它们是否为空。为了反驳“慢得多的说法”：this 是当前的实现。
哦，伙计，看看我引用的 JDK 2 主要版本已过时。所以java8通过从初始大小0跳到默认容量来完全避免瓶颈。对不起，我错了。

【解决方案7】：

不过要小心。如果您返回Collections.emptyList()，然后尝试对其进行一些更改，例如add() 或类似的东西，您将拥有UnsupportedOperationException()，因为Collections.emptyList() 返回一个不可变对象。

【讨论】：