ArrayList源碼分析

本系列的所有源碼主要是針對JDK 1.8的版本來探討，部分容器源碼在1.7和1.8又較大變動(例如HashMap)纔會進行對比。
首先我們來看一下ArrayList的類圖結構：

其中Cloneable、Serializable、RandomAccess分別是屬於給該類添加某個屬性的接口，而核心內容應該是List和AbstractList的類繼承和接口實現。
接下來我們主要來圍繞關於ArrayList的存儲結構以及常用方法進行介紹，對於它的存儲結構可以看到是：

/**
     * The array buffer into which the elements of the ArrayList are stored.
     * The capacity of the ArrayList is the length of this array buffer. Any
     * empty ArrayList with elementData == EMPTY_ELEMENTDATA will be expanded to
     * DEFAULT_CAPACITY when the first element is added.
     */
    private transient Object[] elementData;

這裏依據文檔中解釋我們可以獲知的內容是：

ArrayList的內部存儲結構是已一個Object數組來作爲容器存儲所有數據；
ArrayList在剛開始初始化時，如果未指定內部數組初始化長度，即通過new ArrayList<>()形式來聲明的容器，在沒有往其中插入數據的時候，內部elementData容器是一個空的數組，在第一個元素被插入的時候，會默認擴充容器容量大小爲DEFAULT_CAPACITY（10），並且看源碼可以知道內部還會維護一個size私有變量記錄容器中元素的個數（注意這裏說的是元素個數，而不是容器的容量）。
以上是關於ArrayList的存儲結構介紹，對於ArrayList主要提供了三個構造函數，接下來簡單介紹一下構造函數部分的內容，分別是

1. 無參構造：

/**
     * Constructs an empty list with an initial capacity of ten.
     *  這裏說是初始化時初始容量爲10，但是其實在不調用add方法插入數據，沒有數據的時候默認是一個空 
     *  數組，而不是所謂的長度爲10的數組，只有在初次插入時纔會創建長度爲10的數組，可以理解爲延遲創建。
     */
    public ArrayList() {
        this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;
    }

1. 帶初始化長度的構造：

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

一般建議如果提取能大致預估到容器中需要插入的數據大小範圍，最好傳入一個大小接近的值作爲初始容器大小，這樣可以減少容器擴容帶來的性能消耗。

1. 帶Collection數組的構造：

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

以上就是主要的三個構造函數介紹，接下來圍繞常用的增刪改查方法的實現進行說明。

add

對於ArrayList使用最爲頻繁必須當屬add方法莫屬了，那麼對於這個新增方法的實現，有兩種不同的重載方法實現，分別爲add(E e)和add(int index, E element)這兩個，不過和構造函數類似，實現插入還可以通過addAll來實現直接插入某個集合到容器中，針對這些方法的不同實現，我們分別來進行介紹。

1. add(E e)
  這個方法是一般用的最多的插入手段，源碼如下：

public boolean add(E e) {
        ensureCapacityInternal(size + 1);  // Increments modCount!!
        elementData[size++] = e;
        return true;
    }

既然是用的最多的方法，那麼我們有必要對這個方法進行深入挖掘，方法主體結構邏輯十分簡單，就是先調用ensureCapacityInternal方法來判斷容器中是否有空位來容納新近來的元素，ensureCapacityInternal源碼如下：

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

        ensureExplicitCapacity(minCapacity);
    }

這裏需要注意的一點是，在ArrayList中其實對於不傳參數的構造函數和傳長度參數爲0是不一樣的，對於不傳參數的構造函數來說，對於容器數組引用是選擇指向DEFAULTCAPACITY_EMPTY_ELEMENTDATA，然後就可以理解上面這裏對於ensureCapacityInternal中的if中判斷的含義，就是無參構造中說明的此時判斷條件成立說明調用的是無參構造則第一次插入數據此時傳入ensureCapacityInternal這裏的minCapacity=1，從而進入if循環後重新賦值爲10（DEFAULT_CAPACITY），在第一次調用add方法的時候就默認擴充容器大小爲長度爲10的數組。
當然，這裏我們進一步來繼續考慮ensureExplicitCapacity函數的作用，源碼如下：

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

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

很顯然，它的作用之一就是給modCount變量進行加1操作，這個變量的作用可以理解爲ArrayList的版本，每次進行一次增刪改時都會改變ArrayList的內容，所以會改變modCount的值從而得到一個新版本的數組，之所以這麼記錄的一個原因就是防止iterator得到的迭代器在數組進行修改的時候迭代到了修改以前的老版本的數據得到錯誤的數據，所以通過modCount記錄的版本號，在每次迭代器獲取數據之前，會先判斷modCount版本號是否和最新版本號一致（獲取迭代器的時候，會一併獲取到當前的modCount記錄版本號），如果不一致會拋出異常提示迭代器對應的容器中數據在迭代過程中被修改，這個原理是所有容器獲取迭代器的時候都會用到的。
繼續回到ensureExplicitCapacity函數的作用，這裏顯然就是判斷是否需要擴容，如果判斷新插入數據所需數組大小超過了現在容器大小，則會調用grow函數進行擴容，那麼繼續看grow函數的擴容源碼：

private void grow(int minCapacity) {
        // overflow-conscious code
        int oldCapacity = elementData.length;
        int newCapacity = oldCapacity + (oldCapacity >> 1);
      // 出現一下情況只有少數幾種情況，第一就是初始化長度時故意找茬設置的初始長度爲0或者1，
      // 從而導致newCapacity和oldCapacity一樣沒邊；另外一種就是在addAll中一次性插入多條數據時一次
      // 性要求的坑位過大，導致擴容得到的新數組長度還是無法完全容納滿新插入的全部數據，
      // 只有這些情況下才會進入下面邏輯
        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);
    }

