Java集合源碼分析（一）ArrayList

前言

　　在前面的學習集合中只是介紹了集合的相關用法，我們想要更深入的去了解集合那就要通過我們去分析它的源碼來了解它。希望對集合有一個更進一步的理解！

　　既然是看源碼那我們要怎么看一個類的源碼呢？這里我推薦的方法是：

　　　　1）看繼承結構

　　　　　　看這個類的層次結構，處於一個什么位置，可以在自己心里有個大概的了解。

　　　　2）看構造方法

　　　　　　在構造方法中，看做了哪些事情，跟蹤方法中里面的方法。

　　　　3）看常用的方法

　　　　　　跟構造方法一樣，這個方法實現功能是如何實現的

　　注：既然是源碼，為什么要這樣設計類，有這樣的繼承關系。這就要說到設計模式的問題了。所以我們要了解常用的設計模式，才能更深刻的去理解這個類。

一、ArrayList簡介

1.1、ArrayList概述

　　1）ArrayList是可以動態增長和縮減的索引序列，它是基於數組實現的List類。

　　2）該類封裝了一個動態再分配的Object[]數組，每一個類對象都有一個capacity屬性，表示它們所封裝的Object[]數組的長度，當向ArrayList中添加元素時，該屬性值會自動增加。

　　　　如果想ArrayList中添加大量元素，可使用ensureCapacity方法一次性增加capacity，可以減少增加重分配的次數提高性能。

　　3）ArrayList的用法和Vector向類似，但是Vector是一個較老的集合，具有很多缺點，不建議使用。

　　　　另外，ArrayList和Vector的區別是：ArrayList是線程不安全的，當多條線程訪問同一個ArrayList集合時，程序需要手動保證該集合的同步性，而Vector則是線程安全的。

　　4）ArrayList和Collection的關系：

　　　　　　

1.2、ArrayList的數據結構

　　分析一個類的時候，數據結構往往是它的靈魂所在，理解底層的數據結構其實就理解了該類的實現思路，具體的實現細節再具體分析。

　　ArrayList的數據結構是：

　　　　

　　說明：底層的數據結構就是數組，數組元素類型為Object類型，即可以存放所有類型數據。我們對ArrayList類的實例的所有的操作底層都是基於數組的。

二、ArrayList源碼分析

2.1、繼承結構和層次關系

　　

　　

　　我們看一下ArrayList的繼承結構：

　　　　　　　　ArrayList extends AbstractList

　　　　　　　　AbstractList extends AbstractCollection 

　　所有類都繼承Object  所以ArrayList的繼承結構就是上圖這樣。

　　分析：

　　　　1）為什么要先繼承AbstractList，而讓AbstractList先實現List<E>？而不是讓ArrayList直接實現List<E>？

　　　　　　這里是有一個思想，接口中全都是抽象的方法，而抽象類中可以有抽象方法，還可以有具體的實現方法，正是利用了這一點，讓AbstractList是實現接口中一些通用的方法，而具體的類，

　　　　　　如ArrayList就繼承這個AbstractList類，拿到一些通用的方法，然后自己在實現一些自己特有的方法，這樣一來，讓代碼更簡潔，就繼承結構最底層的類中通用的方法都抽取出來，

　　　　　　先一起實現了，減少重復代碼。所以一般看到一個類上面還有一個抽象類，應該就是這個作用。

　　　　2）ArrayList實現了哪些接口？

　　　　　　List<E>接口：我們會出現這樣一個疑問，在查看了ArrayList的父類AbstractList也實現了List<E>接口，那為什么子類ArrayList還是去實現一遍呢？

　　　　　　　　　　　　這是想不通的地方，所以我就去查資料，有的人說是為了查看代碼方便，使觀看者一目了然，說法不一，但每一個讓我感覺合理的，但是在stackOverFlow中找到了答案，這里其實很有趣。

　　　　　　　　　　　　網址貼出來 http://stackoverflow.com/questions/2165204/why-does-linkedhashsete-extend-hashsete-and-implement-sete開發這個collection 的作者Josh說。

