面試必會之ArrayList源碼分析&手寫ArrayList

簡介

ArrayList是我們開發中非常常用的數據存儲容器之一，其底層是數組實現的，我們可以在集合中存儲任意類型的數據，ArrayList是線程不安全的，非常適合用於對元素進行查找，效率非常高。

線程安全性

對ArrayList的操作一般分為兩個步驟，改變位置(size)和操作元素(e)。所以這個過程在多線程的環境下是不能保證具有原子性的，因此ArrayList在多線程的環境下是線程不安全的。

源碼分析

1. 屬性分析

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

/**
 * 如果自定義容量為0，則會默認用它來初始化ArrayList。或者用於空數組替換。
 */
private static final Object[] EMPTY_ELEMENTDATA = {};

/**
 * 如果沒有自定義容量，則會使用它來初始化ArrayList。或者用於空數組比對。
 */
private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};

/**
 * 這就是ArrayList底層用到的數組

 * 非私有，以簡化嵌套類訪問
 * transient 在已經實現序列化的類中，不允許某變量序列化
 */
transient Object[] elementData;

/**
 * 實際ArrayList集合大小
 */
private int size;

/**
 * 可分配的最大容量
 */
private static final int MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8;

---

擴展：什么是序列化

序列化是指：將對象轉換成以字節序列的形式來表示，以便用於持久化和傳輸。

實現方法：實現Serializable接口。

然后用的時候拿出來進行反序列化即可又變成Java對象。

---

transient關鍵字解析

Java中transient關鍵字的作用，簡單地說，就是讓某些被修飾的成員屬性變量不被序列化。

有了transient關鍵字聲明，則這個變量不會參與序列化操作，即使所在類實現了Serializable接口，反序列化后該變量為空值。

那么問題來了：ArrayList中數組聲明：transient Object[] elementData;，事實上我們使用ArrayList在網絡傳輸用的很正常，並沒有出現空值。

原來：ArrayList在序列化的時候會調用writeObject()方法，將size和element寫入ObjectOutputStream；反序列化時調用readObject()，從ObjectInputStream獲取size和element，再恢復到elementData。

那為什么不直接用elementData來序列化，而采用上訴的方式來實現序列化呢？

原因在於elementData是一個緩存數組，它通常會預留一些容量，等容量不足時再擴充容量，那么有些空間可能就沒有實際存儲元素，采用上訴的方式來實現序列化時，就可以保證只序列化實際存儲的那些元素，而不是整個數組，從而節省空間和時間。

所以ArrayList的設計者將elementData設計為transient，然后在writeObject方法中手動將其序列化，並且只序列化了實際存儲的那些元素，而不是整個數組。

見源碼：

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

從源碼中，可以觀察到 循環時是使用i<size而不是 i<elementData.length，說明序列化時，只需實際存儲的那些元素，而不是整個數組。

 

2. 構造方法分析

根據initialCapacity 初始化一個空數組，如果值為0，則初始化一個空數組:

/**
 * 根據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);
    }
}

不帶參數初始化，默認容量為10:

/**
 * 不帶參數初始化，默認容量為10
 */
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;
    }
}

3. 主干方法

trimToSize()方法：

用來最小化實例存儲，將容器大小調整為當前元素所占用的容量大小。

/**
 * 這個方法用來最小化實例存儲。
 */
public void trimToSize() {
    modCount++;
    if (size < elementData.length) {
        elementData = (size == 0)
          ? EMPTY_ELEMENTDATA
          : Arrays.copyOf(elementData, size);
    }
}

clone()方法

用來克隆出一個新數組。

public Object clone() {
    try {
        ArrayList<?> v = (ArrayList<?>) super.clone();
        v.elementData = Arrays.copyOf(elementData, size);
        v.modCount = 0;
        return v;
    } catch (CloneNotSupportedException e) {
        // this shouldn't happen, since we are Cloneable
        throw new InternalError(e);
    }
}

通過調用Object的clone()方法來得到一個新的ArrayList對象，然后將elementData復制給該對象並返回。

add(E e)方法

在數組末尾添加元素

/**
 * 在數組末尾添加元素
 */
public boolean add(E e) {
    ensureCapacityInternal(size + 1);  // Increments modCount!!
    elementData[size++] = e;
    return true;
}

看到它首先調用了ensureCapacityInternal()方法.注意參數是size+1,這是個面試考點。

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

這個方法里又嵌套調用了兩個方法:計算容量+確保容量

計算容量：如果elementData是空，則返回默認容量10和size+1的最大值，否則返回size+1

private static int calculateCapacity(Object[] elementData, int minCapacity) {
    if (elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA) {
        return Math.max(DEFAULT_CAPACITY, minCapacity);
    }
    return minCapacity;
}

計算完容量后，進行確保容量可用：(modCount不用理它，它用來計算修改次數)

如果size+1 > elementData.length證明數組已經放滿，則增加容量，調用grow()。

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

    // overflow-conscious code
    if (minCapacity - elementData.length > 0)
        grow(minCapacity);
}

增加容量：默認1.5倍擴容。

1. 獲取當前數組長度=>oldCapacity

2. oldCapacity>>1 表示將oldCapacity右移一位(位運算)，相當於除2。再加上1，相當於新容量擴容1.5倍。

3. 如果newCapacity<mincapacity`，則`newcapacity mincapacity="size+1=2" elementdata="1" newcapacity="1+1""">&gt;1=1,1<2所以如果不處理該情況，擴容將不能正確完成。

4. 如果新容量比最大值還要大，則將新容量賦值為VM要求最大值。

5. 將elementData拷貝到一個新的容量中。

 

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

