一文徹底弄懂ArrayList原始碼

初念初戀發表於2022-02-10

前言

ArrayList是一種以陣列實現的List,與陣列相比,它具有動態擴充套件的能力,因此也可稱之為動態陣列。

在ArrayList集合裡面可以儲存任何型別的資料, 而且它是一個順序容器,存放的資料順序就是和我們放入的順序是一致的,而且它還允許我們放入null元素。

繼承體系

public class ArrayList<E> extends AbstractList<E>
        implements List<E>, RandomAccess, Cloneable, java.io.Serializable
{...}
  • ArrayList實現了List,提供了基礎的新增、刪除、遍歷等操作。
  • ArrayList實現了RandomAccess,提供了隨機訪問的能力。
  • ArrayList實現了Cloneable,可以被克隆。
  • ArrayList實現了Serializable,可以被序列化。

原始碼解析

屬性

/**
 * 預設容量
 */
private static final int DEFAULT_CAPACITY = 10;

/**
 * 空陣列,如果傳入的容量為0時使用
 */
private static final Object[] EMPTY_ELEMENTDATA = {};

/**
 * 空陣列,傳傳入容量時使用,新增第一個元素的時候會重新初始為預設容量大小
 */
private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};

/**
 * 儲存元素的陣列
 */
transient Object[] elementData; // non-private to simplify nested class access

/**
 * 集合中元素的個數
 */
private int size;

(1)DEFAULT_CAPACITY:預設容量為10,也就是通過new ArrayList()建立時的預設容量。

(2)EMPTY_ELEMENTDATA:空的陣列,這種是通過new ArrayList(0)建立時用的是這個空陣列。

(3)DEFAULTCAPACITY_EMPTY_ELEMENTDATA:也是空陣列,這種是通過new ArrayList()建立時用的是這個空陣列,與EMPTY_ELEMENTDATA的區別是在新增第一個元素時使用這個空陣列的會初始化為DEFAULT_CAPACITY(10)個元素。

(4)elementData:真正存放元素的地方。

(5)size:真正儲存元素的個數,而不是elementData陣列的長度。

為什麼ArrayList的elementData陣列要加上transient修飾?

由於ArrayList有自動擴容機制,所以ArrayList的elementData陣列大小往往比現有的元素數量大,如果不加transient直接序列化的話會把陣列中空餘的位置也序列化了,浪費不少的空間。

ArrayList中重寫了序列化和反序列化對應的writeObjectreadObject方法,在遍歷陣列元素時,以 size 作為結束標誌,只序列化ArrayList中已經存在的元素。

ArrayList(int initialCapacity)構造方法

public ArrayList(int initialCapacity) {
    if (initialCapacity > 0) {
        // 如果傳入的初始容量大於0,就新建一個陣列儲存元素
        this.elementData = new Object[initialCapacity];
    } else if (initialCapacity == 0) {
        // 如果傳入的初始容量等於0,使用空陣列EMPTY_ELEMENTDATA
        this.elementData = EMPTY_ELEMENTDATA;
    } else {
        // 如果傳入的初始容量小於0,丟擲異常
        throw new IllegalArgumentException("Illegal Capacity: " + initialCapacity);
    }
}

ArrayList()構造方法

public ArrayList() {
    // 如果沒有傳入初始容量,則使用空陣列DEFAULTCAPACITY_EMPTY_ELEMENTDATA
    // 使用這個陣列是在新增第一個元素的時候會擴容到預設大小10
    this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;
}

ArrayList 構造方法

/**
* 把傳入集合的元素初始化到ArrayList中
*/
public ArrayList(Collection<? extends E> c) {
    // 集合轉陣列
    elementData = c.toArray();
    if ((size = elementData.length) != 0) {
        // 檢查c.toArray()返回的是不是Object[]型別,如果不是,重新拷貝成Object[].class型別
        if (elementData.getClass() != Object[].class)
            elementData = Arrays.copyOf(elementData, size, Object[].class);
    } else {
        // 如果c的空集合,則初始化為空陣列EMPTY_ELEMENTDATA
        this.elementData = EMPTY_ELEMENTDATA;
    }
}

add(E e)方法

新增元素到末尾,平均時間複雜度為O(1)。

public boolean add(E e) {
    // 檢查是否需要擴容
    ensureCapacityInternal(size + 1);
    // 把元素插入到最後一位
    elementData[size++] = e;
    return true;
}

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

private static int calculateCapacity(Object[] elementData, int minCapacity) {
    // 如果是空陣列DEFAULTCAPACITY_EMPTY_ELEMENTDATA,就初始化為預設大小10
    if (elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA) {
        return Math.max(DEFAULT_CAPACITY, minCapacity);
    }
    return minCapacity;
}

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

    if (minCapacity - elementData.length > 0)
        // 擴容
        grow(minCapacity);
}

