Java Collection之ArrayList源碼分析

作為一個android開發(fā)者,大家在平時的開發(fā)工作當(dāng)中,一定會大量用到ArrayList來管理數(shù)據(jù)。不外乎調(diào)用它的添加,刪除等方法。但是具體怎么實(shí)現(xiàn)就不清楚了。而且,最讓我感到蛋疼的就是,很多面試的時候,面試官必然少不了深挖這些java知識,每次我都很懵逼啊有沒有。于是我們就來深入源碼了解它,揭開這層遮羞布。
好了,廢話不多說,我們開始ArrayList的學(xué)習(xí)。文章中會有大量源碼,這是避免不了的。
ArrayList是一個可以動態(tài)調(diào)整大小的List實(shí)現(xiàn),其數(shù)據(jù)的順序與插入順序始終一致,其余特性與List中定義的一致。
what?數(shù)據(jù)順序與插入順序一致?難道你底層實(shí)現(xiàn)是依靠數(shù)組嗎?我也還不知道呢。那我們繼續(xù)往下學(xué)習(xí)
我們首先看類的關(guān)系


可以看到,ArrayListAbstractList的子類,同時實(shí)現(xiàn)了List接口。除此之外,它還實(shí)現(xiàn)了三個標(biāo)識型接口,這幾個接口都沒有任何方法,僅作為標(biāo)識表示實(shí)現(xiàn)類具備某項(xiàng)功能。RandomAccess表示實(shí)現(xiàn)類支持快速隨機(jī)訪問,Cloneable表示實(shí)現(xiàn)類支持克隆,具體表現(xiàn)為重寫了clone方法,java.io.Serializable則表示支持序列化,如果需要對此過程自定義,可以重寫writeObjectreadObject方法。


我們?nèi)绻褂?code>ArrayList首先我們就要new一個,而我們通常的做法就是下面這樣:

ArrayList<String> strings = new ArrayList<>();

我們追尋這個構(gòu)造函數(shù)進(jìn)入源碼:為了方便大家觀看,我們將解釋放入到每一句代碼中。在本文中這些注釋很重要。

   /**
     * 默認(rèn)初始化容量
     */
    private static final int DEFAULT_CAPACITY = 10;

    private static final Object[] EMPTY_ELEMENTDATA = {};

    private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};

    transient Object[] elementData; // non-private to simplify nested class access
/**
     * 構(gòu)建一個指定初始容量的list
     *
     * @param  list的指定容量
     * @throws IllegalArgumentException if the specified initial capacity
     *         is negative
     */
    public ArrayList(int initialCapacity) {
        if (initialCapacity > 0) {
            //這里就可以看出,list內(nèi)部就是維護(hù)的一個基本的一維數(shù)組。并且初始化了大小。
            this.elementData = new Object[initialCapacity];
        } else if (initialCapacity == 0) {
            //elementData為空數(shù)組
            this.elementData = EMPTY_ELEMENTDATA;
        } else {
            throw new IllegalArgumentException("Illegal Capacity: "+
                                               initialCapacity);
        }
    }

    /**
     * 初始化大小為10的空數(shù)組
     */
    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;
        }
    }

我們可以看到,它擁有三個構(gòu)造方法。而我們常用的就是第二個,空參的方法。官方的解釋是我們構(gòu)建了一個空的list,初始容量為10。看到這里我們就不禁產(chǎn)生兩個思考。
我們可以看到list中維護(hù)了一個重要的elementData而它的定義是一個數(shù)組,它有什么用?
明明你構(gòu)造方法就一個簡單的賦值,而且這個變量我不知道干嘛的,哪來的10的容量?


我們先不管這兩個疑問。我們都知道數(shù)據(jù)的操作最重要的就是增刪改查,改查都不涉及長度的變化,而增刪就涉及到動態(tài)調(diào)整大小的問題。
我們就從這四個方面再來分析分析源碼:

我們首先看添加元素:

 public boolean add(E e) {
        ensureCapacityInternal(size + 1);  // Increments modCount!!
        //這里不就是添加數(shù)據(jù)了?????
        elementData[size++] = e;
        return true;
    }

public void add(int index, E element) {
        if (index > size || index < 0)
            throw new IndexOutOfBoundsException(outOfBoundsMsg(index));

        ensureCapacityInternal(size + 1);  // Increments modCount!!
        System.arraycopy(elementData, index, elementData, index + 1,
                         size - index);
        elementData[index] = element;
        size++;
    }

添加元素有兩個方法可以使用,先看第一個方法,我們一行一行的看。首先我們看到這個方法ensureCapacityInternal(size + 1);在它之后,elementData[size++] = e;將我們要插入的數(shù)據(jù)賦值給了elementData數(shù)組。
到這里我們終于可以知道,ArrayList內(nèi)部就是通過elementData數(shù)組實(shí)現(xiàn)的。并且添加數(shù)據(jù)是從位置0開始。

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

        ensureExplicitCapacity(minCapacity);
    }