　　　　　　　　　　　　這其實是一個mistake，因為他寫這代碼的時候覺得這個會有用處，但是其實並沒什么用，但因為沒什么影響，就一直留到了現在。

　　　　　　RandomAccess接口：這個是一個標記性接口，通過查看api文檔，它的作用就是用來快速隨機存取，有關效率的問題，在實現了該接口的話，那么使用普通的for循環來遍歷，性能更高，例如arrayList。

　　　　　　　　　　　　　　　　而沒有實現該接口的話，使用Iterator來迭代，這樣性能更高，例如linkedList。所以這個標記性只是為了讓我們知道我們用什么樣的方式去獲取數據性能更好。

　　　　　　Cloneable接口：實現了該接口，就可以使用Object.Clone()方法了。

　　　　　　Serializable接口：實現該序列化接口，表明該類可以被序列化，什么是序列化？簡單的說，就是能夠從類變成字節流傳輸，然后還能從字節流變成原來的類。

2.2、類中的屬性

public class ArrayList<E> extends AbstractList<E>
        implements List<E>, RandomAccess, Cloneable, java.io.Serializable
{
    // 版本號
    private static final long serialVersionUID = 8683452581122892189L;
    // 缺省容量
    private static final int DEFAULT_CAPACITY = 10;
    // 空對象數組
    private static final Object[] EMPTY_ELEMENTDATA = {};
    // 缺省空對象數組
    private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};
    // 元素數組
    transient Object[] elementData;
    // 實際元素大小，默認為0
    private int size;
    // 最大數組容量
    private static final int MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8;
}

 

2.3、構造方法

　　ArrayList有三個構造方法：

　　　　

　　1）無參構造方法　　

/**
    * Constructs an empty list with an initial capacity of ten.　　這里就說明了默認會給10的大小，所以說一開始arrayList的容量是10.
    */
　　　　//ArrayList中儲存數據的其實就是一個數組，這個數組就是elementData，在123行定義的 private transient Object[] elementData;
　　 public ArrayList() {　　
        super();        //調用父類中的無參構造方法，父類中的是個空的構造方法
        this.elementData = EMPTY_ELEMENTDATA;//EMPTY_ELEMENTDATA：是個空的Object[]， 將elementData初始化，elementData也是個Object[]類型。空的Object[]會給默認大小10，等會會解釋什么時候賦值的。
    }

　　　備注：

　　　　　　

　　　　　　

　　2）有參構造函數一

/**
     * Constructs an empty list with the specified initial capacity.
     *
     * @param  initialCapacity  the initial capacity of the list
     * @throws IllegalArgumentException if the specified initial capacity
     *         is negative
     */
    public ArrayList(int initialCapacity) {
        super(); //父類中空的構造方法
        if (initialCapacity < 0)    //判斷如果自定義大小的容量小於0，則報下面這個非法數據異常
            throw new IllegalArgumentException("Illegal Capacity: "+
                                               initialCapacity);
        this.elementData = new Object[initialCapacity]; //將自定義的容量大小當成初始化elementData的大小
    }

　　3）有參構造方法三(不常用)

//這個構造方法不常用，舉個例子就能明白什么意思
    /*
        Strudent exends Person
         ArrayList<Person>、 Person這里就是泛型
        我還有一個Collection<Student>、由於這個Student繼承了Person，那么根據這個構造方法，我就可以把這個Collection<Student>轉換為ArrayList<Sudent>這就是這個構造方法的作用 
    */
     public ArrayList(Collection<? extends E> c) {
        elementData = c.toArray();    //轉換為數組
        size = elementData.length;   //數組中的數據個數
        // c.toArray might (incorrectly) not return Object[] (see 6260652)
        if (elementData.getClass() != Object[].class) //每個集合的toarray()的實現方法不一樣，所以需要判斷一下，如果不是Object[].class類型，那么久需要使用ArrayList中的方法去改造一下。
            elementData = Arrays.copyOf(elementData, size, Object[].class);
    }　　　　