---

size+1的問題

好了，那到這里可以說一下為什么要size+1。

size+1代表的含義是：

1. 如果集合添加元素成功后，集合中的實際元素個數。

2. 為了確保擴容不會出現錯誤。

假如不加一處理，如果默認size是0，則0+0>>1還是0。
如果size是1，則1+1>>1還是1。有人問:不是默認容量大小是10嗎?事實上，jdk1.8版本以后，ArrayList的擴容放在add()方法中。之前放在構造方法中。我用的是1.8版本，所以默認ArrayList arrayList = new ArrayList();后，size應該是0.所以,size+1對擴容來講很必要.

public static void main(String[] args) {
    ArrayList arrayList = new ArrayList();
    System.out.println(arrayList.size());
}

輸出:0

事實上上面的代碼是證明不了容量大小的，因為size只會在調用add()方法時才會自增。有辦法的小伙伴可以在評論區大顯神通。

---

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

rangeCheckForAdd()是越界異常檢測方法。ensureCapacityInternal()之前有講，着重說一下System.arrayCopy方法：

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

代碼解釋:

• Object src : 原數組

• int srcPos : 從元數據的起始位置開始

• Object dest : 目標數組

• int destPos : 目標數組的開始起始位置

• int length : 要copy的數組的長度

示例：size為6，我們調用add(2,element)方法，則會從index=2+1=3的位置開始，將數組元素替換為從index起始位置為index=2，長度為6-2=4的數據。

異常處理：

private void rangeCheckForAdd(int index) {
    if (index > size || index < 0)
        throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
}

set(int index,E element)方法

public E set(int index, E element) {
    rangeCheck(index);

    E oldValue = elementData(index);
    elementData[index] = element;
    return oldValue;
}

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

邏輯很簡單，覆蓋舊值並返回。

indexOf(Object o)方法

根據Object對象獲取數組中的索引值。

public int indexOf(Object o) {
    if (o == null) {
        for (int i = 0; i < size; i++)
            if (elementData[i]==null)
                return i;
    } else {
        for (int i = 0; i < size; i++)
            if (o.equals(elementData[i]))
                return i;
    }
    return -1;
}

如果o為空，則返回數組中第一個為空的索引；不為空也類似。

注意：通過源碼可以看到，該方法是允許傳空值進來的。

get(int index)方法

返回指定下標處的元素的值。

public E get(int index) {
    rangeCheck(index);

    return elementData(index);
}

rangeCheck(index)會檢測index值是否合法，如果合法則返回索引對應的值。

remove(int index)方法

刪除指定下標的元素。

public E remove(int index) {
    // 檢測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;
}

這里又碰到了System.arraycopy()方法，詳情請查閱上文。

大概思路：將該元素后面的元素前移，最后一個元素置空。

ArrayList優缺點

優點：

1. 因為其底層是數組，所以修改和查詢效率高。

2. 可自動擴容(1.5倍)。

缺點：

1. 插入和刪除效率不高。

2. 線程不安全。

手寫ArrayList

那面試手寫ArrayList應該就不是問題了。

下面貼出我手寫的一個簡單閹割版的ArrayList：

public class MyArrayList {

    // 非私有，以簡化嵌套類訪問
    // transient 在已經實現序列化的類中，不允許某變量序列化
    transient Object[] elementData;

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

    // 用於空實例的 空數組實例
    private static final Object[] EMPTY_ELEMENTDATA = {};

    private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};
    // 實際ArrayList集合大小
    private int size;
    /**
     * 構造方法
     */
    public MyArrayList(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 MyArrayList(){
        this(DEFAULT_CAPACITY);
    }

    public void add(Object o){
        //1. 判斷數據容量是否大於 elementData
        ensureExplicitCapacity(size+1);
        //2. 使用下標進行賦值
        elementData[size++] = o;
    }
    private void ensureExplicitCapacity(int minCapacity){
        if (size == elementData.length){
            // 需要擴容,擴容1.5倍(ArrayList默認擴容1.5倍)
            // 注意：如果oldCapacity值為1
            int oldCapacity = elementData.length;
            int newCapacity = oldCapacity + (oldCapacity >> 1);
            // 如果新容量 < 最小容量， 則將最小容量賦值給新容量
            // 如果 oldCapacity=1, 則 minCapacity=1+1=2   newCapacity=1+(1>>1)=1
            if (newCapacity - minCapacity < 0){
                newCapacity = minCapacity;
            }
            // 創建新數組
            Object[] objects = new Object[newCapacity];
            // 將數據復制給新數組
            System.arraycopy(elementData, 0, objects, 0, elementData.length);
            // 修改引用
            elementData = objects;
        }
    }
    public Object get(int index) {
        rangeCheck(index);
        return elementData[index];
    }
    private void rangeCheck(int index) {
        if (index >= size)
            throw new IndexOutOfBoundsException("下標越界");
    }

    /**
     * 通過下標刪除
     * @param index
     * @return
     */
    public Object remove(int index) {
        rangeCheck(index);

//        modCount++;
        // 先查出元素
        Object oldValue = elementData[index];
        // 找出置換結束位置
        int numMoved = size - index - 1;
        if (numMoved > 0)
            // 從 index+1 開始 將值覆蓋為 index-numMoved 的值
            System.arraycopy(elementData, index+1, elementData, index, numMoved);
        elementData[--size] = null; // clear to let GC do its work

        return oldValue;
    }
    public boolean remove(Object o) {
            for (int index = 0; index < size; index++){
                if (o.equals(elementData[index])) {
                    remove(index);
                    return true;
                }
            }
        return false;
    }
}