Java類集框架 —— ArrayList原始碼分析

xiaoyanger發表於2019-01-16
Java框架原始碼

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適合用在查詢和修改比較頻繁，而新增和刪除較少的情況下。

相關文章