　　總結：arrayList的構造方法就做一件事情，就是初始化一下儲存數據的容器，其實本質上就是一個數組，在其中就叫elementData。

2.4、核心方法

　　2.4.1、add()方法（有四個）

　　　　

　　　　1）boolean add(E)；//默認直接在末尾添加元素

/**
     * Appends the specified element to the end of this list.添加一個特定的元素到list的末尾。
     *
     * @param e element to be appended to this list
     * @return <tt>true</tt> (as specified by {@link Collection#add})
     */
    public boolean add(E e) {    
    //確定內部容量是否夠了，size是數組中數據的個數，因為要添加一個元素，所以size+1，先判斷size+1的這個個數數組能否放得下，就在這個方法中去判斷是否數組.length是否夠用了。
        ensureCapacityInternal(size + 1);  // Increments modCount!!
     //在數據中正確的位置上放上元素e，並且size++
        elementData[size++] = e;
        return true;
    }

　　　　分析：

　　　　　　ensureCapacityInternal(xxx);　確定內部容量的方法　　　

private void ensureCapacityInternal(int minCapacity) {
        if (elementData == EMPTY_ELEMENTDATA) { //看，判斷初始化的elementData是不是空的數組，也就是沒有長度
    //因為如果是空的話，minCapacity=size+1；其實就是等於1，空的數組沒有長度就存放不了，所以就將minCapacity變成10，也就是默認大小，但是帶這里，還沒有真正的初始化這個elementData的大小。
            minCapacity = Math.max(DEFAULT_CAPACITY, minCapacity);
        }
    //確認實際的容量，上面只是將minCapacity=10，這個方法就是真正的判斷elementData是否夠用
        ensureExplicitCapacity(minCapacity);
    }

　　　　　　ensureExplicitCapacity(xxx)；

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

        // overflow-conscious code
//minCapacity如果大於了實際elementData的長度，那么就說明elementData數組的長度不夠用，不夠用那么就要增加elementData的length。這里有的同學就會模糊minCapacity到底是什么呢，這里給你們分析一下

/*第一種情況：由於elementData初始化時是空的數組，那么第一次add的時候，minCapacity=size+1；也就minCapacity=1，在上一個方法(確定內部容量ensureCapacityInternal)就會判斷出是空的數組，就會給 　　將minCapacity=10，到這一步為止，還沒有改變elementData的大小。
　第二種情況：elementData不是空的數組了，那么在add的時候，minCapacity=size+1；也就是minCapacity代表着elementData中增加之后的實際數據個數，拿着它判斷elementData的length是否夠用，如果length 不夠用，那么肯定要擴大容量，不然增加的這個元素就會溢出。 */


        if (minCapacity - elementData.length > 0)
    //arrayList能自動擴展大小的關鍵方法就在這里了
            grow(minCapacity);
    }

　　　　　　grow(xxx); arrayList核心的方法，能擴展數組大小的真正秘密。

private void grow(int minCapacity) {
        // overflow-conscious code
        int oldCapacity = elementData.length;  //將擴充前的elementData大小給oldCapacity
        int newCapacity = oldCapacity + (oldCapacity >> 1);//newCapacity就是1.5倍的oldCapacity
        if (newCapacity - minCapacity < 0)//這句話就是適應於elementData就空數組的時候，length=0，那么oldCapacity=0，newCapacity=0，所以這個判斷成立，在這里就是真正的初始化elementData的大小了，就是為10.前面的工作都是准備工作。
            newCapacity = minCapacity;
        if (newCapacity - MAX_ARRAY_SIZE > 0)//如果newCapacity超過了最大的容量限制，就調用hugeCapacity，也就是將能給的最大值給newCapacity
            newCapacity = hugeCapacity(minCapacity);
        // minCapacity is usually close to size, so this is a win:
    //新的容量大小已經確定好了，就copy數組，改變容量大小咯。
        elementData = Arrays.copyOf(elementData, newCapacity);
    }

　　　　　hugeCapacity();  

