和我一起讀Java8 ArrayList原始碼

卡巴拉的樹發表於2017-12-13

集合系列文章:和我一起讀Java8 LinkedList原始碼 首先放一張Java集合介面圖:

14種容器介面
Collection是一個獨立元素序列,這些元素都服從一條或多條規則,List必須按照插入的順序儲存元素,而Set不能有重複元素,Queue按照排隊規則來確定物件產生的順序。 List在Collection的基礎上新增了大量的方法,使得可以在List的中間插入和移除元素。 有2種型別的List:

  • ArrayList 它長於隨機訪問元素,但是在List中間插入和移除元素較慢。
  • LinkedList 它通過代價較低的方式在List中間進行插入和刪除,但是在隨機訪問方面相對較慢,但是它的特性急較ArrayList大。 還有個第一代容器Vector,後面僅作比較。

下面正式進入ArrayList實現原理,主要參考Java8 ArrayList原始碼 ####類定義

public class ArrayList<E> extends AbstractList<E>
        implements List<E>, RandomAccess, Cloneable, java.io.Serializable
複製程式碼

ArrayList 繼承了AbstractList並且實現了List,所以具有新增,修改,刪除,遍歷等功能 實現了RandomAccess介面,支援隨機訪問 實現了Cloneable介面,支援Clone 實現了Serualizable介面,可以被序列化 ####底層資料結構

transient Object[] elementData;  //存放元素的陣列
private int size; //ArrayList實際存放的元素數量
複製程式碼

ArrayList的底層實際是通過一個Object的陣列實現,陣列本身有個容量capacity,實際儲存的元素個數為size,當做一些操作,例如插入操作導致陣列容量不夠時,ArrayList就會自動擴容,也就是調節capacity的大小。

####初始化 指定容量大小初始化

/**
     * Constructs an empty list with the specified initial capacity.
     *
     * @param  initialCapacity  the initial capacity of the list
     * @throws IllegalArgumentException if the specified initial capacity
     *         is negative
     */
    public ArrayList(int initialCapacity) {
        if (initialCapacity > 0) {
            this.elementData = new Object[initialCapacity];
        } else if (initialCapacity == 0) {
            this.elementData = EMPTY_ELEMENTDATA;
        } else {
            throw new IllegalArgumentException("Illegal Capacity: "+
                                               initialCapacity);
        }
    }
複製程式碼

初始化一個指定容量的空集合,若是容量為0,集合為空集合,其中 private static final Object[] EMPTY_ELEMENTDATA = {};,容量也為0。

無引數初始化

/**
 * Constructs an empty list with an initial capacity of ten.
*/
public ArrayList() {
        this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;
    }
複製程式碼

無引數初始化,其實DEFAULTCAPACITY_EMPTY_ELEMENTDATA的定義也為: private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};EMPTY_ELEMENTDATA的區別是當第一個元素被插入時,陣列就會自動擴容到10,具體見下文說add方法時的解釋。

集合作為初始化引數

/**
     * Constructs a list containing the elements of the specified
     * collection, in the order they are returned by the collection's
     * iterator.
     *
     * @param c the collection whose elements are to be placed into this list
     * @throws NullPointerException if the specified collection is null
     */
    public ArrayList(Collection<? extends E> c) {
        elementData = c.toArray();
        if ((size = elementData.length) != 0) {
            // c.toArray might (incorrectly) not return Object[] (see 6260652)
            if (elementData.getClass() != Object[].class)
                elementData = Arrays.copyOf(elementData, size, Object[].class);
        } else {
            // replace with empty array.
            this.elementData = EMPTY_ELEMENTDATA;
        }
    }
複製程式碼

構造一個包含指定 collection 的元素的列表,這些元素按照該collection的迭代器返回它們的順序排列的。

####size和IsEmpty 首先是兩個最簡單的操作:

public int size() {
        return size;
    }
複製程式碼
public boolean isEmpty() {
        return size == 0;
    }
複製程式碼

都是依靠size值,直接獲取容器內元素的個數,判斷是否為空集合。

