Java集合概述篇——“上帝視角“全覽集合架構

概述

集合是Java中比較基礎的子產品，所有的集合類都處于

java.util

包下，其中支援多線程的集合類位于

java.util.concurrent

包下，有興趣的朋友可以去看看相關的源代碼。

本文嘗試以全局的角度，一窺Java集合架構的全貌；Java集合大緻上可分 3 個部分，分别為：

List

、

Set

、

Map

；文章會依次介紹三者各自的作用以及差別。

話不多說，

Let't Go！！！

疊代器Iterator

在開始介紹具體的容器之前，讓我們先來看看疊代器為何物。疊代器提供了一種周遊容器中元素的方式，也即是說：我們可以通過疊代器來周遊集合元素。

Iterator

疊代器接口定義了疊代器所應該具有的功能，具體源碼如下：

public interface Iterator<E> {
    /**
     * 判斷集合是否還有下一個元素
     * @return boolean
     */
    boolean hasNext();
    /**
     * 擷取下一個元素
     * @return E
     */
    E next();
    /**
     * Java8 提供的預設方法
     * 疊代的過程中不允許移除元素,會抛出操作不支援異常
     * @throws UnsupportedOperationException
     */
    default void remove() {
        throw new UnsupportedOperationException("remove");
    }
    /**
     * Java8 提供的預設方法
     */
    default void forEachRemaining(Consumer<? super E> action) {
        Objects.requireNonNull(action);
        while (hasNext())
            action.accept(next());
    }
}

           

疊代器

Iterator

接口定義了疊代器應具備的功能，其中

hasNext()

和

next()

方法由具體的容器來實作，疊代器隻能通過容器本身得到，每個容器都通過内部類實作了自己的疊代器，是以疊代器的使用方式如下：

@Test
    public void test(){
        List<Integer> list = new ArrayList<>(6);
        for (int i = 0; i < 6; i++) {
            list.add(i);
        }
        // 疊代器隻能通過容器本身得到 （PS：可能有些容器會實作一些疊代器的子接口，諸如ListIterator，隻是一些優化）
        Iterator<Integer> iterator = list.iterator();
        while (iterator.hasNext()) {
            System.out.println(iterator.next());
        }
    }
           

Collection

Collection

是一個接口，它是一個高度抽象出來的接口，定義了集合的基本操作： 添加、删除、清空、周遊、是否為空、擷取大小等方法。我們來看看

Collection

接口的類圖：

從圖中我們可以看出，

Collection

接口主要有 2 個子分支：

List

和

Set

，并且定義了

AbstractCollection

抽象類讓其他類繼承，

AbstractCollection

實作了

Collection

中的絕大部分方法；我們可以看出

AbstractList

和

AbstractSet

都繼承于

AbstractCollection

。

其次，我們看到

Collection

接口依賴于

Iterator

接口，（依賴關系：依賴就是一個類 A 使用到了另一個類 B，是以類 B 的變化會影響到類 A。比如某人要過河，需要借用一條船，此時人與船之間的關系就是依賴。表現在代碼層面，為類 B 作為參數被類 A 在某個method方法中使用。）

Collection

依賴于

Iterator

，展現在源碼中是

Collection

接口定義了方法

Iterator<E> iterator()

，用以傳回集合的疊代器來周遊集合。在

List

接口中，通過

listIterator()

方法傳回一個

ListIterator

對象；

ListIterator

接口是

List

特有的。

Collection

接口的所有子類（直接子類和間接子類）都必須實作 2 種構造函數：無參構造函數 和 參數為

Collection

的構造函數。帶參數的構造函數可以用來轉換

Collection

的類型。下面是

Collection

接口中定義的API(JDK1.8)：

public interface Collection<E> extends Iterable<E> {

    // 疊代器 每個容器都通過内部類實作了疊代器
    Iterator<E> iterator();

    // 添加元素
    boolean add(E e);
    // 批量添加元素
    boolean addAll(Collection<? extends E> c);

    // 移除元素
    boolean remove(Object o);
    // 批量删除元素
    boolean removeAll(Collection<?> c);

