面試必備：ArrayList原始碼解析（JDK8）

mcxtzhang發表於2017-08-17
面試原始碼JDK

想看我更多文章:【張旭童的部落格】blog.csdn.net/zxt0601
想來gayhub和我gaygayup:【mcxtzhang的Github主頁】github.com/mcxtzhang

概述

很久沒有寫部落格了，準確的說17年以來寫部落格的頻率降低到一個不忍直視的水平。這個真不怪我，給大家解釋一下。
一是自從做了leader，整天各種事，開會，過需求，無限迴圈。心很累，時間也被無線壓榨
二 我本身也在學習一些其他的技術，比如ReactNative，也看了半天的kotlin，擼了幾個groovy指令碼、gradle外掛。
三 是打算找工作了。又要開始複習資料結構和演算法。

得，腦海中有很多躺了無數天的，甚至半成稿的部落格，比如元件化、Rxjava一些使用注意點，都被我擱置delay了。
這眼瞧著，很久沒寫了，寫點啥吧。

正巧最近在看jdk的Collection集合原始碼，這種單個類的原始碼解析，寫起來還算比較方便。
關鍵程式碼處加上註釋，核心處做個總結，就可以成文，拿出來和大家討論分享。
且網上絕大多數都是JDK7甚至之前的原始碼解析文章。我們們也要與時俱進。
這似乎是我回歸部落格的一個不錯選擇。

那下面就跟我一起擼起ArrayList的原始碼吧。

本文將從幾個常用方法下手，來閱讀ArrayList的原始碼。
按照從構造方法->常用API（增、刪、改、查）的順序來閱讀原始碼，並會講解閱讀方法中涉及的一些變數的意義。瞭解ArrayList的特點、適用場景。

如果本文中有不正確的結論、說法，請大家提出和我討論，共同進步，謝謝。

概要

概括的說，ArrayList 是一個動態陣列，它是執行緒不安全的，允許元素為null。
其底層資料結構依然是陣列，它實現了List<E>, RandomAccess, Cloneable, java.io.Serializable介面，其中RandomAccess代表了其擁有隨機快速訪問的能力，ArrayList可以以O(1)的時間複雜度去根據下標訪問元素。

因其底層資料結構是陣列，所以可想而知，它是佔據一塊連續的記憶體空間（容量就是陣列的length），所以它也有陣列的缺點，空間效率不高。

由於陣列的記憶體連續，可以根據下標以O1的時間讀寫(改查)元素，因此時間效率很高。

當集合中的元素超出這個容量，便會進行擴容操作。擴容操作也是ArrayList 的一個效能消耗比較大的地方，所以若我們可以提前預知資料的規模，應該通過public ArrayList(int initialCapacity) {}構造方法，指定集合的大小，去構建ArrayList例項，以減少擴容次數，提高效率。

或者在需要擴容的時候，手動呼叫public void ensureCapacity(int minCapacity) {}方法擴容。
不過該方法是ArrayList的API，不是List介面裡的，所以使用時需要強轉:
((ArrayList)list).ensureCapacity(30);

當每次修改結構時，增加導致擴容，或者刪，都會修改modCount。

