jdk源碼解析--集合類

最近在整理JAVA 基礎知識，從jdk源碼入手，今天就jdk中 java.util包下集合類進行理解

先看圖

從類圖結構可以瞭解 java.util包下的2個大類：

　　1、Collecton：可以理解爲主要存放的是單個對象

　　2、Map：可以理解爲主要存儲key-value類型的對象

一、Collection

　　Collection繼承了Iterate接口，Iterate用於集合內迭代器抽象接口，其子類均實現接口中方法，看下ArrayList下實現：

 /**
     * Returns an iterator over the elements in this list in proper sequence.
     *
     * <p>The returned iterator is <a href="#fail-fast"><i>fail-fast</i></a>.
     *
     * @return an iterator over the elements in this list in proper sequence
     */
    public Iterator<E> iterator() {
        return new Itr(); // 返回內部類實例
    }

    /**
     * An optimized version of AbstractList.Itr
     */
    private class Itr implements Iterator<E> {
        int cursor;       // index of next element to return 指向下一個位置索引id
        int lastRet = -1; // index of last element returned; -1 if no such 指向上一個位置索引id
        int expectedModCount = modCount;

        public boolean hasNext() {
            return cursor != size;
        }

        @SuppressWarnings("unchecked")
        public E next() {
            checkForComodification();
            int i = cursor;
            if (i >= size)
                throw new NoSuchElementException();
            Object[] elementData = ArrayList.this.elementData;
            if (i >= elementData.length)
                throw new ConcurrentModificationException();
            cursor = i + 1;
            return (E) elementData[lastRet = i];
        }

        public void remove() {
            if (lastRet < 0)
                throw new IllegalStateException();
            checkForComodification();

            try {
                ArrayList.this.remove(lastRet);
                cursor = lastRet;
                lastRet = -1;
                expectedModCount = modCount;
            } catch (IndexOutOfBoundsException ex) {
                throw new ConcurrentModificationException();
            }
        }

        @Override
        @SuppressWarnings("unchecked")
        public void forEachRemaining(Consumer<? super E> consumer) {
            Objects.requireNonNull(consumer);
            final int size = ArrayList.this.size;
            int i = cursor;
            if (i >= size) {
                return;
            }
            final Object[] elementData = ArrayList.this.elementData;
            if (i >= elementData.length) {
                throw new ConcurrentModificationException();
            }
            while (i != size && modCount == expectedModCount) {
                consumer.accept((E) elementData[i++]);
            }
            // update once at end of iteration to reduce heap write traffic
            cursor = i;
            lastRet = i - 1;
            checkForComodification();
        }

        final void checkForComodification() {
            if (modCount != expectedModCount)
                throw new ConcurrentModificationException();
        }
    }

1、List

　　特點：有序結果、順序遍歷、索引、允許有重複值

　　(1) ArrayList 

　　　　以上特點實現：

transient Object[] elementData; // List內部存儲對象數組結果

public boolean add(E e) {
        ensureCapacityInternal(size + 1);  // Increments modCount!!
        elementData[size++] = e;
        return true;
}
// 添加對象時先識別是否越界，沒有越界則數組對象當前索引值的下一個添   
// 添加對象時，不識別重複，所以有序允許重複值

/**
 * Removes all of the elements from this list.  The list will
 * be empty after this call returns.
 */
public void clear() {
    modCount++;

    // clear to let GC do its work
    for (int i = 0; i < size; i++)
        elementData[i] = null;

    size = 0;
}
// 清空List時順序遍歷值置爲null

public E get(int index) {
　　rangeCheck(index);

　　return elementData(index);
}

E elementData(int index) {
　　return (E) elementData[index];
}

