Collections.emptyList()与新实例


241

在实践中,是能够更好地返回一个空列表像这样

return Collections.emptyList();

或者像这样

return new ArrayList<Foo>();

还是这完全取决于您对返回列表的处理方式?

Answers:


300

主要区别是Collections.emptyList()返回一个不可变的列表,即无法向其添加元素的列表。(同样适用List.of()于Java 9中引入的内容。)

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

我想说,只要合同(文档)没有明确声明不同的状态,返回一个不可变的列表就很好(甚至是首选的方式)。


此外,emptyList() 可能不会在每次调用时创建一个新对象。

此方法的实现无需为每个调用创建单独的List对象。使用此方法与使用相同名称的字段相比可能具有可比的成本。(与这种方法不同,该字段不提供类型安全性。)

执行的emptyList外观如下:

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

因此,如果经常调用您的方法(返回一个空列表),则此方法甚至可以在CPU和内存方面为您提供更好的性能。


4
那么,是否Collections.emptyList()更适合进行错误检查之类的呢?
MRE

1
API客户端无法NullPointerException通过返回Collections.emptyList()而不是来获取null
realPK '16

@PK_J很重要。 Collections.emptyList()是可迭代的并返回长度,因此可以在for循环中使用它而不会引发异常。
ndm13

那使用List.of()呢?

4
@AJW,是的。但是new ArrayList<>()与之相比,它也使设计决策更加明确。元素不会添加到此列表中。
aioobe

51

从Java 5.0开始,您可以在容器中指定元素的类型:

Collections.<Foo>emptyList()

我同意其他答复,对于要返回一个空列表的情况,应该使用这种方法。


38
从Java 7开始,您可以让编译器从目标类型推断通用方法调用的类型参数:List<Foo> list = Collections.emptyList()
Paul Jackson

28

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

返回new ArrayList<Foo>总是创建该对象的一个​​新实例,因此与之相关的额外成本非常低,这可能使您有理由使用它Collections.emptyList。我喜欢使用emptyList它,因为它更具可读性。


14

不过要小心。如果返回Collections.emptyList(),然后尝试对它进行类似的更改,则add()u将有一个UnsupportedOperationException()因为Collections.emptyList()返回一个不可变的对象。


7

我会去Collections.emptyList(),如果返回的列表中没有被以任何方式修改(如列表是不可改变的),否则我会选择去2。

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


3

如果要确保从不修改返回的列表,请使用Collections.emptyList()。这是调用emptyList()时返回的内容:

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

我到达这里的目的是弄清楚打电话Collections.emptyList()是否要花建设费。看到实现细节(尽管在所有JVM上可能并不相同)可以确认事实并非如此。@Atul,这是哪个JVM?
wjl 2013年

2

给定的答案强调了一个事实,即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,但是如果返回的列表曾经被修改过,则在列表重新分配新数组时会浪费时间。如果随着时间的推移将很多元素添加到列表中,由于增长率要慢得多,这可能会成为更多的性能瓶颈。我更喜欢坚持不可修改的空列表或可用的,可修改的列表的约定。
Patrick M

1
当我尝试强调自己的措辞(可能是可行的)时:这一切都取决于您的用例。我通常返回可变不可变的集合,而不是混合的,取决于它们是否为空。为了应对“慢得多的要求”:是当前的实现。
勒内

哦,伙计,看着我引用了过时的JDK 2主要版本。因此,java8通过从初始大小0跃升到默认容量来完全避免了瓶颈。抱歉,我错了。
Patrick M
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.