構造方法

    //預設建構函式裡的空陣列
    private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};

    //儲存集合元素的底層實現：真正存放元素的陣列
    transient Object[] elementData; // non-private to simplify nested class access
    //當前元素數量
    private int size;

    //預設構造方法
    public ArrayList() {
        //預設構造方法只是簡單的將 空陣列賦值給了elementData
        this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;
    }

    //空陣列
    private static final Object[] EMPTY_ELEMENTDATA = {};
    //帶初始容量的構造方法
    public ArrayList(int initialCapacity) {
        //如果初始容量大於0，則新建一個長度為initialCapacity的Object陣列.
        //注意這裡並沒有修改size(對比第三個建構函式)
        if (initialCapacity > 0) {
            this.elementData = new Object[initialCapacity];
        } else if (initialCapacity == 0) {//如果容量為0，直接將EMPTY_ELEMENTDATA賦值給elementData
            this.elementData = EMPTY_ELEMENTDATA;
        } else {//容量小於0，直接丟擲異常
            throw new IllegalArgumentException("Illegal Capacity: "+
                                               initialCapacity);
        }
    }

    //利用別的集合類來構建ArrayList的建構函式
    public ArrayList(Collection<? extends E> c) {
        //直接利用Collection.toArray()方法得到一個物件陣列，並賦值給elementData 
        elementData = c.toArray();
        //因為size代表的是集合元素數量，所以通過別的集合來構造ArrayList時，要給size賦值
        if ((size = elementData.length) != 0) {
            // c.toArray might (incorrectly) not return Object[] (see 6260652)
            if (elementData.getClass() != Object[].class)//這裡是當c.toArray出錯，沒有返回Object[]時，利用Arrays.copyOf 來複制集合c中的元素到elementData陣列中
                elementData = Arrays.copyOf(elementData, size, Object[].class);
        } else {
            //如果集合c元素數量為0，則將空陣列EMPTY_ELEMENTDATA賦值給elementData 
            // replace with empty array.
            this.elementData = EMPTY_ELEMENTDATA;
        }
    }複製程式碼

小結一下，建構函式走完之後，會構建出陣列elementData和數量size。

這裡大家要注意一下Collection.toArray()這個方法，在Collection子類各大集合的原始碼中，高頻使用了這個方法去獲得某Collection的所有元素。

關於方法：Arrays.copyOf(elementData, size, Object[].class)，就是根據class的型別來決定是new 還是反射去構造一個泛型陣列，同時利用native函式，批量賦值元素至新陣列中。
如下：

    public static <T,U> T[] copyOf(U[] original, int newLength, Class<? extends T[]> newType) {
        @SuppressWarnings("unchecked")
        //根據class的型別來決定是new 還是反射去構造一個泛型陣列
        T[] copy = ((Object)newType == (Object)Object[].class)
            ? (T[]) new Object[newLength]
            : (T[]) Array.newInstance(newType.getComponentType(), newLength);
        //利用native函式，批量賦值元素至新陣列中。
        System.arraycopy(original, 0, copy, 0,
                         Math.min(original.length, newLength));
        return copy;
    }複製程式碼

值得注意的是，System.arraycopy也是一個很高頻的函式，大家要留意一下。

    public static native void arraycopy(Object src,  int  srcPos,
                                        Object dest, int destPos,
                                        int length);複製程式碼

常用API

1 增

每次 add之前，都會判斷add後的容量，是否需要擴容。

public boolean add(E e) {
    ensureCapacityInternal(size + 1);  // Increments modCount!!
    elementData[size++] = e;//在陣列末尾追加一個元素，並修改size
    return true;
}
    private static final int DEFAULT_CAPACITY = 10;//預設擴容容量 10
    private void ensureCapacityInternal(int minCapacity) {
        //利用 == 可以判斷陣列是否是用預設建構函式初始化的
        if (elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA) {
            minCapacity = Math.max(DEFAULT_CAPACITY, minCapacity);
        }

        ensureExplicitCapacity(minCapacity);
    }


private void ensureExplicitCapacity(int minCapacity) {
    modCount++;//如果確定要擴容，會修改modCount 

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

//需要擴容的話，預設擴容一半
private void grow(int minCapacity) {
    // overflow-conscious code
    int oldCapacity = elementData.length;
    int newCapacity = oldCapacity + (oldCapacity >> 1);//預設擴容一半
    if (newCapacity - minCapacity < 0)//如果還不夠 ，那麼就用 能容納的最小的數量。（add後的容量）
        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);//拷貝，擴容，構建一個新陣列，
}複製程式碼

