JDK源碼分析-ArrayList

概述

ArrayList 是 List 接口的一個實現類，也是 Java 中最經常使用的容器實現類之一，能夠把它理解爲「可變數組」。

咱們知道，Java 中的數組初始化時須要指定長度，並且指定後不能改變。ArrayList 內部也是一個數組，它對數組的功能作了加強：主要是在容器內元素增長時能夠動態擴容，這也是 ArrayList 的核心所在。

前面「JDK源碼分析-List, Iterator, ListIterator」已經概述了 List 接口的方法，ArrayList 的主要方法與 List 基本一致，所以這裏重點分析其內部結構和擴容的原理。

ArrayList 的繼承結構以下（省略部分接口）：

構造器

咱們先從構造器着手進行分析。ArrayList 有三個構造器，分別爲：

1. 無參構造器

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

該構造器涉及兩個變量：elementData 和 DEFAULTCAPACITY_EMPTY_ELEMENTDATA。這兩個變量的定義以下：

transient Object[] elementData; // non-private to simplify nested class access

能夠看到 elementData 是一個 Object 類型的數組，該數組也是 ArrayList 做爲容器用於存儲數據的地方。

/**
 * Shared empty array instance used for default sized empty instances. We
 * distinguish this from EMPTY_ELEMENTDATA to know how much to inflate when
 * first element is added.
 */
private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};

DEFAULTCAPACITY_EMPTY_ELEMENTDATA 是一個 Object 類型的空數組。所以，該無參構造器的做用就是將 elementData 初始化爲一個 Object 類型的空數組。

2. 指定初始化容量的構造器

該構造傳入一個參數，即初始化內部數組容量的 initialCapacity，以下：

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);
    }
}

該構造器根據傳入的初始容量（initialCapacity）初始化用於存儲元素的數組 elementData 變量。當初始容量爲 0 時，elementData 被初始化爲 EMPTY_ELEMENTDATA，該變量以下：

private static final Object[] EMPTY_ELEMENTDATA = {};

該數組與 DEFAULTCAPACITY_EMPTY_ELEMENTDATA 都是一個空的 Object 數組，兩者名字不一樣是爲了區分 ArrayList 初始化時是否指定了容量，後期進行擴容的時候有所不一樣。

3. 指定初始化集合的構造器

該構造器傳入一個集合 Collection，即便用 Collection 中的元素初始化 ArrayList 對象，代碼以下：

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 爲空時會拋出 NPE，所以初始化前有必要判空。

擴容實現原理

上面分析了 ArrayList 的構造器，但 ArrayList 如何作到動態擴容呢？

咱們能夠從 add() 方法着手進行分析（addAll() 方法相似，再也不單獨分析），以下：

// ArrayList 的大小（包含元素的個數）
private int size;

// 將指定的元素添加到 List 末尾
public boolean add(E e) {
    ensureCapacityInternal(size + 1);  // Increments modCount!!
    elementData[size++] = e;
    return true;
}

能夠看到，在 add() 方法執行時，會首先執行 ensureCapacityInternal() 方法：

private void ensureCapacityInternal(int minCapacity) {
    ensureExplicitCapacity(calculateCapacity(elementData, minCapacity));
}

該方法會先經過 calculateCapacity 方法計算數組須要的容量 minCapacity，而後判斷是否須要執行 grow() 方法：

// 默認初始化容量
private static final int DEFAULT_CAPACITY = 10;

private static int calculateCapacity(Object[] elementData, int minCapacity) {
    // 這裏只會在使用無參構造器初始化，而且第一次使用 add 方法時執行（將容量初始化爲 10）
    if (elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA) {
        return Math.max(DEFAULT_CAPACITY, minCapacity);
    }
    return minCapacity;
}

private void ensureExplicitCapacity(int minCapacity) {
    modCount++;
    // overflow-conscious code
    if (minCapacity - elementData.length > 0)
        grow(minCapacity);
}

這裏能夠看到，若 elementData 初始值爲 DEFAULTCAPACITY_EMPTY_ELEMENTDATA，即使用無參構造器初始化 ArrayList，則默認初始化容量爲 10.

若所需容量大小 minCapacity 比原數組長度大（即原數組長度不夠用了），則執行 grow() 方法（對數組進行擴容）：

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);
}

private static int hugeCapacity(int minCapacity) {
    if (minCapacity < 0) // overflow
        throw new OutOfMemoryError();
    return (minCapacity > MAX_ARRAY_SIZE) ?
        Integer.MAX_VALUE :
        MAX_ARRAY_SIZE;
}