    // 是否包含元素o
    boolean contains(Object o);
    // 是否包含元素集
    boolean containsAll(Collection<?> c);

    // 保留元素
    boolean retainAll(Collection<?> c);

    // 擷取集合長度
    int size();
    // 集合是否為空
    boolean isEmpty();
    //轉換成數組
    <T> T[] toArray(T[] a);
    // 清空
    void clear();

    // equals方法
    boolean equals(Object o);
    // hashCode方法
    int hashCode();

    // java8 預設方法 轉換成數組
    default <T> T[] toArray(IntFunction<T[]> generator) {
        return toArray(generator.apply(0));
    }

    // java8 提供預設方法 滿足條件移除元素
    default boolean removeIf(Predicate<? super E> filter) {
        Objects.requireNonNull(filter);
        boolean removed = false;
        final Iterator<E> each = iterator();
        while (each.hasNext()) {
            if (filter.test(each.next())) {
                each.remove();
                removed = true;
            }
        }
        return removed;
    }


    // java8 提供的預設方法
    @Override
    default Spliterator<E> spliterator() {
        return Spliterators.spliterator(this, 0);
    }

    default Stream<E> stream() {
        return StreamSupport.stream(spliterator(), false);
    }

    default Stream<E> parallelStream() {
        return StreamSupport.stream(spliterator(), true);
    }
}

           

List

List

接口的定義如下：

public interface List<E> extends Collection<E> {
    //...
}
           

從

List

定義中可以看出，它繼承于

Collection

接口，即

List

是集合的一種。List是有序的隊列，可以存儲重複元素，

List

中的每一個元素都有一個索引，第一個元素的索引值為0，往後的元素的索引值依次 + 1，

List

中允許有重複的元素。

讓我們來看看

List

集合相關的類圖：

從類圖中我們看到，

List

接口繼承于

Collection

接口，并且于下有一個抽象類

AbstractList

以及後續的具體子類：

ArrayList

、

LinkedList

等。單純從這一條鍊路

List ----> AbstractList ----> ArrayList/LinkedList

來看，有一股 模闆方法模式 的味道，頂層接口定義好了具體行為，抽象類提供了可複用的 算法骨架，然後具體子類根據自己的特點自定義實作相關功能。

回到

List

上來，由于繼承了

Collection

接口，自然包含了其所有的API，但由于

List

是有序集合，是以它也有自己額外的API:

從圖中我們可以看出，

List

接口新增的API主要有：擷取元素的

get()

、設定元素的

set()

、以及符合自身有序集合的指定索引index的添加元素方法

add(int, E)

、還有擷取元素索引值的

indexOf

相關方法等……

具體源碼如下：

public interface List<E> extends Collection<E> {

    // Query Operations
    int size();
    boolean isEmpty();
    boolean contains(Object o);
    Iterator<E> iterator();
    Object[] toArray();
    <T> T[] toArray(T[] a);

    // Modification Operations
    boolean add(E e);
    boolean remove(Object o);


    // Bulk Modification Operations
    boolean containsAll(Collection<?> c);
    boolean addAll(Collection<? extends E> c);
    boolean addAll(int index, Collection<? extends E> c);
    boolean removeAll(Collection<?> c);
    boolean retainAll(Collection<?> c);

    default void replaceAll(UnaryOperator<E> operator) {
        Objects.requireNonNull(operator);
        final ListIterator<E> li = this.listIterator();
        while (li.hasNext()) {
            li.set(operator.apply(li.next()));
        }
    }

    @SuppressWarnings({"unchecked", "rawtypes"})
    default void sort(Comparator<? super E> c) {
        Object[] a = this.toArray();
        Arrays.sort(a, (Comparator) c);
        ListIterator<E> i = this.listIterator();
        for (Object e : a) {
            i.next();
            i.set((E) e);
        }
    }

    void clear();


    // Comparison and hashing
    boolean equals(Object o);
    int hashCode();


    // Positional Access Operations
    E get(int index);
    E set(int index, E element);
    void add(int index, E element);
    E remove(int index);