我們剛創(chuàng)建一個新的ArrayList,可以知道當(dāng)?shù)谝淮握{(diào)用add方法,這里的size=0。并且滿足這里的if語句,這里minCapacity的值將變?yōu)槲覀兂跏蓟?code>10。
然后到ensureExplicitCapacity(minCapacity);方法。

private void ensureExplicitCapacity(int minCapacity) {
        //這個變量主要作用是防止在進(jìn)行一些操作時,改變了ArrayList的大小,那將使得結(jié)果不可預(yù)測。
          modCount++;
        // overflow-conscious code
        if (minCapacity - elementData.length > 0)
            grow(minCapacity);
    }

最后執(zhí)行了grow(minCapacity);擴(kuò)容的方法。

/**
     *增加容量以確保它能存下數(shù)據(jù)
     *
     * @param minCapacity the desired minimum capacity
     */
private void grow(int minCapacity) {
        // 數(shù)組的容量,按我們流程來這里oldCapacity=0,因?yàn)檫€沒有執(zhí)行數(shù)組的賦值操作
        //minCapacity=10
        int oldCapacity = elementData.length;
        //新的容量為原來的1.5倍
        //newCapacity=0;
        int newCapacity = oldCapacity + (oldCapacity >> 1);
        //新的容量不夠,直接將minCapacity作為容量
        if (newCapacity - minCapacity < 0)
            newCapacity = minCapacity;
          //防止溢出
        if (newCapacity - MAX_ARRAY_SIZE > 0)
            newCapacity = hugeCapacity(minCapacity);
        // 如果是第一次執(zhí)行,就可以看出這里的newCapacity =10
        elementData = Arrays.copyOf(elementData, newCapacity);
    }

最后執(zhí)行了elementData = Arrays.copyOf(elementData, newCapacity);到這里,我們就可以看出來是怎么擴(kuò)容了。我們繼續(xù)看最后一行有一個copyOf方法。

public static <T,U> T[] copyOf(U[] original, int newLength, Class<? extends T[]> newType) {
        @SuppressWarnings("unchecked")
        T[] copy = ((Object)newType == (Object)Object[].class)
            ? (T[]) new Object[newLength]
            : (T[]) Array.newInstance(newType.getComponentType(), newLength);
        System.arraycopy(original, 0, copy, 0,
                         Math.min(original.length, newLength));
        return copy;
    }

最后到了native的復(fù)制方法,這個方法就是將數(shù)組進(jìn)行復(fù)制。

     /* @param      src      源數(shù)組(要復(fù)制的數(shù)組)
     * @param      srcPos   源數(shù)組開始的位置(要將源數(shù)組復(fù)制的開始位置)
     * @param      dest     目標(biāo)數(shù)組(將源數(shù)組復(fù)制到的另一個數(shù)組)
     * @param      destPos  目標(biāo)數(shù)組的開始位置(將復(fù)制的元素存入的開始位置)
     * @param      復(fù)制的長度
     * @exception  IndexOutOfBoundsException  if copying would cause
     *               access of data outside array bounds.
     * @exception  ArrayStoreException  if an element in the <code>src</code>
     *               array could not be stored into the <code>dest</code> array
     *               because of a type mismatch.
     * @exception  NullPointerException if either <code>src</code> or
     *               <code>dest</code> is <code>null</code>.
     */
    @FastNative
    public static native void arraycopy(Object src,  int  srcPos,
                                        Object dest, int destPos,
                                        int length);

通過以上方法我們再回到grow(int minCapacity)的最后一句

 elementData = Arrays.copyOf(elementData, newCapacity);
底層通過System.arraycopy(original, 0, copy, 0,
                         Math.min(original.length, newLength));
將elementData數(shù)組復(fù)制到了一個新的容量為10的數(shù)組copy中,然后將新數(shù)組賦給elementData。

不難發(fā)現(xiàn)我們將執(zhí)行的添加操作是將elementData復(fù)制到新的數(shù)組,由此可以看出每次添加元素都會涉及到數(shù)組的copy操作,這樣在一定程度上是很耗費(fèi)資源的。


到這里我們來從新梳理下當(dāng)我們第一次從創(chuàng)建到調(diào)用add(E e)方法的整個流程。

  • 1.首先構(gòu)造方法生成一個空數(shù)組
public ArrayList() {
        this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;
    }
  • 2.調(diào)用add方法