這裏就是常說的擴容ArrayList的擴容邏輯實現，就是先獲取老的容器的數組長度，注意入參是要求的容器最低需要滿足的數組長度，然後新容器長度嘗試設置爲newCapacity = oldCapacity + (oldCapacity >> 1)，這裏通常大家喜歡說是設置爲原有數組的1.5倍長度是不對的，因爲這裏只是右移一位，假設構造函數調用的是無參構造，然後進行了兩次擴容，那麼數組長度變化應該是：

初始數組長度10
第一次擴容：newCapacity = 10 + 10 >> 1 = 15  這一步確實是容量擴充1.5倍
第二次擴容：newCapacity = 15 + 15 >> 1 = 15 + 7 = 22 很顯然這裏就不是所謂的擴容1.5倍了

所以對於大家有的網上的博客說的ArrayList擴容每次是擴容原來數組的1.5倍的說法嚴格來說是錯誤的。
繼續分析以上grow函數，發現在獲取了新數組長度後，會調用Arrays.copyOf(elementData, newCapacity)來進行最後的擴容，其內部實現是：

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

所以可以看到擴容的真實情況是聲明一個新的長度爲newCapacity的數組，然後將原來的數組中所有數據都拷貝到新數組中，可見這個過程其實是耗時很長的，所以如果我們的應用需要頻繁往某個ArrayList中插入數據時，最好提取大致評估一下數組中會有多少數據，然後給一個初始長度進行初始化，這樣可以有效減少多次擴容造成的不必要的性能消耗。

1. add(int index,E element)
  在明白了add(E e)方法邏輯後，再看這個方法的實現，就會十分的簡單，源碼如下：

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

這個函數的作用就是在指定坑位插入數據，那麼很顯然第一步就是要檢驗index給的值是否合法，這裏檢驗是否合法需要注意的是判斷的條件是：index > size || index < 0，即插入元素的位置必須是在已有元素中間插入，不能數組中現在只有3個元素，然後直接往第五個位置插入數據而不管第四個位置，然後這一系列都OK以後，進行數據插入，插入方式是把index位置後的所有元素都依次往後挪一位。

1. addAll(Collection<? extends E> c) 和 addAll(int index, Collection<? extends E> c)
  這兩個也都十分好理解，就是在單個插入的基礎上變成一次插入一個批次的集合數據，判斷邏輯和插入邏輯在看完以上add基礎上十分容易理解，再次不再贅述。
  介紹完了主要的新增數據相關方法後，接下來就要看獲取數據的方式。

get

由於容器實現是基於數組，所以對於獲取數據的方法就顯得十分簡單了，源碼如下：

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

        return elementData(index);
    }

只是做了簡單的參數是否合法的校驗，校驗通過就直接取數組中數據即可。介紹了增和查的方法，接下來介紹一下改的方法，即set。

set

和獲取的方法類似，依託於數組的性質，改數據的邏輯也十分的簡單，代碼如下：

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

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

代碼先校驗位置參數，然後存儲需要修改的值的舊的值，然後替換爲新的值後返回舊的數據。
繼續介紹增刪改查中最後的刪除方法，即remove方法的實現。

remove

remove實現主要有兩種，分別是刪除指定位置的元素和刪除不知道位置的指定元素。在理解了add邏輯後，刪除其實也是灑灑水啦，下面對這兩種進行介紹。

1. remove(int index)
  這個方法就是刪除index位置的元素，這個的邏輯和往指定位置插入數據的邏輯屬於一個逆向邏輯，實現方式極其相似，源碼如下：

public E remove(int 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;
    }

先檢查index合法性，然後修改modCount的值，保存需要刪除的元素的值，然後將刪除位置後所有的元素往前挪一位。

1. remove(Object o)

這個方法意思就是，我不知道o這個元素在哪個位置，但是我就是看它不爽，你們必須給我找到它藏在數組中的位置，然後刪除它！那麼由於不知道元素位置，所以要找到該元素，必須得遍歷數組進行匹配。當然了，有可能數組中會存在多個匹配的元素，對於這個方法而言，只是刪除從頭到尾遍歷出現的第一個匹配的對象，源碼如下：

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

可以看到，這裏可以支持刪除對象爲null對象，所以也可以變形說明在進行add插入數據的時候，也是可以插入null對象的，回頭看add的插入邏輯確實沒有判斷和限制插入的對象是否爲null。這裏邏輯很清晰，我們主要看一下其中調用的fastRemove方法有啥祕密，源碼如下：

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
    }

這裏看fastRemove名稱就說明會比之前介紹的remove方法要快一些，看代碼才知道它快只是快在省去了index的校驗，因爲這個是內部調用的方法，調用之前確實是知道index肯定是合法的，所以沒必要進行校驗，同時它也不會保存被刪除的數據和返還數據，只是省去了這兩步，所以叫fastRemove咯。
以上就是主要用到一些方法，至於還有一些例如contains、index等方法，在理解了本文介紹的這幾個方法後，這些方法的邏輯都是大同小異的，都是通過遍歷之類的來操作數組獲取結果，不再進行重複的贅述，下期再見其它容器源碼介紹。

ArrayList源碼分析

add

get

set

remove

Wireshark 安裝+使用（一）

博客園商業化之路-衆包平臺：繼續召集早期合作開發者

ClassNotFoundException、NoSuchMethodException?

五月份Spark源碼個人專欄計劃解決疑問

數據庫事務的四大特性&事務隔離級別介紹

Java四種線程池原理&應用分析

zookeeper基本概念

Mac下配置sublime實現LaTeX

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結