其中 remove方法 ：

  public E remove(int index) { // 按索引刪除對象
         rangeCheck(index); // 校驗輸入索引id是否越界，若越界則拋出運行時異常 IndexOutOfBoundsException
 
         modCount++;
         E oldValue = elementData(index);
 
         int numMoved = size - index - 1; // 定位到索引的下一位
         if (numMoved > 0)
             System.arraycopy(elementData, index+1, elementData, index,
                              numMoved); //調用native方法實現數組位置左移
         elementData[--size] = null; // clear to let GC do its work
 　　　　 // 末尾元素置空
         return oldValue;
     }


 public boolean remove(Object o) {// 按對象刪除
        if (o == null) {
            for (int index = 0; index < size; index++)
                if (elementData[index] == null) {
                    fastRemove(index);
                    return true;
                }
        } else {
            for (int index = 0; index < size; index++)
                if (o.equals(elementData[index])) { // 識別對象相等使用equals方法，使用時注意重寫equals方法
                    fastRemove(index);
                    return true;
                }
        }
        return false;
    }

    /*
     * Private remove method that skips bounds checking and does not
     * return the value removed.
     */
    private void fastRemove(int index) {
        modCount++; // 刪除元素時，modCount值變更
        int numMoved = size - index - 1;
        if (numMoved > 0)
            System.arraycopy(elementData, index+1, elementData, index,
                             numMoved);
        elementData[--size] = null; // clear to let GC do its work
    }

可以看到ArrayList中對數組進行，操作時常用到System.arraycopy

java.lang.System下
public static native void arraycopy(Object src,  int  srcPos,
                                        Object dest, int destPos,
                                        int length); 

 還有在 java.util.Arrays下數組copy方法，最終也是調用System.arraycopy方法

public static <T> T[] copyOf(T[] original, int newLength) {
        return (T[]) copyOf(original, newLength, original.getClass());
    }

public static <T,U> T[] copyOf(U[] original, int newLength, Class<? extends T[]> newType) {
        @SuppressWarnings("unchecked")
        T[] copy = ((Object)newType == (Object)Object[].class)
            ? (T[]) new Object[newLength]
            : (T[]) Array.newInstance(newType.getComponentType(), newLength);
        System.arraycopy(original, 0, copy, 0,
                         Math.min(original.length, newLength));
        return copy;
    }

示例：

 

 

可以看到出現異常：ConcurrentModificationException，出現該異常原因是： 

“快速失敗”也就是fail-fast，它是Java集合的一種錯誤檢測機制。當創建Iterator後，在Iterator使用還沒有結束時，改變（刪除或增添新項）集合元素就會出現上面的錯誤

看看ArrayList的排序方法：sort(Comparator<? super E> c)

 public void sort(Comparator<? super E> c) {
        final int expectedModCount = modCount;
        Arrays.sort((E[]) elementData, 0, size, c);
        if (modCount != expectedModCount) {
            throw new ConcurrentModificationException();
        }
        modCount++;
    }

public static <T> void sort(T[] a, int fromIndex, int toIndex,
                                Comparator<? super T> c) {
        if (c == null) {
            sort(a, fromIndex, toIndex);
        } else {
            rangeCheck(a.length, fromIndex, toIndex);
            if (LegacyMergeSort.userRequested)
                legacyMergeSort(a, fromIndex, toIndex, c);
            else
                TimSort.sort(a, fromIndex, toIndex, c, null, 0, 0);
        }
    }

 示例：

 

　　(2)LinkedList

public class LinkedList<E>
    extends AbstractSequentialList<E>
    implements List<E>, Deque<E>, Cloneable, java.io.Serializable
  // 實現了Deque接口，可以做隊列使用

 /**
     * Pointer to first node.
     * Invariant: (first == null && last == null) ||
     *            (first.prev == null && first.item != null)
     */
    transient Node<E> first;

    /**
     * Pointer to last node.
     * Invariant: (first == null && last == null) ||
     *            (last.next == null && last.item != null)
     */
    transient Node<E> last;

    /**
     * Constructs an empty list.
     */
    public LinkedList() {
    }
 
    // 集合對象存儲結構，通過當前節點的前後節點，維護順序集合（雙向鏈表結構）
    private static class Node<E> {
        E item;
        Node<E> next;
        Node<E> prev;

        Node(Node<E> prev, E element, Node<E> next) {
            this.item = element;
            this.next = next;
            this.prev = prev;
        }
    }

以上爲 LinkedList的內部存儲結構，以Node存儲。