    // Search Operations
    int indexOf(Object o);
    int lastIndexOf(Object o);


    // List Iterators
    ListIterator<E> listIterator();
    ListIterator<E> listIterator(int index);
    List<E> subList(int fromIndex, int toIndex);
    @Override
    default Spliterator<E> spliterator() {
        return Spliterators.spliterator(this, Spliterator.ORDERED);
    }
}

           

AbstractList

AbstractList

抽象類的定義如下：

public abstract class AbstractList<E> extends AbstractCollection<E> implements List<E> {
    //....
}
           

從定義中我們可以看出，

AbstractList

繼承了

AbstractCollection

抽象類，并且實作了

List

接口；它實作了

List

中除

get(int index)

之外的大部分方法（PS：很多方法的實作細節上隻是抛出了一個

UnsupportedOperationException

異常，有點不太了解其含義）。

從源碼上來看，

AbstractList

主要是提供了 疊代周遊 的相關操作（通過疊代器來實作），為後續子類提供了疊代周遊上的簡化。

AbstractSequentialList

AbstractSequentialList

抽象類的定義如下：

public abstract class AbstractSequentialList<E> extends AbstractList<E> {
    // ...
}
           

從其定義我們看看到它繼承于

AbstractList

抽象類，那它到底是做有什麼實際上的用途呢？我們來看看它的API：

我們可以看到，它所重寫的

API

中大部分都含有參數：索引

index

。

AbstractSequentialList

實作了本來隻能 順序通路/操作 的資料存儲結構（例如：連結清單）的

get(int index)、 add（int index, E element)

等 随機通路/操作 的方法。這句話可能有點繞，稍加解釋一番：連結清單是一種隻能順序通路的資料存儲結構，而

AbstractSequentialList

抽象類對這類隻能 順序通路/操作 的資料存儲結構，也提供了類數組般的随機通路/操作 的能力。其底層是基于疊代器順序周遊（說到底還是需要周遊，隻不過是它幫我們做了這一步~）來實作的。

一般情況下，對于支援随機通路的資料結構 (例如:ArrayList) 會繼承

AbstractList

抽象類，不支援随機通路的資料結構（例如： LinkedList）則會繼承

AbstactSequentialList

抽象類。但是需要注意的是：

ArrayList

和

LinkedList

都大量重寫了

AbstractList

和

AbstactSequentialList

的相關實作，可真是任性的小朋友呀。

前朝遺孤般的Vector和Stack

在

List

的類圖中，我們看到了兩個被标注為遺留的類，分别是：

Vector

和

Stack

。

這兩個類是曆史遺留産物，在JDK的後續發展中都有想對應的替代産物，

Vector

是線程安全的

List

，在實際的開發中我們可以使用

CopyOnWriteArrayList

來代替；

Stack

提供了棧功能，我們可以使用

LinkedList

來代替。

另外，關于

ArrayList

和

LinkedList

有專門的介紹，具體參考文章：

• Java集合List系列（一）：ArrayList源碼解析（JDK1.8)
• Java集合List系列（二）：LinkedList源碼解析（JDK1.8）

Set

Set

的定義如下:

public interface Set<E> extends Collection<E> {
    // ...
}
           

從定義我們可以看出，

Set

接口繼承于

Collection

，也是集合的一種，它代表的是數學概念中的集合——不能有重複的元素。

通過檢視源碼可以看到，

Set

并沒有像

List

一般定義了自己的API；

Set

中的所有方法都是繼承于

Collection

接口。

接下來看一下集合

Set

的家庭成員：

從類圖中我們可以看出，

Set

集合家庭中，供我們使用的主要有：

TreeSet

、

HashSet

以及

LinkedHashSet

這三個類。

• TreeSet

  ：有序的存放，線程不安全，可以對Set集合中的元素進行排序，由紅黑樹來實作排序，TreeSet實際上也是SortedSet接口的子類，其在方法中實作了SortedSet的所有方法，并使用comparator()方法進行排序。

• HashSet

  ：底層資料結構由HashMap的鍵來實作。不保證集合中元素的順序，即不能保證疊代的順序與插入的順序一緻。是線程不安全的。

