Java類集框架 —— ArrayList源碼分析

ArrayList能夠說是在Java開發中最經常使用的集合容器了，今天就來分析一下ArrayList的源碼，能夠更加深刻的理解ArrayList實現原理。

ArrayList的成員變量：

// 初始容量:10
  private static final int DEFAULT_CAPACITY = 10;
// 空數組，沒有元素數據
private static final Object[] EMPTY_ELEMENTDATA = {};
// 空數組，默認容量爲空，沒有元素數據
private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};
// 數組，用來存儲ArrayList的元素
 transient Object[] elementData;
// size爲ArrayList的大小，在elementData不爲空數組的狀況下，size是小於elementData.length的
 private int size;複製代碼

根據elementData也能看出來，ArrayList的內部是經過數組來實現的，ArrayList對元素的增刪改查實際上都是對數組的操做。

ArrayList的構造函數：

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

public ArrayList() {
    this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;
}

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

構造ArrayList時，能夠指定容器的初始容量initialCapacity，構造一個給定初始大小的數組做爲數據集；使用無參構造時，則默認容量爲空的數組做爲初始數據集；也可使用其餘任意的集合Collection做爲構造參數，能夠看到，源碼中就是直接將集合c轉換數組來做爲數據集（若是數據集是非Object數組，好比多維數組，則將元素拷貝到數據集數組中）。ArrayList的構造實際上就是對其內部數組的初始化。

add方法：

public boolean add(E e) {
    // 確保當前數據集數組可以放得下新加入的元素
    ensureCapacityInternal(size + 1);  // Increments modCount!!
    // 將列表大小size自增1，並在數據集數組中放入元素e
    elementData[size++] = e;
    return true;
}

public void add(int index, E element) {
    // 檢查新加入的位置index是否越界
    rangeCheckForAdd(index);
    // 確保當前數據集數組可以放得下新加入的元素，若是須要擴容的話就擴容
    ensureCapacityInternal(size + 1);  // Increments modCount!!
    // 將index位置及後面的元素都向後移動一位
    System.arraycopy(elementData, index, elementData, index + 1,
                     size - index);
    // 將index位置的元素設置爲新建如的element
    elementData[index] = element;
    size++;
}複製代碼

在添加元素時，若是不指定加入的位置，會添加到內部數組中已有元素的最後一位，也就是添加到了ArrayList的末尾。若是指定了添加位置index，判斷index是否越界，是否須要擴容，最後移動index位置後的元素，並將index位置設置爲新添加的元素。

須要注意的是，添加的元素並無判空，因此ArrayList中的元素是能夠爲null的。

在add方法中，都調用了ensureCapacityInternal(int minCapacity)這個方法來確保數據集數組可以放得下新的元素：

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

private void ensureExplicitCapacity(int minCapacity) {
    modCount++;
    // overflow-conscious code
    // 若是添加新元素須要的最小容量大於數組的長度，就須要擴容
    if (minCapacity - elementData.length > 0)
        grow(minCapacity);
}複製代碼

看下擴容的方法grow(int minCapacity)：

private void grow(int minCapacity) {
    // overflow-conscious code
    int oldCapacity = elementData.length;
    // 擴展至新的容量newCapacity爲舊的容量的1.5倍
    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);
}複製代碼

數組擴容的過程，其實是新建了一個須要擴容的長度的數組，而後將原素組中的元素拷貝到這個新建的數組中，新的數組指定爲ArrayList內部數據集數組。

總結：ArrayList在添加元素時，首先會判斷添加的位置是否在內部數組中越界，若是越界，拋出異常；若是沒有越界，則判斷數組可否放得下新添加的元素，若是放得下，則直接存放到數組中；若是放不下，則將數組擴容，擴容後再存放到數組中。

remove方法：

public E remove(int index) {
    // 檢查越界
    rangeCheck(index);
    modCount++;
    // 須要移除的元素
    E oldValue = elementData(index);
    // 須要移動位置的元素的數量
    int numMoved = size - index - 1;
    // 將須要移除元素的位置後的全部元素複製到index位置開始後的numMoved個位置
    if (numMoved > 0)
        System.arraycopy(elementData, index+1, elementData, index,
                         numMoved);
    // size減1，並將以前的最後一個位置元素置空
    elementData[--size] = null; // clear to let GC do its work
    return oldValue;
}複製代碼

remove還有一個重載的方法，是移除給定的元素，它的實現就是遍歷數組，找到元素的索引值，而後調用remove(int index)方法，根據索引值去刪除。

總結：ArrayList在刪除元素時，根據刪除的索引值判斷是否越界，若是越界，拋出異常；若是沒有越界，取出要刪除的元素，而後將這個元素後面全部的元素向前移動一位。

set方法：

public E set(int index, E element) {
    rangeCheck(index);
    E oldValue = elementData(index);
    elementData[index] = element;
    return oldValue;
}複製代碼

set方法即修改列表中指定位置的元素值。它的實現很是簡單：直接修改數組指定位置的值。

get方法：

public E get(int index) {
    rangeCheck(index);
    return elementData(index);
}

E elementData(int index) {
    return (E) elementData[index];
}複製代碼

get方法實現很是簡單隻須要堆獲取位置判斷是否越界，而後直接從數組中取值便可。

從上面分析的源碼中能夠看出，ArrayList的實現就是對數組的操做，在添加和刪除元素的時候，會涉及到數組的擴容和數組元素位置的移動，相對查詢和修改元素要複雜一些，因此ArrayList適合用在查詢和修改比較頻繁，而添加和刪除較少的狀況下。