#####Set 和Get操作 Set和Get操作都是直接操作集合下標

public E set(int index, E element) {
        rangeCheck(index);

        E oldValue = elementData(index);
        elementData[index] = element;
        return oldValue;
    }
複製程式碼
public E get(int index) {
        rangeCheck(index);

        return elementData(index);
    }
複製程式碼

在操作之前都會做RangeCheck檢查,如果index超過size,則會報IndexOutOfBoundsException錯誤。 elementData的操作實際就是基於下標的訪問,所以ArrayList 長於隨機訪問元素,複雜度為O(1)。

@SuppressWarnings("unchecked")
    E elementData(int index) {
        return (E) elementData[index];
    }
複製程式碼

####Contain

public boolean contains(Object o) {
        return indexOf(o) >= 0;
    }
複製程式碼

contains 函式基於indexOf函式,如果第一次出現的位置大於等於0,說明ArrayList就包含該元素, IndexOf的實現如下:

public int indexOf(Object o) {
        if (o == null) {
            for (int i = 0; i < size; i++)
                if (elementData[i]==null)
                    return i;
        } else {
            for (int i = 0; i < size; i++)
                if (o.equals(elementData[i]))
                    return i;
        }
        return -1;
    }
複製程式碼

ArrayList是接受null值的,如果不存在該元素,則會返回-1,所以contains判斷是否大於等於0來判斷是否包含指定元素。

####Add和Remove

public boolean add(E e) {
        ensureCapacityInternal(size + 1);  // Increments modCount!!
        elementData[size++] = e;
        return true;
}
複製程式碼

首先確保已有的容量在已使用長度加1後還能存下下一個元素,這裡正好分析下用來確保ArrayList容量ensureCapacityInternal函式:

private void ensureCapacityInternal(int minCapacity) {
        if (elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA) {
            minCapacity = Math.max(DEFAULT_CAPACITY, minCapacity);
        }

        ensureExplicitCapacity(minCapacity);
    }
複製程式碼

這邊可以返回看一開始空引數初始化,this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA, 空引數初始化的ArrayList新增第一個元素,上面的if語句就會呼叫,DEFAULT_CAPACITY定義為10,所以空引數初始化的ArrayList一開始新增元素,容量就變為10,在確定了minCapacity後,還要呼叫ensureExplicitCapacity(minCapacity)去真正的增長容量:

private void ensureExplicitCapacity(int minCapacity) {
        modCount++;

        // overflow-conscious code
        if (minCapacity - elementData.length > 0)
            grow(minCapacity);
    }
複製程式碼

這裡modCount默默記錄ArrayList被修改的次數, 然後是判斷是否需要擴充陣列容量,如果當前陣列所需要的最小容量大於陣列現有長度,就呼叫自動擴容函式grow:

private void grow(int minCapacity) {
        // overflow-conscious code
        int oldCapacity = elementData.length;
        int newCapacity = oldCapacity + (oldCapacity >> 1); //擴充為原來的1.5倍
        if (newCapacity - minCapacity < 0)
            newCapacity = minCapacity;
        if (newCapacity - MAX_ARRAY_SIZE > 0)
            newCapacity = hugeCapacity(minCapacity);
        // minCapacity is usually close to size, so this is a win:
        elementData = Arrays.copyOf(elementData, newCapacity);
    }
複製程式碼

oldCapacity記錄陣列原有長度,newCapacity直接將長度擴充套件為原來的1.5倍,如果1.5倍的長度大於需要擴充的容量(minCapacity),就只擴充到minCapacity,如果newCapacity大於陣列最大長度MAX_ARRAY_SIZE,就只擴容到MAX_ARRAY_SIZE大小,關於MAX_ARRAY_SIZE為什麼是private static final int MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8;,我文章裡就不深究了,感興趣的可以參考stackoverflow上的有關回答: Why the maximum array size of ArrayList is Integer.MAX_VALUE - 8?

Add還提供兩個引數的形式,支援在指定位置新增元素。