在看下集合元素插入、刪除及獲取方法實現：

    public boolean add(E e) {
        linkLast(e);
        return true;
    }

    /**
     * Links e as last element.
     */
    void linkLast(E e) {
        final Node<E> l = last; // 保存最後個節點
        final Node<E> newNode = new Node<>(l, e, null);// 新增節點
        last = newNode; // 將新節點置爲最後節點
        if (l == null)
            first = newNode;
        else
            l.next = newNode;
        size++;
        modCount++;
    }

     public E remove() {
        return removeFirst(); // 去掉首節點
    }

    public E removeFirst() {
        final Node<E> f = first;
        if (f == null)
            throw new NoSuchElementException();
        return unlinkFirst(f);
    }

    private E unlinkFirst(Node<E> f) {
        // assert f == first && f != null;
        final E element = f.item;
        final Node<E> next = f.next;
        f.item = null;
        f.next = null; // help GC
        first = next;
        if (next == null)
            last = null;
        else
            next.prev = null;
        size--;
        modCount++;
        return element;
    }

    // 入棧方法
    public void push(E e) {
        addFirst(e);
    }
    // 出棧方法
    public E pop() {
        return removeFirst();
    }

    // 入隊
    public boolean offer(E e) {
        return add(e);
    }
    public boolean add(E e) {
        linkLast(e);
        return true;
    }
    // 出隊
    public E poll() {
        final Node<E> f = first;
        return (f == null) ? null : unlinkFirst(f);
    }

    //隨機訪問集合對象
     public E get(int index) {
        checkElementIndex(index);
        return node(index).item;
    }
    
    /**
     * Returns the (non-null) Node at the specified element index.
     */
    Node<E> node(int index) {
        // assert isElementIndex(index);
        // 識別 index id離首節點近還是尾節點近，減少遍歷  
        if (index < (size >> 1)) {
            Node<E> x = first;
            for (int i = 0; i < index; i++) // 0(i)
                x = x.next;
            return x;
        } else {
            Node<E> x = last;
            for (int i = size - 1; i > index; i--) // 0(i)
                x = x.prev;
            return x;
        }
    }

通過以上源碼理解 ArrayList 和 LinkedList 區別類似數據結構中 數組及鏈表結構區別 ，新增、刪除 和 隨機訪問存在 效率上的差別：

ArrayList是最常用的集合，其內部實現是一個數組，ArrayList的大小是可以動態擴充的。對於元素的隨機訪問效率高，其訪問的時間複雜度爲O(1)，對於數據的插入與刪除，從尾部操作效率高，時間複雜度和隨機訪問一樣是O(1)，若是從頭部操作則效率會比較低，因爲從頭部插入或刪除時需要移動後面所有元素，其時間複雜度爲O(n-i)(n表示元素個數，i表示元素位置)

LinkList對於隨機訪問效率是比較低的，因爲它需要從頭開始索引，所以其時間複雜度爲O(i)。但是對於元素的增刪，LinkList效率高，因爲只需要修改前後指針即可，其時間複雜度爲O(1)。

　　（3）Vector

　　　　與ArrayList類型，內部也是使用數據來存儲對象，但是線程安全的，因爲實現方法重寫的時候，全部加上了同步關鍵字：synchronized；（一般不建議使用，性能消耗）

　　（4）Stack

public
class Stack<E> extends Vector<E> {
    /**
     * Creates an empty Stack.
     */
    public Stack() {
    }

　　2、Queue

　　遵循FIFO（先入先出規則），內部出棧入棧方法，主要區別在於是否是阻塞入隊或出隊

　　3、Set　

public class HashSet<E>
    extends AbstractSet<E>
    implements Set<E>, Cloneable, java.io.Serializable

/**
     * Constructs a new, empty set; the backing <tt>HashMap</tt> instance has
     * default initial capacity (16) and load factor (0.75).
     */
    public HashSet() {
        map = new HashMap<>();
    }

// Set 集合對象存儲在 Map的 key中
 public boolean contains(Object o) {
        return map.containsKey(o);
    }

// 添加對象到Set集合中
 public boolean add(E e) {
        return map.put(e, PRESENT)==null;
    }
// 刪除Set集合中對象
 public boolean remove(Object o) {
        return map.remove(o)==PRESENT;
    }

實際Set集合的實現依賴於Map的實現，通過Map的 key值唯一性來實現

二、Map

　　1、HashMap：基於Map接口實現、允許null 鍵值、無序、非同步

　　一起看下HashMap的實現

// map 內部對象鏈表存儲結構
static class Node<K,V> implements Map.Entry<K,V> {
        final int hash;
        final K key;
        V value;
        Node<K,V> next; // 下一節點

        Node(int hash, K key, V value, Node<K,V> next) {
            this.hash = hash;
            this.key = key;
            this.value = value;
            this.next = next;
        }