public void add(int index, E element) {
    rangeCheckForAdd(index);//越界判斷 如果越界拋異常

    ensureCapacityInternal(size + 1);  // Increments modCount!!
    System.arraycopy(elementData, index, elementData, index + 1,
                     size - index); //將index開始的資料 向後移動一位
    elementData[index] = element;
    size++;
}複製程式碼
public boolean addAll(Collection<? extends E> c) {
    Object[] a = c.toArray();
    int numNew = a.length;
    ensureCapacityInternal(size + numNew);  // Increments modCount //確認是否需要擴容
    System.arraycopy(a, 0, elementData, size, numNew);// 複製陣列完成複製
    size += numNew;
    return numNew != 0;
}複製程式碼
public boolean addAll(int index, Collection<? extends E> c) {
    rangeCheckForAdd(index);//越界判斷

    Object[] a = c.toArray();
    int numNew = a.length;
    ensureCapacityInternal(size + numNew);  // Increments modCount //確認是否需要擴容

    int numMoved = size - index;
    if (numMoved > 0)
        System.arraycopy(elementData, index, elementData, index + numNew,
                         numMoved);//移動（複製)陣列

    System.arraycopy(a, 0, elementData, index, numNew);//複製陣列完成批量賦值
    size += numNew;
    return numNew != 0;
}複製程式碼

總結：
add、addAll。
先判斷是否越界，是否需要擴容。
如果擴容， 就複製陣列。
然後設定對應下標元素值。

值得注意的是：
1 如果需要擴容的話，預設擴容一半。如果擴容一半不夠，就用目標的size作為擴容後的容量。
2 在擴容成功後，會修改modCount

2 刪

public E remove(int index) {
    rangeCheck(index);//判斷是否越界
    modCount++;//修改modeCount 因為結構改變了
    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  //置空原尾部資料 不再強引用， 可以GC掉
    return oldValue;
}
    //根據下標從陣列取值 並強轉
    E elementData(int index) {
        return (E) elementData[index];
    }

//刪除該元素在陣列中第一次出現的位置上的資料。 如果有該元素返回true，如果false。
public boolean remove(Object o) {
    if (o == null) {
        for (int index = 0; index < size; index++)
            if (elementData[index] == null) {
                fastRemove(index);//根據index刪除元素
                return true;
            }
    } else {
        for (int index = 0; index < size; index++)
            if (o.equals(elementData[index])) {
                fastRemove(index);
                return true;
            }
    }
    return false;
}
//不會越界 不用判斷 ，也不需要取出該元素。
private void fastRemove(int index) {
    modCount++;//修改modCount
    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  //置空 不再強引用
}

//批量刪除
public boolean removeAll(Collection<?> c) {
    Objects.requireNonNull(c);//判空
    return batchRemove(c, false);
}
//批量移動
private boolean batchRemove(Collection<?> c, boolean complement) {
    final Object[] elementData = this.elementData;
    int r = 0, w = 0;//w 代表批量刪除後 陣列還剩多少元素
    boolean modified = false;
    try {
        //高效的儲存兩個集合公有元素的演算法
        for (; r < size; r++)
            if (c.contains(elementData[r]) == complement) // 如果 c裡不包含當前下標元素， 
                elementData[w++] = elementData[r];//則保留
    } finally {
        // Preserve behavioral compatibility with AbstractCollection,
        // even if c.contains() throws.
        if (r != size) { //出現異常會導致 r !=size , 則將出現異常處後面的資料全部複製覆蓋到陣列裡。
            System.arraycopy(elementData, r,
                             elementData, w,
                             size - r);
            w += size - r;//修改 w數量
        }
        if (w != size) {//置空陣列後面的元素
            // clear to let GC do its work
            for (int i = w; i < size; i++)
                elementData[i] = null;
            modCount += size - w;//修改modCount
            size = w;// 修改size
            modified = true;
        }
    }
    return modified;
}複製程式碼

從這裡我們也可以看出，當用來作為刪除元素的集合裡的元素多餘被刪除集合時，也沒事，只會刪除它們共同擁有的元素。

小結：
1 刪除操作一定會修改modCount，且可能涉及到陣列的複製，相對低效。
2 批量刪除中，涉及高效的儲存兩個集合公有元素的演算法，可以留意一下。

3 改

不會修改modCount，相對增刪是高效的操作。