//這個就是上面用到的方法，很簡單，就是用來賦最大值。
    private static int hugeCapacity(int minCapacity) {
        if (minCapacity < 0) // overflow
            throw new OutOfMemoryError();
//如果minCapacity都大於MAX_ARRAY_SIZE，那么就Integer.MAX_VALUE返回，反之將MAX_ARRAY_SIZE返回。因為maxCapacity是三倍的minCapacity，可能擴充的太大了，就用minCapacity來判斷了。
//Integer.MAX_VALUE:2147483647   MAX_ARRAY_SIZE：2147483639  也就是說最大也就能給到第一個數值。還是超過了這個限制，就要溢出了。相當於arraylist給了兩層防護。
        return (minCapacity > MAX_ARRAY_SIZE) ?
            Integer.MAX_VALUE :
            MAX_ARRAY_SIZE;
    }

　　　　2）void add(int，E)；在特定位置添加元素，也就是插入元素

public void add(int index, E element) {
        rangeCheckForAdd(index);//檢查index也就是插入的位置是否合理。

//跟上面的分析一樣，具體看上面
        ensureCapacityInternal(size + 1);  // Increments modCount!!
//這個方法就是用來在插入元素之后，要將index之后的元素都往后移一位，
        System.arraycopy(elementData, index, elementData, index + 1,
                         size - index);
//在目標位置上存放元素
        elementData[index] = element;
        size++;//size增加1
    } 

　　　　分析：

　　　　　　rangeCheckForAdd(index)　　

    private void rangeCheckForAdd(int index) {
        if (index > size || index < 0)   //插入的位置肯定不能大於size 和小於0
//如果是，就報這個越界異常
            throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
    }

　　　　　　System.arraycopy(...)：就是將elementData在插入位置后的所有元素往后面移一位。查看api文檔　

public static void arraycopy(Object src,
             int srcPos,
             Object dest,
             int destPos,
             int length)
src：源對象
srcPos：源對象對象的起始位置
dest：目標對象
destPost：目標對象的起始位置
length：從起始位置往后復制的長度。

//這段的大概意思就是解釋這個方法的用法，復制src到dest，復制的位置是從src的srcPost開始，到srcPost+length-1的位置結束，復制到destPost上，從destPost開始到destPost+length-1的位置上，
Copies an array from the specified source array, beginning at the specified position, to the specified position of the destination array. A subsequence of array components are copied from 
the source array referenced by src to the destination array referenced by dest. The number of components copied is equal to the length argument. The components at positions srcPos through srcPos+length-1
 in the source array are copied into positions destPos through destPos+length-1, respectively, of the destination array. 

//告訴你復制的一種情況，如果A和B是一樣的，那么先將A復制到臨時數組C，然后通過C復制到B，用了一個第三方參數
If the src and dest arguments refer to the same array object, then the copying is performed as if the components at positions srcPos through srcPos+length-1 were first copied to
 a temporary array with length components and then the contents of the temporary array were copied into positions destPos through destPos+length-1 of the destination array. 


//這一大段，就是來說明會出現的一些問題，NullPointerException和IndexOutOfBoundsException 還有ArrayStoreException 這三個異常出現的原因。
If dest is null, then a NullPointerException is thrown. 

If src is null, then a NullPointerException is thrown and the destination array is not modified. 

Otherwise, if any of the following is true, an ArrayStoreException is thrown and the destination is not modified: 

The src argument refers to an object that is not an array. 
The dest argument refers to an object that is not an array. 
The src argument and dest argument refer to arrays whose component types are different primitive types. 
The src argument refers to an array with a primitive component type and the dest argument refers to an array with a reference component type. 
The src argument refers to an array with a reference component type and the dest argument refers to an array with a primitive component type. 
Otherwise, if any of the following is true, an IndexOutOfBoundsException is thrown and the destination is not modified: 

The srcPos argument is negative. 
The destPos argument is negative. 
The length argument is negative. 
srcPos+length is greater than src.length, the length of the source array. 
destPos+length is greater than dest.length, the length of the destination array. 


