原始碼分析之ArrayList

概念

ArrayList是我們常用的集合類，是基於陣列實現的。不同於陣列的是ArrayList可以動態擴容。

類結構

ArrayList是Java集合框架List介面的一個實現類。提供了一些運算元組元素的方法。

實現List介面同時，也實現了 RandomAccess, Cloneable, java.io.Serializable。

ArrayList繼承與AbstractList。

類成員

elementData

   transient Object[] elementData;複製程式碼

elementData是用於儲存資料的陣列，是ArrayList類的基礎。

elementData是被關鍵字transient修飾的。我們知道被transient修飾的變數，是不會參與物件序列化和反序列化操作的。而我們知道ArrayList實現了java.io.Serializable，這就表明ArrayList是可序列化的類，這裡貌似出現了矛盾。

ArrayList在序列化和反序列化的過程中，有兩個值得關注的方法：writeObject和 readObject：

    private void writeObject(java.io.ObjectOutputStream s)
        throws java.io.IOException{
        // Write out element count, and any hidden stuff
        int expectedModCount = modCount;
        s.defaultWriteObject();

        // Write out size as capacity for behavioural compatibility with clone()
        s.writeInt(size);

        // Write out all elements in the proper order. 
        for (int i=0; i<size; i++) {
            s.writeObject(elementData[i]);
        }

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

    private void readObject(java.io.ObjectInputStream s)
        throws java.io.IOException, ClassNotFoundException {
        elementData = EMPTY_ELEMENTDATA;

        // Read in size, and any hidden stuff
        s.defaultReadObject();

        // Read in capacity   
        s.readInt(); // ignored

        if (size > 0) {
            // be like clone(), allocate array based upon size not capacity
            ensureCapacityInternal(size);

            Object[] a = elementData;
            // Read in all elements in the proper order.
            for (int i=0; i<size; i++) {
                a[i] = s.readObject();
            }
        }
    }複製程式碼

writeObject會將ArrayList中的size和element資料寫入ObjectOutputStream。readObject會從ObjectInputStream讀取size和element資料。

之所以採用這種序列化方式，是出於效能的考量。因為ArrayList中elementData陣列在add元素的過程，容量不夠時會動態擴容，這就到可能會有空間沒有儲存元素。採用上述序列化方式，可以保證只序列化有實際值的陣列元素，從而節約時間和空間。

size

    private int size;複製程式碼

size是ArrayList的大小。

DEFAULT_CAPACITY

    /**
     * Default initial capacity.
     */
    private static final int DEFAULT_CAPACITY = 10;複製程式碼

ArrayList預設容量是10。

建構函式

ArrayList提供了2個建構函式ArrayList(int initialCapacity)和 ArrayList()。

使用有參建構函式初始化ArrayList需要指定初始容量大小，否則採用預設值10。

add()方法

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

在add元素之前，會呼叫ensureCapacityInternal方法，來判斷當前陣列是否需要擴容。

    private void ensureCapacityInternal(int minCapacity) {
        if (elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA) {
            // 如果elementData為空陣列，指定elementData最少需要多少容量。
            // 如果初次add，將取預設值10；
            minCapacity = Math.max(DEFAULT_CAPACITY, minCapacity);
        }
        ensureExplicitCapacity(minCapacity);
    }

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

        // overflow-conscious code
        // elementData容量不足的情況下進行擴容
        if (minCapacity - elementData.length > 0)
            grow(minCapacity);
    }

    private void grow(int minCapacity) {
        // overflow-conscious code
        int oldCapacity = elementData.length;
        int newCapacity = oldCapacity + (oldCapacity >> 1);
        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);
    }複製程式碼

• 從grow方法中可以看出，ArrayList的elementData陣列如遇到容量不足時，將會把新容量newCapacity設定為 oldCapacity + (oldCapacity >> 1)。二進位制位操作>> 1等同於/2的效果，擴容導致的newCapacity也就設定為原先的1.5倍。