public E set(int index, E element) {
    rangeCheck(index);//越界檢查
    E oldValue = elementData(index); //取出元素 
    elementData[index] = element;//覆蓋元素
    return oldValue;//返回元素
}複製程式碼

4 查

不會修改modCount，相對增刪是高效的操作。

public E get(int index) {
    rangeCheck(index);//越界檢查
    return elementData(index); //下標取資料
}
E elementData(int index) {
    return (E) elementData[index];
}複製程式碼

5 清空，clear

會修改modCount。

public void clear() {
    modCount++;//修改modCount
    // clear to let GC do its work
    for (int i = 0; i < size; i++)  //將所有元素置null
        elementData[i] = null;

    size = 0; //修改size 
}複製程式碼

6 包含 contain

//普通的for迴圈尋找值，只不過會根據目標物件是否為null分別迴圈查詢。
public boolean contains(Object o) {
    return indexOf(o) >= 0;
}
//普通的for迴圈尋找值，只不過會根據目標物件是否為null分別迴圈查詢。
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;
}複製程式碼

7 判空 isEmpty()

public boolean isEmpty() {
    return size == 0;
}複製程式碼

8 迭代器 Iterator.

public Iterator<E> iterator() {
    return new Itr();
}
/**
 * An optimized version of AbstractList.Itr
 */
private class Itr implements Iterator<E> {
    int cursor;       // index of next element to return //預設是0
    int lastRet = -1; // index of last element returned; -1 if no such  //上一次返回的元素 (刪除的標誌位)
    int expectedModCount = modCount; //用於判斷集合是否修改過結構的 標誌

    public boolean hasNext() {
        return cursor != size;//遊標是否移動至尾部
    }

    @SuppressWarnings("unchecked")
    public E next() {
        checkForComodification();
        int i = cursor;
        if (i >= size)//判斷是否越界
            throw new NoSuchElementException();
        Object[] elementData = ArrayList.this.elementData;
        if (i >= elementData.length)//再次判斷是否越界，在 我們這裡的操作時，有非同步執行緒修改了List
            throw new ConcurrentModificationException();
        cursor = i + 1;//遊標+1
        return (E) elementData[lastRet = i];//返回元素 ，並設定上一次返回的元素的下標
    }

    public void remove() {//remove 掉 上一次next的元素
        if (lastRet < 0)//先判斷是否next過
            throw new IllegalStateException();
        checkForComodification();//判斷是否修改過

        try {
            ArrayList.this.remove(lastRet);//刪除元素 remove方法內會修改 modCount 所以後面要更新Iterator裡的這個標誌值
            cursor = lastRet; //要刪除的遊標
            lastRet = -1; //不能重複刪除 所以修改刪除的標誌位
            expectedModCount = modCount;//更新 判斷集合是否修改的標誌，
        } catch (IndexOutOfBoundsException ex) {
            throw new ConcurrentModificationException();
        }
    }
//判斷是否修改過了List的結構，如果有修改，丟擲異常
    final void checkForComodification() {
        if (modCount != expectedModCount)
            throw new ConcurrentModificationException();
    }
}複製程式碼

總結

  1. 增刪改查中， 增導致擴容，則會修改modCount，刪一定會修改。 改和查一定不會修改modCount。
  2. 擴容操作會導致陣列複製，批量刪除會導致 找出兩個集合的交集，以及陣列複製操作，因此，增、刪都相對低效。 而 改、查都是很高效的操作。
  3. 因此，結合特點，在使用中，以Android中最常用的展示列表為例，列表滑動時需要展示每一個Item（element）的陣列，所以 查 操作是最高頻的。相對來說，增操作 只有在列表載入更多時才會用到 ，而且是在列表尾部插入，所以也不需要移動資料的操作。而刪操作則更低頻。 故選用ArrayList作為儲存資料的結構。
  4. 在面試中還有可能會問到和Vector的區別，我大致看了一下Vector的原始碼，內部也是陣列做的，區別在於Vector在API上都加了synchronized所以它是執行緒安全的，以及Vector擴容時，是翻倍size，而ArrayList是擴容50%。

相關文章