//這里描述了一種特殊的情況，就是當A的長度大於B的長度的時候，會復制一部分，而不是完全失敗。
Otherwise, if any actual component of the source array from position srcPos through srcPos+length-1 cannot be converted to the component type of the destination array by assignment conversion, an ArrayStoreException is thrown. 
In this case, let k be the smallest nonnegative integer less than length such that src[srcPos+k] cannot be converted to the component type of the destination array; when the exception is thrown, source array components from positions 
srcPos through srcPos+k-1 will already have been copied to destination array positions destPos through destPos+k-1 and no other positions of the destination array will have been modified. (Because of the restrictions already itemized, 

this paragraph effectively applies only to the situation where both arrays have component types that are reference types.)

//這個參數列表的解釋，一開始就說了，
Parameters:
src - the source array.
srcPos - starting position in the source array.
dest - the destination array.
destPos - starting position in the destination data.
length - the number of array elements to be copied.

　　總結：

　　　　正常情況下會擴容1.5倍，特殊情況下（新擴展數組大小已經達到了最大值）則只取最大值。

　　　　當我們調用add方法時，實際上的函數調用如下：

　　　　　　

　　　　說明：程序調用add，實際上還會進行一系列調用，可能會調用到grow，grow可能會調用hugeCapacity。

　　舉例說明一：　　　　

　　List<Integer> lists = new ArrayList<Integer>(6);
　　lists.add(8);

　　　　說明：初始化lists大小為0，調用的ArrayList()型構造函數，那么在調用lists.add(8)方法時，會經過怎樣的步驟呢？下圖給出了該程序執行過程和最初與最后的elementData的大小。

　　　　　　

　　　　說明：我們可以看到，在add方法之前開始elementData = {}；調用add方法時會繼續調用，直至grow，最后elementData的大小變為10，之后再返回到add函數，把8放在elementData[0]中。

　　舉例說明二：　　　

　　List<Integer> lists = new ArrayList<Integer>(6);
　　lists.add(8);

　　　　說明：調用的ArrayList(int)型構造函數，那么elementData被初始化為大小為6的Object數組，在調用add(8)方法時，具體的步驟如下：

　　　　　　

　　　　說明：我們可以知道，在調用add方法之前，elementData的大小已經為6，之后再進行傳遞，不會進行擴容處理。

　　2.4.2、刪除方法

　　　　其實這幾個刪除方法都是類似的。我們選擇幾個講，其中fastRemove(int)方法是private的，是提供給remove(Object)這個方法用的。

　　　　

　　　　1）remove(int)：通過刪除指定位置上的元素

public E remove(int index) {
        rangeCheck(index);//檢查index的合理性

        modCount++;//這個作用很多，比如用來檢測快速失敗的一種標志。
        E oldValue = elementData(index);//通過索引直接找到該元素

        int numMoved = size - index - 1;//計算要移動的位數。
        if (numMoved > 0)
//這個方法也已經解釋過了，就是用來移動元素的。
            System.arraycopy(elementData, index+1, elementData, index,
                             numMoved);
//將--size上的位置賦值為null，讓gc(垃圾回收機制)更快的回收它。
        elementData[--size] = null; // clear to let GC do its work
//返回刪除的元素。
        return oldValue;
    }

　　　　2）remove(Object)：這個方法可以看出來，arrayList是可以存放null值得。

//感覺這個不怎么要分析吧，都看得懂，就是通過元素來刪除該元素，就依次遍歷，如果有這個元素，就將該元素的索引傳給fastRemobe(index)，使用這個方法來刪除該元素， //fastRemove(index)方法的內部跟remove(index)的實現幾乎一樣，這里最主要是知道arrayList可以存儲null值
     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;
    }

　　　　3）clear()：將elementData中每個元素都賦值為null，等待垃圾回收將這個給回收掉，所以叫clear

public void clear() {
        modCount++;

        // clear to let GC do its work
        for (int i = 0; i < size; i++)
            elementData[i] = null;

        size = 0;
    }