public void add(int index, E element) {
        rangeCheckForAdd(index);

        ensureCapacityInternal(size + 1);  // Increments modCount!!
        System.arraycopy(elementData, index, elementData, index + 1,
                         size - index);
        elementData[index] = element;
        size++;
    }
複製程式碼

在指定位置新增元素之前,先把index位置起的所有元素後移一位,然後在index處插入元素。

在index=2處插入5

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

        modCount++;
        E oldValue = elementData(index);

        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

        return oldValue;
    }
複製程式碼

Remove介面也很好理解了,儲存index位置的值到oldView作為返回值,將index後面所有的元素都向前拷貝一位,不要忘記的是還要將原來最後的位置標記為null,以便讓垃圾收集器自動GC這塊記憶體。 還可以根據物件Remove:

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])) {
                    fastRemove(index);
                    return true;
                }
        }
        return false;
    }
複製程式碼

找到物件所在位置,呼叫FastRemove函式快速刪除index位置上的元素,FastRemove也就是比remove(index)少了個邊界檢查。

#####clear

/**
     * 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;
    }
複製程式碼

由於Java有GC機制,所以不需要手動釋放記憶體,只要將ArrayList所有元素都標記為null,垃圾收集器就會自動收集這些記憶體。

Add和Remove都提供了一系列的批量操作介面:

public boolean addAll(Collection<? extends E> c);
public boolean addAll(int index, Collection<? extends E> c);
protected void removeRange(int fromIndex, int toIndex) ;
public boolean removeAll(Collection<?> c) ;
複製程式碼

相比於單檔案一次只集體向前或向後移動一位,批量操作需要移動Collection 長度的距離。

####Iterator與fast_fail 首先看看ArrayList裡迭代器是如何實現的:

private class Itr implements Iterator<E> {
        int cursor;       // 記錄下一個返回元素的index,一開始為0
        int lastRet = -1; // index of last element returned; -1 if no such
        int expectedModCount = modCount;  //這邊確保產生迭代器時,就將當前modCount賦給expectedModCount

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

        @SuppressWarnings("unchecked")
        public E next() {
            checkForComodification();
            int i = cursor; //訪問元素的index
            if (i >= size)
                throw new NoSuchElementException();
            Object[] elementData = ArrayList.this.elementData;
            if (i >= elementData.length)
                throw new ConcurrentModificationException();
            cursor = i + 1; //不斷加1,只要不斷呼叫next,就可以遍歷List
            return (E) elementData[lastRet = i];  //lastRet在這裡會記錄最近返回元素的位置
        }

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

            try {
                ArrayList.this.remove(lastRet);  //呼叫List本身的remove函式,刪除最近返回的元素
                cursor = lastRet;
                lastRet = -1;
                expectedModCount = modCount; //上面的Remove函式會改變modCount,所以這邊expectedModCount需要更新
            } 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();
        }
    }
複製程式碼

ArrayList裡可以通過iterator方法獲取迭代器,iterator方法就是new一個上述迭代器物件:

public Iterator<E> iterator() {
        return new Itr();
    }
複製程式碼

那麼我們看看Itr類的主要方法:

  • next :獲取序列的下一個元素
  • hasNext:檢查序列中是否還有元素
  • remove:將迭代器新近返回的元素刪除

在next和remove操作之前,都會呼叫checkForComodification函式,如果modCount和本身記錄的expectedModCount不一致,就證明集合在別處被修改過,丟擲ConcurrentModificationException異常,產生fail-fast事件。

fail-fast 機制是java集合(Collection)中的一種錯誤機制。當多個執行緒對同一個集合的內容進行操作時,就可能會產生fail-fast事件。 例如:當某一個執行緒A通過iterator去遍歷某集合的過程中,若該集合的內容被其他執行緒所改變了;那麼執行緒A訪問集合時,就會丟擲ConcurrentModificationException異常,產生fail-fast事件。 一般多執行緒環境下,可以考慮使用CopyOnWriteArrayList來避免fail-fast。

相關文章