private void grow(int minCapacity) {
    int oldCapacity = elementData.length;
    // 新容量為舊容量的1.5倍
    int newCapacity = oldCapacity + (oldCapacity >> 1);
    // 如果新容量發現比需要的容量還小,則以需要的容量為準
    if (newCapacity - minCapacity < 0)
        newCapacity = minCapacity;
    // 如果新容量已經超過最大容量了,則使用最大容量
    if (newCapacity - MAX_ARRAY_SIZE > 0)
        newCapacity = hugeCapacity(minCapacity);
    // 以新容量拷貝出來一個新陣列
    elementData = Arrays.copyOf(elementData, newCapacity);
}

add(int index, E element)方法

新增元素到指定位置,平均時間複雜度為O(n)。

public void add(int index, E element) {
    // 檢查是否越界
    rangeCheckForAdd(index);
    // 檢查是否需要擴容
    ensureCapacityInternal(size + 1);
    // 將inex及其之後的元素往後挪一位,則index位置處就空出來了
    System.arraycopy(elementData, index, elementData, index + 1,
                     size - index);
    // 將元素插入到index的位置
    elementData[index] = element;
    // 大小增1
    size++;
}

private void rangeCheckForAdd(int index) {
    if (index > size || index < 0)
        throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
}
ArrayList在新增的時候為什麼慢?

通過以上的原始碼,我們可以看出ArrayList有指定index新增,也有直接新增的,在這之前他會有一步校驗長度的判斷ensureCapacityInternal,就是說如果長度不夠,是需要擴容的。

在擴容的時候,老版本的jdk和8以後的版本是有區別的,8之後的效率更高了,採用了位運算,右移一位,其實就是除以2這個操作。int newCapacity = oldCapacity + (oldCapacity >> 1);新增後的陣列容量是舊陣列容量的1.5倍。

指定位置新增的時候,在校驗之後的操作很簡單,就是陣列的copy,System.arraycopy(elementData, index, elementData, index + 1, size - index);,為了更好的解釋,這裡畫個圖,如下:

比如有下面這樣一個陣列我需要在index 4 的位置去新增一個元素 a

image-20220210143840488

從程式碼裡面我們可以看到,它複製了一個陣列,是從index 4 的位置開始的,然後把它放在了index 4+1 的位置

給我們要新增的元素騰出了位置,然後在index的位置放入元素a就完成了新增的操作了。

image-20220210144404415

這只是在一個這麼小的List裡面操作,要是我去一個幾百幾千幾萬大小的List新增一個元素,那就需要後面所有的元素都複製,然後如果再涉及到擴容啥的就更慢了不是嘛。

addAll 方法

求兩個集合的並集。

/**
* 將集合c中所有元素新增到當前ArrayList中
*/
public boolean addAll(Collection<? extends E> c) {
    // 將集合c轉為陣列
    Object[] a = c.toArray();
    int numNew = a.length;
    // 檢查是否需要擴容
    ensureCapacityInternal(size + numNew);
    // 將c中元素全部拷貝到陣列的最後
    System.arraycopy(a, 0, elementData, size, numNew);
    // 大小增加c的大小
    size += numNew;
    // 如果c不為空就返回true,否則返回false
    return numNew != 0;
}

get(int index)方法

獲取指定索引位置的元素,時間複雜度為O(1)。

public E get(int index) {
    // 檢查是否越界
    rangeCheck(index);
    // 返回陣列index位置的元素
    return elementData(index);
}

private void rangeCheck(int index) {
    if (index >= size)
        throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
}

E elementData(int index) {
    return (E) elementData[index];
}

(1)檢查索引是否越界,這裡只檢查是否越上界,如果越上界丟擲IndexOutOfBoundsException異常,如果越下界丟擲的是ArrayIndexOutOfBoundsException異常。

(2)返回索引位置處的元素;

remove(int index)方法

刪除指定索引位置的元素,時間複雜度為O(n)。

public E remove(int index) {
    // 檢查是否越界
    rangeCheck(index);

    modCount++;
    // 獲取index位置的元素
    E oldValue = elementData(index);

    // 如果index不是最後一位,則將index之後的元素往前挪一位
    int numMoved = size - index - 1;
    if (numMoved > 0)
        System.arraycopy(elementData, index+1, elementData, index, numMoved);

    // 將最後一個元素刪除,幫助GC
    elementData[--size] = null; // clear to let GC do its work

    // 返回舊值
    return oldValue;
}

remove(Object o)方法

刪除指定元素值的元素,時間複雜度為O(n)。