public boolean add(E e) {
        //通過一系列判斷是否擴(kuò)容,第一次調(diào)用到grow()方法完成,才算初始化真正完成。此時elementData才是容量為10的數(shù)組。
        ensureCapacityInternal(size + 1); 
         // 然后將元素添加到elementData數(shù)組
        elementData[size++] = e;
        return true;
    }

那么當(dāng)我們元素等于10,這時我們插入第11個元素呢?
我們來看,此時的的各個方法的參數(shù)如下值:

size=10
ensureCapacityInternal(11)
ensureExplicitCapacity(11)
grow(11)
int oldCapacity =10;
        int newCapacity = 15;
        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, 15);

到這里可以看出每次grow()方法都會先進(jìn)行擴(kuò)容。然后通過

為了方便觀看這里直接跳過語法正確性進(jìn)行賦值
original=elementData ;
copy=new Object[15];
System.arraycopy(original, 0, copy, 0,
                         Math.min(original.length=10, newLength=15));

將原來的十個數(shù)據(jù)copy到新數(shù)組后賦值給elementData 。
這樣其實(shí)就是每次添加數(shù)據(jù)都會擴(kuò)充數(shù)組大小,但是實(shí)際元素個數(shù)size一般是小于elementData.length的,也就是list中的元素個數(shù)實(shí)際小于容量。


我們在看添加的第二個方法public void add(int index, E element)
第一步它也是先做了是否擴(kuò)容的操作,確保數(shù)組容量足夠。然后將原數(shù)據(jù)復(fù)制到擴(kuò)充后的數(shù)組,最后在相應(yīng)的位置插入值。整個流程如下圖:


刪除操作總共有三個方法,一個是根據(jù)索引刪除,一個是直接刪除元素,最后一個是清空list的clear方法,clear()方法是用for循環(huán)將所有元素置空。

public E remove(int index) {
        if (index >= size)
            throw new IndexOutOfBoundsException(outOfBoundsMsg(index));

        modCount++;
        //查找到要刪除的元素
        E oldValue = (E) elementData[index];
         //要移動(copy)的長度
        int numMoved = size - index - 1;
        if (numMoved > 0)
          //數(shù)組的copy移動
            System.arraycopy(elementData, index+1, elementData, index,
                             numMoved);
        //將最后的地方置空回收
        elementData[--size] = null; // clear to let GC do its work

        return oldValue;
    }
//該方法其實(shí)內(nèi)部實(shí)現(xiàn)其實(shí)是根據(jù)下標(biāo)找到該元素,最后執(zhí)行了remove(index)方法
public boolean remove(Object o) {
        if (o == null) {
            for (int index = 0; index < size; index++)
                if (elementData[index] == null) {
                    fastRemove(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++;
        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
    }

我們還是用圖來說明一下刪除操作的過程:


remove.png

改動元素的方法只有一個而且很簡單,它的操作就是找到該元素然后進(jìn)行重新賦值就可以。

public E set(int index, E element) {
        if (index >= size)
            throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
        E oldValue = (E) elementData[index];
        elementData[index] = element;
        return oldValue;
    }

就一個方法,內(nèi)部就是數(shù)組的位置查找。

public E get(int index) {
        if (index >= size)
            throw new IndexOutOfBoundsException(outOfBoundsMsg(index));

        return (E) elementData[index];
    }

到在這里基本的數(shù)據(jù)操作就分析完了。我們也可以回答之前的疑問。
ArrayList我們可以理解為一個可以動態(tài)擴(kuò)容的數(shù)組,內(nèi)部通過elementData數(shù)組來管理。
它的每次操作都會進(jìn)行copy,如果數(shù)據(jù)量小,其實(shí)影響不大。但是當(dāng)數(shù)據(jù)量很大,這樣就會影響性能。我們要緩解這樣的問題可以有下面兩種方法可以使用:

  • 使用ArrayList(int initialCapacity)這個有參構(gòu)造,在創(chuàng)建時就聲明一個較大的大小,這樣解決了頻繁拷貝問題,但是需要我們提前預(yù)知數(shù)據(jù)的數(shù)量級,也會一直占有較大的內(nèi)存。
  • 除了添加數(shù)據(jù)時可以自動擴(kuò)容外,我們還可以在插入前先進(jìn)行一次擴(kuò)容。只要提前預(yù)知數(shù)據(jù)的數(shù)量級,就可以在需要時直接一次擴(kuò)充到位,與ArrayList(int initialCapacity)相比的好處在于不必一直占有較大內(nèi)存,同時數(shù)據(jù)拷貝的次數(shù)也大大減少了。這個方法就是ensureCapacity(int minCapacity),其內(nèi)部就是調(diào)用了ensureCapacityInternal(int minCapacity)方法。
    所以對于ArrayList和數(shù)組一樣,更適合于數(shù)據(jù)隨機(jī)訪問,而不太適合于大量的插入與刪除。
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容