Java 空集合使用場景及填坑

擁抱心中的夢想發表於2019-02-26
Java

今天學學Java中如何建立一個空集合以及空集合的一些使用場景和相關的坑。你可能會問，這好像沒有什麼好講的，空集合不就是new一個嘛，也就是像new ArrayList<String>()這樣建立一個不久行了嗎？其實這也是一種建立空集合的方法，但今天小編講下通過另外一種方式建立空集合，以及兩種方式之間的差異。

一、通過Collections.emptyList()建立空集合

Java集合工具類中提供了一系列建立集合的靜態方法，其中包括建立執行緒同步相關的Collections.synchronizedXXX()方法、空集合相關的Collections.emptyXXX()方法。通過這種方式建立的空集合，既然是空的，就不允許你往集合中新增元素和刪除元素，也就是不能呼叫相應add()和remove()方法，我先來看看Collections類建立空集合的部分原始碼：

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

......

public static final <T> List<T> emptyList() {
    return (List<T>) EMPTY_LIST;
}
複製程式碼

你會發現上面的emptyList()方法預設返回的是前面的靜態變數EMPTY_LIST,你可能會說，既然EMPTY_LIST是static的，那我直接通過Collections.EMPTY_LIST獲取不就好了，沒錯，這樣做也可以，只不過在某些需要泛型的場景下，呼叫emptyList()方法提供了相應的泛型支援。

那為什麼這種方式不能新增和移除元素呢？我們來看看EmptyList內部類是怎麼定義的：

// 繼承自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; }

    @Override
    public boolean removeIf(Predicate<? super E> filter) {
        Objects.requireNonNull(filter);
        return false;
    }
    @Override
    public void replaceAll(UnaryOperator<E> operator) {
        Objects.requireNonNull(operator);
    }
    @Override
    public void sort(Comparator<? super E> c) {}

    // Override default methods in Collection
    @Override
    public void forEach(Consumer<? super E> action) {
        Objects.requireNonNull(action);
    }

    @Override
    public Spliterator<E> spliterator() { return Spliterators.emptySpliterator(); }
    // Preserves singleton property
    private Object readResolve() {
        return EMPTY_LIST;
    }
}
複製程式碼

從上面的原始碼中我們可以發現EmptyList類並沒有重寫父類相應的add()或者remove()方法，那麼當呼叫空集合的add()方法時將預設呼叫AbstractList的add()方法，行，那麼我們來看看父類AbstractList的add()方法是怎麼實現的：

public void add(int index, E element) {
    throw new UnsupportedOperationException();
}
複製程式碼
public E remove(int index) {
    throw new UnsupportedOperationException();
}
複製程式碼

很遺憾，父類直接給你丟擲UnsupportedOperationException異常，所以，小編認為，通過Collections建立的空集合不能新增或刪除元素也是合情合理的，因為是空集合嘛，空，那為啥還要有新增刪除操作。下面說說這種方式的使用場景。

二、簡單使用場景

web開發中經常使用rest + json的技術組合來進行前後端互動，那麼當前端呼叫一個介面時，介面有可能需要返回一個空的集合給到前端，比如你根據某個條件查資料庫得不到資料時，那麼此時Collections.emptyXXX()就非常合適了，因為使用new ArrayList()的初始化還會佔用相關的資源。

為了說明呼叫add()方法會丟擲異常，下面寫個小測試：

public class RemoveIfTest {
    private static List<Object> list = Collections.emptyList();
    public static void main(String[] args) {
    	
    	list.add("one1");
    	list.add("one2");
    	list.add(1);
    	list.add(2);
    	list.add(new Object());
    	
    	System.err.println(Arrays.toString(list.toArray()));
    }
}
複製程式碼

程式輸出：

Exception in thread "main" java.lang.UnsupportedOperationException
    at java.util.AbstractList.add(Unknown Source)
    at java.util.AbstractList.add(Unknown Source)
    at com.example.RemoveIfTest.main(RemoveIfTest.java:17)
複製程式碼

三、總結

總的來說，對於如何建立空集合的問題我們不需要糾結，重要的我們要記住通過Collections.emptyXXX()建立的空集合不能執行新增刪除操作以及其中的原理，避免以後犯錯，不過其實即使你使用錯了，除錯幾遍你的程式碼估計也就會把問題發現出來，只不過這篇文章能幫你省去這個發現bug的過程啦！

相關文章