　　　　4）removeAll(collection c)：

     public boolean removeAll(Collection<?> c) {
         return batchRemove(c, false);//批量刪除
     }

　　　　5）batchRemove(xx,xx)：用於兩個方法，一個removeAll()：它只清楚指定集合中的元素，retainAll()用來測試兩個集合是否有交集。　

//這個方法，用於兩處地方，如果complement為false，則用於removeAll如果為true，則給retainAll()用，retainAll（）是用來檢測兩個集合是否有交集的。
   private boolean batchRemove(Collection<?> c, boolean complement) {
        final Object[] elementData = this.elementData; //將原集合，記名為A
        int r = 0, w = 0;   //r用來控制循環，w是記錄有多少個交集
        boolean modified = false;  
        try {
            for (; r < size; r++)
//參數中的集合C一次檢測集合A中的元素是否有，
                if (c.contains(elementData[r]) == complement)
//有的話，就給集合A
                    elementData[w++] = elementData[r];
        } finally {
            // Preserve behavioral compatibility with AbstractCollection,
            // even if c.contains() throws.
//如果contains方法使用過程報異常
            if (r != size) {
//將剩下的元素都賦值給集合A，
                System.arraycopy(elementData, r,
                                 elementData, w,
                                 size - r);
                w += size - r;
            }
            if (w != size) {
//這里有兩個用途，在removeAll()時，w一直為0，就直接跟clear一樣，全是為null。
//retainAll()：沒有一個交集返回true，有交集但不全交也返回true，而兩個集合相等的時候，返回false，所以不能根據返回值來確認兩個集合是否有交集，而是通過原集合的大小是否發生改變來判斷，如果原集合中還有元素，則代表有交集，而元集合沒有元素了，說明兩個集合沒有交集。
                // clear to let GC do its work
                for (int i = w; i < size; i++)
                    elementData[i] = null;
                modCount += size - w;
                size = w;
                modified = true;
            }
        }
        return modified;
    }

　　總結：：remove函數用戶移除指定下標的元素，此時會把指定下標到數組末尾的元素向前移動一個單位，並且會把數組最后一個元素設置為null，

　　　　　　這樣是為了方便之后將整個數組不被使用時，會被GC，可以作為小的技巧使用。

　　2.4.3、set()方法

public E set(int index, E element) {
        // 檢驗索引是否合法
        rangeCheck(index);
        // 舊值
        E oldValue = elementData(index);
        // 賦新值
        elementData[index] = element;
        // 返回舊值
        return oldValue;
    }

　　說明：設定指定下標索引的元素值

　　2.4.4、indexOf()方法

// 從首開始查找數組里面是否存在指定元素
    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;
    }

　　說明：從頭開始查找與指定元素相等的元素，注意，是可以查找null元素的，意味着ArrayList中可以存放null元素的。與此函數對應的lastIndexOf，表示從尾部開始查找。

　　2.4.5、get()方法

public E get(int index) {
        // 檢驗索引是否合法
        rangeCheck(index);

        return elementData(index);
    }

　　說明：get函數會檢查索引值是否合法（只檢查是否大於size，而沒有檢查是否小於0），值得注意的是，在get函數中存在element函數，element函數用於返回具體的元素，具體函數如下：

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

　　說明：返回的值都經過了向下轉型（Object -> E），這些是對我們應用程序屏蔽的小細節。

三、總結　

1）arrayList可以存放null。
2）arrayList本質上就是一個elementData數組。
3）arrayList區別於數組的地方在於能夠自動擴展大小，其中關鍵的方法就是gorw()方法。
4）arrayList中removeAll(collection c)和clear()的區別就是removeAll可以刪除批量指定的元素，而clear是全是刪除集合中的元素。
5）arrayList由於本質是數組，所以它在數據的查詢方面會很快，而在插入刪除這些方面，性能下降很多，有移動很多數據才能達到應有的效果
6）arrayList實現了RandomAccess，所以在遍歷它的時候推薦使用for循環。

 

喜歡就“推薦”哦！