public boolean remove(Object o) {
    if (o == null) {
        // 遍歷整個陣列,找到元素第一次出現的位置,並將其快速刪除
        for (int index = 0; index < size; index++)
            // 如果要刪除的元素為null,則以null進行比較,使用==
            if (elementData[index] == null) {
                fastRemove(index);
                return true;
            }
    } else {
        // 遍歷整個陣列,找到元素第一次出現的位置,並將其快速刪除
        for (int index = 0; index < size; index++)
            // 如果要刪除的元素不為null,則進行比較,使用equals()方法
            if (o.equals(elementData[index])) {
                fastRemove(index);
                return true;
            }
    }
    return false;
}

private void fastRemove(int index) {
    // 少了一個越界的檢查
    modCount++;
    // 如果index不是最後一位,則將index之後的元素往前挪一位
    int numMoved = size - index - 1;
    if (numMoved > 0)
        System.arraycopy(elementData, index+1, elementData, index, numMoved);
    // 將最後一個元素刪除,幫助GC
    elementData[--size] = null; // clear to let GC do its work
}

(1)找到第一個等於指定元素值的元素;

(2)快速刪除,fastRemove(int index)相對於remove(int index)少了檢查索引越界的操作。

retainAll方法

求兩個集合的交集。

public boolean retainAll(Collection<?> c) {
    // 集合c不能為null
    Objects.requireNonNull(c);
    // 呼叫批量刪除方法,這時complement傳入true,表示刪除不包含在c中的元素
    return batchRemove(c, true);
}

/**
* 批量刪除元素
* complement為true表示刪除c中不包含的元素
* complement為false表示刪除c中包含的元素
*/
private boolean batchRemove(Collection<?> c, boolean complement) {
    final Object[] elementData = this.elementData;
    // 使用讀寫兩個指標同時遍歷陣列
    // 讀指標每次自增1,寫指標放入元素的時候才加1
    // 這樣不需要額外的空間,只需要在原有的陣列上操作就可以了
    int r = 0, w = 0;
    boolean modified = false;
    try {
        // 遍歷整個陣列,如果c中包含該元素,則把該元素放到寫指標的位置(以complement為準)
        for (; r < size; r++)
            if (c.contains(elementData[r]) == complement)
                elementData[w++] = elementData[r];
    } finally {
        // 正常來說r最後是等於size的,除非c.contains()丟擲了異常
        if (r != size) {
            // 如果c.contains()丟擲了異常,則把未讀的元素都拷貝到寫指標之後
            System.arraycopy(elementData, r,
                             elementData, w,
                             size - r);
            w += size - r;
        }
        if (w != size) {
            // 將寫指標之後的元素置為空,幫助GC
            for (int i = w; i < size; i++)
                elementData[i] = null;
            modCount += size - w;
            // 新大小等於寫指標的位置(因為每寫一次寫指標就加1,所以新大小正好等於寫指標的位置)
            size = w;
            modified = true;
        }
    }
    // 有修改返回true
    return modified;
}

(1)遍歷elementData陣列;

(2)如果元素在 c 中,則把這個元素新增到 elementData 陣列的 w 位置並將 w 位置往後移一位;

(3)遍歷完之後,w 之前的元素都是兩者共有的,w 之後(包含)的元素不是兩者共有的;

(4)將 w 之後(包含)的元素置為null,方便 GC 回收;

removeAll

求兩個集合的單方向差集,只保留當前集合中不在c中的元素,不保留在c中不在當前集體中的元素。

public boolean removeAll(Collection<?> c) {
    // 集合c不能為空
    Objects.requireNonNull(c);
    // 同樣呼叫批量刪除方法,這時complement傳入false,表示刪除包含在c中的元素
    return batchRemove(c, false);
}

retainAll(Collection<?> c)方法類似,只是這裡保留的是不在c中的元素。

總結

(1)ArrayList內部使用陣列儲存元素,擴容時,每次加一半的空間,ArrayList不會進行縮容。

(2)ArrayList支援隨機訪問,通過索引訪問元素極快,時間複雜度為O(1)。

(3)ArrayList新增元素到尾部極快,平均時間複雜度為O(1)。

(4)ArrayList新增元素到中間比較慢,因為要搬移元素,平均時間複雜度為O(n)。

(5)ArrayList從尾部刪除元素極快,時間複雜度為O(1)。

(6)ArrayList從中間刪除元素比較慢,因為要搬移元素,平均時間複雜度為O(n)。

(7)ArrayList支援求並集,呼叫addAll(Collection<? extends E> c)方法即可。

(8)ArrayList支援求交集,呼叫retainAll(Collection<? extends E> c)方法即可。

(7)ArrayList支援求單向差集,呼叫removeAll(Collection<? extends E> c)方法即可。

相關文章