• LinkedHashSet

  ：底層由連結清單實作，按照元素插入的順序進行疊代，即疊代輸出的順序與插入的順序保持一緻。

關于這三者的詳細介紹，請參考如下文章：

• todo1:
• todo2:
• todo3:

Map

Map

的定義如下：

public interface Map<K,V> {
    // ..
}
           

我們可以看到，

Map

接口并沒有繼承于

Collection

；

Map

是一種把

鍵對象(key)

和

值對象(value)

進行關聯的容器。對于鍵對象(key)來說，像

Set

一樣，一個Map容器中的鍵對象不允許重複，也即鍵對象key是唯一的，同時一個

鍵對象key

隻能映射一個

值對象value

。對于

值對象value

并沒有唯一性要求，理論上可以将多個

key

都映射到同一個

value

之上；雖然程式不會報錯，但是可能會對使用者造成困擾（到底是哪個key映射過來的呢？）

注意：由于

Map

中作為

key

的對象将通過計算其散列函數來确定與之對應的存放

value

的位置，是以任何作為

key

的對象都必須實作

hashCode

和

equals

方法。

我們來看看

Map

集合的家庭成員有哪些：

從類圖中我們可以看出，

Map

系列集合提供的可供使用的子類有 6 個，分别為：

HashMap

、

LinkedHashMap

、

WeakHashMap

、

HashTable(前朝遺孤)

、

IdentityHashMap

以及

TreeMap

；而實際的開發中，使用最為頻繁的為：

HashMap

、

LinkedHashMap

以及

TreeMap

。

後續的文章也會針對這 3 個

Map

進行源碼分析。

Map

作為一個集合，所提供的功能始終跳不出這幾種：新增、删除、查找等……我們來瞅瞅JDK設計者為其設計了哪些具體的API吧！

public interface Map<K,V> {

    // 傳回集合長度
    int size();

    // 判斷集合是否為空
    boolean isEmpty();

    // 是否包含指定的key
    boolean containsKey(Object key);

    // 是否包含指定value
    boolean containsValue(Object value);

    // 通過key擷取對應的value
    V get(Object key);

    // Modification Operations

    // 往集合map中添加 key和value
    V put(K key, V value);

    // 根據key移除鍵值對，并傳回對應的value
    V remove(Object key);


    // Bulk Operations
    // 批量添加key
    void putAll(Map<? extends K, ? extends V> m);

    // 清除集合map中的所有鍵值對
    void clear();

    // Views

    // 擷取key的集合
    Set<K> keySet();

    Collection<V> values();

    Set<Map.Entry<K, V>> entrySet();

    // entry是存儲的鍵值對對象
    interface Entry<K,V> {

        K getKey();

  
        V getValue();

        V setValue(V value);

        boolean equals(Object o);

        int hashCode();

        public static <K extends Comparable<? super K>, V> Comparator<Map.Entry<K,V>> comparingByKey() {
            return (Comparator<Map.Entry<K, V>> & Serializable)
                (c1, c2) -> c1.getKey().compareTo(c2.getKey());
        }

        public static <K, V extends Comparable<? super V>> Comparator<Map.Entry<K,V>> comparingByValue() {
            return (Comparator<Map.Entry<K, V>> & Serializable)
                (c1, c2) -> c1.getValue().compareTo(c2.getValue());
        }

        public static <K, V> Comparator<Map.Entry<K, V>> comparingByKey(Comparator<? super K> cmp) {
            Objects.requireNonNull(cmp);
            return (Comparator<Map.Entry<K, V>> & Serializable)
                (c1, c2) -> cmp.compare(c1.getKey(), c2.getKey());
        }

        public static <K, V> Comparator<Map.Entry<K, V>> comparingByValue(Comparator<? super V> cmp) {
            Objects.requireNonNull(cmp);
            return (Comparator<Map.Entry<K, V>> & Serializable)
                (c1, c2) -> cmp.compare(c1.getValue(), c2.getValue());
        }
    }

    // Comparison and hashing