        public final K getKey()        { return key; }
        public final V getValue()      { return value; }
        public final String toString() { return key + "=" + value; }
        // 重寫hashCode方法
        public final int hashCode() {
            return Objects.hashCode(key) ^ Objects.hashCode(value);
        }

        public final V setValue(V newValue) {
            V oldValue = value;
            value = newValue;
            return oldValue;
        }
        // 重寫 equals方法
        public final boolean equals(Object o) {
            if (o == this)
                return true;
            if (o instanceof Map.Entry) {
                Map.Entry<?,?> e = (Map.Entry<?,?>)o;
                if (Objects.equals(key, e.getKey()) &&
                    Objects.equals(value, e.getValue()))
                    return true;
            }
            return false;
        }
    }

transient Node<K,V>[] table; // 用數組保存多條鏈表的首節點

// 獲取 key所對應的存儲JNode的 value值
public V get(Object key) {
        Node<K,V> e;
        return (e = getNode(hash(key), key)) == null ? null : e.value;
    }
// 識別是否存在key所對應的 Node
 public boolean containsKey(Object key) {
        return getNode(hash(key), key) != null;
    }

// map 內部對象鏈表存儲結構
static class Node<K,V> implements Map.Entry<K,V> {
        final int hash;
        final K key;
        V value;
        Node<K,V> next; // 下一節點

        Node(int hash, K key, V value, Node<K,V> next) {
            this.hash = hash;
            this.key = key;
            this.value = value;
            this.next = next;
        }

        public final K getKey()        { return key; }
        public final V getValue()      { return value; }
        public final String toString() { return key + "=" + value; }
        // 重寫hashCode方法
        public final int hashCode() {
            return Objects.hashCode(key) ^ Objects.hashCode(value);
        }

        public final V setValue(V newValue) {
            V oldValue = value;
            value = newValue;
            return oldValue;
        }
        // 重寫 equals方法
        public final boolean equals(Object o) {
            if (o == this)
                return true;
            if (o instanceof Map.Entry) {
                Map.Entry<?,?> e = (Map.Entry<?,?>)o;
                if (Objects.equals(key, e.getKey()) &&
                    Objects.equals(value, e.getValue()))
                    return true;
            }
            return false;
        }
    }

transient Node<K,V>[] table; // 用數組保存多條鏈表的首節點

// 獲取 key所對應的存儲JNode的 value值
public V get(Object key) {
        Node<K,V> e;
        return (e = getNode(hash(key), key)) == null ? null : e.value;
    }
// 識別是否存在key所對應的 Node
 public boolean containsKey(Object key) {
        return getNode(hash(key), key) != null;
    }

// 插入 對象
public V put(K key, V value) {
        return putVal(hash(key), key, value, false, true);
    }

// 調用的內部方法，
final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
                   boolean evict) {
        // tab 爲map內首節點集合
        Node<K,V>[] tab; Node<K,V> p; int n, i;
        // 先識別table是否爲空，爲空則初始化，hashmap內存存儲延遲加載在這裏體現
        if ((tab = table) == null || (n = tab.length) == 0)
            n = (tab = resize()).length;
        // 通過hash值以長度做按位與，識別讀取元素的存儲在tab中的位置
        if ((p = tab[i = (n - 1) & hash]) == null)
            // 若tab所在鏈表首節點爲空，則直接構造新節點
            tab[i] = newNode(hash, key, value, null);
        else {
            // tab所在鏈表首節點不爲空，則遍歷p所在鏈表或紅黑樹，找到可以存儲的位置
            Node<K,V> e; K k;
            if (p.hash == hash &&
                ((k = p.key) == key || (key != null && key.equals(k))))
                e = p;
            else if (p instanceof TreeNode)
                e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
            else {
                for (int binCount = 0; ; ++binCount) {
                    if ((e = p.next) == null) {
                        p.next = newNode(hash, key, value, null);
                        if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
                            treeifyBin(tab, hash);
                        break;
                    }
                    if (e.hash == hash &&
                        ((k = e.key) == key || (key != null && key.equals(k))))
                        break;
                    p = e;
                }
            }
            if (e != null) { // existing mapping for key
                V oldValue = e.value;
                if (!onlyIfAbsent || oldValue == null)
                    e.value = value;
                afterNodeAccess(e);
                return oldValue;
            }
        }
        ++modCount;
        if (++size > threshold)
            resize();
        afterNodeInsertion(evict);
        return null;
    }                