• 如果新的容量大於MAX_ARRAY_SIZE。將會呼叫hugeCapacity將int的最大值賦給newCapacity。不過這種情況一般不會用到，很少會用到這麼大的ArrayList。

在確保有容量的情況下，會將元素新增至elementData陣列中。

add(int index, E element) 方法

    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的add方法相對於直接add元素方法會略有不同。

• 首先會呼叫rangeCheckForAdd來檢查，要新增的index是否存在陣列越界問題；
• 同樣會呼叫ensureCapacityInternal來保證容量；
• 呼叫System.arraycopy方法複製陣列，空出elementData[index]的位置；
• 賦值並增加size；

remove(int index) 方法

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

ArryList提供了兩個刪除List元素的方法，如上所示，就是根據index來刪除元素。

• 檢查index是否越界；
• 取出原先值的，如果要刪除的值不是陣列最後一位，呼叫System.arraycopy方法將待刪除的元素移動至elementData最後一位。
• 將elementData最後一位賦值為null。

remove(Object o) 方法

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

remove(Object o)是根據元素刪除的，相對來說就要麻煩一點：

• 當元素o為空的時候，遍歷陣列刪除空的元素。
• 當元素o不為空的時候，遍歷陣列找出於o元素的index，並刪除元素。
• 如果以上兩步都沒有成功刪除元素，返回false。

modCount

在add、remove過程中，經常發現會有modCount++或者modCount--操作。這裡來看下modCount是個啥玩意。

modCount變數是在AbstractList中定義的。

    protected transient int modCount = 0;複製程式碼

modCount是一個int型變數，用來記錄ArrayList結構變化的次數。

modCount起作用的地方是在使用iterator的時候。ArrayList的iterator方法。

    public Iterator<E> iterator() {
        return new Itr();
    }

     private class Itr implements Iterator<E> {
        int cursor;       // index of next element to return
        int lastRet = -1; // index of last element returned; -1 if no such
        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();
        }
    }複製程式碼

iterator方法會返回私有內部類Itr的一個例項。這裡可以看到Itr類中很多方法，都會呼叫checkForComodification方法。來檢查modCount是夠等於expectedModCount。如果發現modCount != expectedModCount將會丟擲ConcurrentModificationException異常。

這裡寫一個小例子來驗證體會下modCount的作用。簡單介紹一下這個小例子：準備兩個執行緒t1、t2，兩個執行緒對同一個ArrayList進行操作，t1執行緒將迴圈向ArrayList中新增元素，t2執行緒將把ArrayList元素讀出來。

Test類：

public class Test {

    List<String> list = new ArrayList<String>();


    public Test() {

    }


    public void add() {

        for (int i = 0; i < 10000; i++) {
            list.add(String.valueOf(i));
        }

    }

    public void read() {

        Iterator iterator = list.iterator();
        while (iterator.hasNext()) {
            System.out.println(iterator.next());
        }

    }複製程式碼

t1執行緒：

public class Test1Thread implements Runnable {

    private Test test;

    public Test1Thread(Test test) {
        this.test = test;
    }

    public void run() {

        test.add();

    }複製程式碼

t2執行緒：

public class Test2Thread implements Runnable {

    private Test test;

    public Test2Thread(Test test) {
        this.test = test;
    }


    public void run() {
        test.read();
    }
}複製程式碼

main類

    public static void main(String[] args) throws InterruptedException {

        Test test = new Test();
        Thread t1  = new Thread(new Test1Thread(test));
        Thread t2  = new Thread(new Test2Thread(test));

        t1.start();
        t2.start();

    }複製程式碼

執行這個mian類就會發現程式將丟擲一個ConcurrentModificationException異常。

由異常可以發現丟擲異常點正處於在呼叫next方法的checkForComodification方法出現了異常。這裡也就出現上文描述的modCount != expectedModCount的情況，原因是t2執行緒在讀資料的時候，t1執行緒還在不斷的新增元素。

這裡modCount的作用也就顯而易見了，用modCount來規避多執行緒中併發的問題。由此也可以看出ArrayList是非執行緒安全的類。