新容量大小計算： 

int newCapacity = oldCapacity + (oldCapacity >> 1);

由此能夠看出，新容量爲原容量的 1.5 倍；若擴容爲 1.5 倍後，仍未達到所需容量，則直接使用所須要的容量。

如何擴容的呢？使用 Arrays.copyOf() 方法建立了一個新的數組，而後將原先數組的元素拷貝到新的數組中：

elementData = Arrays.copyOf(elementData, newCapacity);

跟蹤該方法能夠發現，最終調用了 System.arraycopy() 方法：

public static native void arraycopy(Object src,  int  srcPos,
                                        Object dest, int destPos, int length);

ArrayList 擴容小結

1. 若未指定初始化容量

當第一次執行 add() 方法時，將數組長度默認初始化爲 10，以後再添加元素時不擴容，直至容量等於 10，再添加第 11 個元素時，將容量擴容爲 15 (10 + 10 >> 1)，以此類推。

2. 若指定了初始化容量 initialCapacity

當數組容量到達 initialCapacity 以前，不進行擴容，當容量等於 initialCapacity 時若再添加元素，則執行擴容，擴容操做同上。

3. 新容量大小

默認擴容後數組的容量爲原數組容量的 1.5 倍；若仍未達到所需大小（使用 addAll() 方法時可能出現），則擴容爲所需的容量。

線程安全性

線程安全能夠簡單理解爲：多個線程同時操做一個方法或變量時，不會出現問題；若出現問題，可認爲是線程不安全的。

ArrayList 是線程不安全的，主要體現有二：

1. 多個線程往 ArrayList 添加數據時（擴容時），可能會產生數組越界異常（ArrayIndexOutOfBoundsException）；

2. 多個線程遍歷同一個 ArrayList，有線程對其進行修改時，可能會拋出 ConcurrentModificationException。

先對 add() 方法進行分析：

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

注意：i++ 操做是非原子性的。

場景分析一：

如有一個初始容量爲 1 的 ArrayList，線程 T1 和 T2 同時向其中添加元素（add() 方法），當添加第 2 個元素時，須要進行擴容。

此時如有如下執行時序：

1. T一、T2 檢測到須要擴容

此時，T1 和 T2 拿到的都是 elementData.length=1, size=1，若 T1 先執行 ensureCapacityInternal() 方法擴容，則 elementData.length=2, size=1；以後 T2 再執行 ensureCapacityInternal() 方法時，由於初始 size=1，而 T1 擴容後 elementData.length=2，因此 T2 不會再進行擴容（再也不執行 grow() 方法）。

2. T1 執行賦值操做和 size++ 操做

以後 T1 執行賦值操做 elementData[1]=XX 和 size++，size 自增爲 2;

3. T2 執行賦值操做（數組越界）和 size++ 操做

因爲上一步 T1 執行了 size++ 操做，當前 size=2，這時的賦值 elementData[size++] 將對 elementData[2] 執行賦值操做，而 elementData.length=2，最大下標爲 1，這時會發生數組越界異常（ArrayIndexOutOfBoundsException）。

場景分析二：

有一個 ArrayList，線程 T1 對其進行遍歷；線程 T2 對其遍歷，並移除部分元素。

對 ArrayList 進行遍歷時，以 iterator 方法爲例，其代碼以下：

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

會建立一個內部類 Itr，以下：

private class Itr implements Iterator<E> {
    int expectedModCount = modCount;

    // ...
    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];
    }

    // 檢查是否有其餘線程進行結構性修改
    final void checkForComodification() {
        if (modCount != expectedModCount)
            throw new ConcurrentModificationException();
    }    
}

而 ArrayList 的 add()、remove() 等結構性修改的操做都會使  modCount++。所以有：若線程 T1 只對 ArrayList 進行遍歷；而線程 T2 對同一個 ArrayList 進行了移除元素操做，則會修改 modCount 的值，致使線程 T1 中 modCount != expectedModCount，從而觸發 ConcurrentModificationException。

ArrayList 小結

1. ArrayList 能夠理解爲「能夠自動擴容的數組」，默認初始化容量爲 10，默認每次擴容爲原容量的 1.5 倍；

2. 擴容時會建立一個新的數組，並將以前的元素拷貝到新數組中（所以，若要將數量已知的元素放入 ArrayList，在初始化時指定長度能夠避免屢次擴容）；

3. 線程不安全，不適合在多線程場景下使用。

Stay hungry, stay foolish.