    boolean equals(Object o);

    int hashCode();

    // Defaultable methods

    default V getOrDefault(Object key, V defaultValue) {
        V v;
        return (((v = get(key)) != null) || containsKey(key))
            ? v
            : defaultValue;
    }

    default void forEach(BiConsumer<? super K, ? super V> action) {
        Objects.requireNonNull(action);
        for (Map.Entry<K, V> entry : entrySet()) {
            K k;
            V v;
            try {
                k = entry.getKey();
                v = entry.getValue();
            } catch(IllegalStateException ise) {
                // this usually means the entry is no longer in the map.
                throw new ConcurrentModificationException(ise);
            }
            action.accept(k, v);
        }
    }

    default void replaceAll(BiFunction<? super K, ? super V, ? extends V> function) {
        Objects.requireNonNull(function);
        for (Map.Entry<K, V> entry : entrySet()) {
            K k;
            V v;
            try {
                k = entry.getKey();
                v = entry.getValue();
            } catch(IllegalStateException ise) {
                // this usually means the entry is no longer in the map.
                throw new ConcurrentModificationException(ise);
            }

            // ise thrown from function is not a cme.
            v = function.apply(k, v);

            try {
                entry.setValue(v);
            } catch(IllegalStateException ise) {
                // this usually means the entry is no longer in the map.
                throw new ConcurrentModificationException(ise);
            }
        }
    }

    default V putIfAbsent(K key, V value) {
        V v = get(key);
        if (v == null) {
            v = put(key, value);
        }

        return v;
    }

    default boolean remove(Object key, Object value) {
        Object curValue = get(key);
        if (!Objects.equals(curValue, value) ||
            (curValue == null && !containsKey(key))) {
            return false;
        }
        remove(key);
        return true;
    }


    default boolean replace(K key, V oldValue, V newValue) {
        Object curValue = get(key);
        if (!Objects.equals(curValue, oldValue) ||
            (curValue == null && !containsKey(key))) {
            return false;
        }
        put(key, newValue);
        return true;
    }


    default V replace(K key, V value) {
        V curValue;
        if (((curValue = get(key)) != null) || containsKey(key)) {
            curValue = put(key, value);
        }
        return curValue;
    }

    default V computeIfAbsent(K key,
            Function<? super K, ? extends V> mappingFunction) {
        Objects.requireNonNull(mappingFunction);
        V v;
        if ((v = get(key)) == null) {
            V newValue;
            if ((newValue = mappingFunction.apply(key)) != null) {
                put(key, newValue);
                return newValue;
            }
        }

        return v;
    }


    default V computeIfPresent(K key,
            BiFunction<? super K, ? super V, ? extends V> remappingFunction) {
        Objects.requireNonNull(remappingFunction);
        V oldValue;
        if ((oldValue = get(key)) != null) {
            V newValue = remappingFunction.apply(key, oldValue);
            if (newValue != null) {
                put(key, newValue);
                return newValue;
            } else {
                remove(key);
                return null;
            }
        } else {
            return null;
        }
    }


    default V compute(K key,
            BiFunction<? super K, ? super V, ? extends V> remappingFunction) {
        Objects.requireNonNull(remappingFunction);
        V oldValue = get(key);

        V newValue = remappingFunction.apply(key, oldValue);
        if (newValue == null) {
            // delete mapping
            if (oldValue != null || containsKey(key)) {
                // something to remove
                remove(key);
                return null;
            } else {
                // nothing to do. Leave things as they were.
                return null;
            }
        } else {
            // add or replace old mapping
            put(key, newValue);
            return newValue;
        }
    }


    default V merge(K key, V value,
            BiFunction<? super V, ? super V, ? extends V> remappingFunction) {
        Objects.requireNonNull(remappingFunction);
        Objects.requireNonNull(value);
        V oldValue = get(key);
        V newValue = (oldValue == null) ? value :
                   remappingFunction.apply(oldValue, value);
        if(newValue == null) {
            remove(key);
        } else {
            put(key, newValue);
        }
        return newValue;
    }
}

           

工具類

總結