可以看到，在HashMap中存儲的結構下， Node類型的數組保存頭部節點（單鏈表）或根節點（紅黑樹），先以 Node的key的hash值與數組長度做位與運算（hash碰撞），初始

時使用單鏈表存儲新插入對象（newNode），當鏈表長度超過8時，會將鏈表結構轉爲紅黑樹結構存儲（treeifyBin方法）

final void treeifyBin(Node<K,V>[] tab, int hash) {
        int n, index; Node<K,V> e;
        if (tab == null || (n = tab.length) < MIN_TREEIFY_CAPACITY)
            resize();
        else if ((e = tab[index = (n - 1) & hash]) != null) {
        // 找到需要轉換的 單鏈表 e，遍歷單鏈表，轉換爲TreeNode,保存前後節點關係
        TreeNode<K,V> hd = null, tl = null;
            do {
                TreeNode<K,V> p = replacementTreeNode(e, null);
                if (tl == null)
                    hd = p;
                else {
                    p.prev = tl;
                    tl.next = p;
                }
                tl = p;
            } while ((e = e.next) != null);
            //讓桶的第一個元素指向新建的紅黑樹頭結點，以後這個桶裏的元素就是紅黑樹而不是鏈表了
            if ((tab[index] = hd) != null)
                hd.treeify(tab);
        }
    }    

先將單鏈錶轉換爲 treenode，在調用 treeify方法構造紅黑樹

　　2、LinkedHashMap

　　　繼承HashMap，HashMap是無序集合，而LinkedHashMap爲有序集合

public class LinkedHashMap<K,V>
    extends HashMap<K,V>
    implements Map<K,V>

　構造LinkedHashMap.EntreyNode<K,V> 繼承 HashMap.Node<K,V> 實現雙向鏈表

static class Entry<K,V> extends HashMap.Node<K,V> {
        Entry<K,V> before, after; // before 保存前置節點，after保存後置節點
        Entry(int hash, K key, V value, Node<K,V> next) {
            super(hash, key, value, next);
        }
    }

 /**
     * The head (eldest) of the doubly linked list.
     */
    transient LinkedHashMap.Entry<K,V> head; // 頭節點

    /**
     * The tail (youngest) of the doubly linked list.
     */
    transient LinkedHashMap.Entry<K,V> tail;  // 尾部節點


// 重寫HashMap的 創建新節點方法
 Node<K,V> newNode(int hash, K key, V value, Node<K,V> e) {
        LinkedHashMap.Entry<K,V> p =
            new LinkedHashMap.Entry<K,V>(hash, key, value, e);
        linkNodeLast(p); // 將新節點放到尾部節點，從而保證順序
        return p;
    }

// link at the end of list
    private void linkNodeLast(LinkedHashMap.Entry<K,V> p) {
        LinkedHashMap.Entry<K,V> last = tail;
        tail = p;
        if (last == null)
            head = p;
        else {
            p.before = last;
            last.after = p;
        }
    }

　　3、TreeMap

　　TreeMap直接使用紅黑樹結構存儲集合元素，根據鍵 做排序，排序規則按內部 comparator 對象的實例對象的排序規則，若comparator爲空，則按自然排序

public class TreeMap<K,V>
    extends AbstractMap<K,V>
    implements NavigableMap<K,V>, Cloneable, java.io.Serializable
{
    /**
     * The comparator used to maintain order in this tree map, or
     * null if it uses the natural ordering of its keys.
     *
     * @serial
     */
    private final Comparator<? super K> comparator; // 對象比較接口

    private transient Entry<K,V> root;  // 根節點

root的實現邏輯爲 TreeMap.Entrey<K,V> 繼承 Map.Entrey<K,V> 實現 ，與HashMap.TreeNode<K,V>實現類似

static final class Entry<K,V> implements Map.Entry<K,V> {
        K key;
        V value;
        Entry<K,V> left;
        Entry<K,V> right;
        Entry<K,V> parent;
        boolean color = BLACK;

所以TreeMap put和get方法就是以鍵先進行紅黑樹的查找後操作

　　4、HashTable

　　HashTable和HashMap數據結構類似，主要區別爲HashTable中操作集合元素對象的方法都加上了 同步關鍵字(synchronized), 所以說線程安全的及集合