Java中Collections.emptyList()的註意事項

Posted on by

偶然發現有小夥伴錯誤地使用瞭Collections.emptyList()方法，這裡記錄一下。她的使用方式是：

public void run() {
  ......
  List list = buildList(param);
  ......
  Object newNode = getNode(...);
  list.add(newNode);
  ......
}
 
public List buildList(Object param) {
  if (isInValid(param)) {
    return Collections.emptyList();
  } else {
    ......
  }
}

buildList方法中可能會返回一個”空的List”，後續還可能往這個List添加元素（或者移除元素），但是沒有註意Collections.emptyList方法返回的是一個EMPTY_LIST：

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

它是一個static final修飾的成員變量，是一個EmptyList類的實例：

public static final List EMPTY_LIST = new EmptyList<>();

這個EmptyList是一個靜態內部類，和ArrayList一樣繼承自AbstractList：

private static class EmptyList<E>
    extends AbstractList<E>
    implements RandomAccess, Serializable {
    private static final long serialVersionUID = 8842843931221139166L;
 
    public Iterator<E> iterator() {
      return emptyIterator();
    }
    public ListIterator<E> listIterator() {
      return emptyListIterator();
    }
 
    public int size() {return 0;}
    public boolean isEmpty() {return true;}
 
    public boolean contains(Object obj) {return false;}
    public boolean containsAll(Collection<?> c) { return c.isEmpty(); }
 
    public Object[] toArray() { return new Object[0]; }
 
    public <T> T[] toArray(T[] a) {
      if (a.length > 0)
        a[0] = null;
      return a;
    }
 
    public E get(int index) {
      throw new IndexOutOfBoundsException("Index: "+index);
    }
 
    public boolean equals(Object o) {
      return (o instanceof List) && ((List<?>)o).isEmpty();
    }
 
    public int hashCode() { return 1; }
 
    // Preserves singleton property
    private Object readResolve() {
      return EMPTY_LIST;
    }
  }

可以看到這個EmptList沒有重寫add方法，並且get方法也是直接拋出一個IndexOutOfBoundsException異常。既然沒有重寫add方法，那麼看看父類AbstractList中的add方法：

public boolean add(E e) {
  add(size(), e);
  return true;
}
 
public void add(int index, E element) {
  throw new UnsupportedOperationException();
}

可以看到直接拋出的UnsupportedOperationException異常。再回到EmptyList類中，它對外提供的一些方法也很明顯地限制瞭它的使用范圍。

對於Collections.emptyList()，或者說Collections.EMPTY_LIST，最好隻把它當做一個空列表的標識（可以想象成一個frozen過的空List），不要對其做一些增刪改查的操作。如果程序中的一些分支邏輯返回瞭這種實例，測試的時候又沒有覆蓋到，在生產環境如果走到瞭這個分支邏輯，那就麻煩瞭~

總結

到此這篇關於Java中Collections.emptyList()註意事項的文章就介紹到這瞭,更多相關Java Collections.emptyList()註意內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：