第54条:返回零长度的数组或者集合,而不是null
当方法返回一个数组或集合时,如果没有找到任何元素(即结果为空),应该返回一个零长度的数组或空集合,而不是返回 null。
为什么避免返回 null?
方法如果可以返回null,那么调用方需要进行检测,忘记检测会造成很常见的空指针错误。
java
List<Cheese> cheeses = shop.getCheeses();
if (cheeses != null && cheeses.contains(Cheese.STILTON)) {
System.out.println("Jolly good, just the thing.");
}
不同情况下null的影响:
-
增强 for 循环:null 会直接抛异常,而空集合会正常跳过。
-
Stream API:null 无法直接调用 .stream(),而空集合可以。
-
Optional:即使使用 Optional,Optional.of(emptyList) 也比 Optional.ofNullable(null) 更清晰。
当然,你无法保证第三方一定不会返回null,所以一般调用第三方接口时,都会防御性的判断是否为空。
正确做法
一般情况,返回一个零长度的集合:
java
public List<String> getNames() {
if (noNames) {
return Collections.emptyList(); // 不可变空列表
}
return new ArrayList<>(names);
}
java
// The right way to return a possibly empty array
public Cheese[] getCheeses() {
return cheesesInStock.toArray(new Cheese[0]);
}
相对于返回null,零数组的创建会消耗性能。
可以进行优化,返回Collections.emptyList(),这种纳秒级别优化,几乎用不到,为了节省一次 new ArrayList<>() 而引入特殊判断逻辑(isEmpty() ? emptyList() : new ArrayList<>(...))反而使代码更复杂、可读性下降,书中的原则一直是:首先写清晰正确的代码,只在必要时优化。
java
// Optimization - avoids allocating empty collections
public List<Cheese> getCheeses() {
return cheesesInStock.isEmpty() ? Collections.emptyList() : new ArrayList<>(cheesesInStock);
}
利用 Collections.emptyList() 返回一个不可变的空列表,多次调用返回的是同一个对象,避免了重复分配的开销。如果返回 Set 则使用 Collections.emptySet(),返回 Map 则使用 Collections.emptyMap()。
注意:
java
// √
cheesesInStock.toArray(new Cheese[0])
// ×
cheesesInStock.toArray(new Cheese[cheesesInStock.size()]);
不要为其预设大小,这种做法反而会损害性能,适得其反。
总结
永远不要返回 null,而应该返回一个零长度的数组或者集合。如果返回 null,那么会使 API 更难使用,也更容易出错,而且没有任何性能优势。