【Java集合原始碼剖析】ArrayList原始碼剖析

蘭亭風雨發表於2014-06-30

轉載請註明出處:http://blog.csdn.net/ns_code/article/details/35568011


本篇博文參加了CSDN博文大賽,如果您覺得這篇博文不錯,希望您能幫我投一票,謝謝!

投票地址:http://vote.blog.csdn.net/Article/Details?articleid=35568011


ArrayList簡介

    ArrayList是基於陣列實現的,是一個動態陣列,其容量能自動增長,類似於C語言中的動態申請記憶體,動態增長記憶體。

    ArrayList不是執行緒安全的,只能用在單執行緒環境下,多執行緒環境下可以考慮用Collections.synchronizedList(List l)函式返回一個執行緒安全的ArrayList類,也可以使用concurrent併發包下的CopyOnWriteArrayList類。

    ArrayList實現了Serializable介面,因此它支援序列化,能夠通過序列化傳輸,實現了RandomAccess介面,支援快速隨機訪問,實際上就是通過下標序號進行快速訪問,實現了Cloneable介面,能被克隆。


ArrayList原始碼剖析

    ArrayList的原始碼如下(加入了比較詳細的註釋):

package java.util;  
 
public class ArrayList<E> extends AbstractList<E>  
        implements List<E>, RandomAccess, Cloneable, java.io.Serializable  
{  
    // 序列版本號  
    private static final long serialVersionUID = 8683452581122892189L;  
 
    // ArrayList基於該陣列實現,用該陣列儲存資料 
    private transient Object[] elementData;  
 
    // ArrayList中實際資料的數量  
    private int size;  
 
    // ArrayList帶容量大小的建構函式。  
    public ArrayList(int initialCapacity) {  
        super();  
        if (initialCapacity < 0)  
            throw new IllegalArgumentException("Illegal Capacity: "+  
                                               initialCapacity);  
        // 新建一個陣列  
        this.elementData = new Object[initialCapacity];  
    }  
 
    // ArrayList無參建構函式。預設容量是10。  
    public ArrayList() {  
        this(10);  
    }  
 
    // 建立一個包含collection的ArrayList  
    public ArrayList(Collection<? extends E> c) {  
        elementData = c.toArray();  
        size = elementData.length;  
        if (elementData.getClass() != Object[].class)  
            elementData = Arrays.copyOf(elementData, size, Object[].class);  
    }  
 
 
    // 將當前容量值設為實際元素個數  
    public void trimToSize() {  
        modCount++;  
        int oldCapacity = elementData.length;  
        if (size < oldCapacity) {  
            elementData = Arrays.copyOf(elementData, size);  
        }  
    }  
 
 
    // 確定ArrarList的容量。  
    // 若ArrayList的容量不足以容納當前的全部元素,設定 新的容量=“(原始容量x3)/2 + 1”  
    public void ensureCapacity(int minCapacity) {  
        // 將“修改統計數”+1,該變數主要是用來實現fail-fast機制的  
        modCount++;  
        int oldCapacity = elementData.length;  
        // 若當前容量不足以容納當前的元素個數,設定 新的容量=“(原始容量x3)/2 + 1”  
        if (minCapacity > oldCapacity) {  
            Object oldData[] = elementData;  
            int newCapacity = (oldCapacity * 3)/2 + 1;  
			//如果還不夠,則直接將minCapacity設定為當前容量
            if (newCapacity < minCapacity)  
                newCapacity = minCapacity;  
            elementData = Arrays.copyOf(elementData, newCapacity);  
        }  
    }  
 
    // 新增元素e  
    public boolean add(E e) {  
        // 確定ArrayList的容量大小  
        ensureCapacity(size + 1);  // Increments modCount!!  
        // 新增e到ArrayList中  
        elementData[size++] = e;  
        return true;  
    }  
 
    // 返回ArrayList的實際大小  
    public int size() {  
        return size;  
    }  
 
    // ArrayList是否包含Object(o)  
    public boolean contains(Object o) {  
        return indexOf(o) >= 0;  
    }  
 
    //返回ArrayList是否為空  
    public boolean isEmpty() {  
        return size == 0;  
    }  
 
    // 正向查詢,返回元素的索引值  
    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;  
        }  
 
        // 反向查詢,返回元素的索引值  
        public int lastIndexOf(Object o) {  
        if (o == null) {  
            for (int i = size-1; i >= 0; i--)  
            if (elementData[i]==null)  
                return i;  
        } else {  
            for (int i = size-1; i >= 0; i--)  
            if (o.equals(elementData[i]))  
                return i;  
        }  
        return -1;  
    }  
 
    // 反向查詢(從陣列末尾向開始查詢),返回元素(o)的索引值  
    public int lastIndexOf(Object o) {  
        if (o == null) {  
            for (int i = size-1; i >= 0; i--)  
            if (elementData[i]==null)  
                return i;  
        } else {  
            for (int i = size-1; i >= 0; i--)  
            if (o.equals(elementData[i]))  
                return i;  
        }  
        return -1;  
    }  
   
 
    // 返回ArrayList的Object陣列  
    public Object[] toArray() {  
        return Arrays.copyOf(elementData, size);  
    }  
 
    // 返回ArrayList元素組成的陣列
    public <T> T[] toArray(T[] a) {  
        // 若陣列a的大小 < ArrayList的元素個數;  
        // 則新建一個T[]陣列,陣列大小是“ArrayList的元素個數”,並將“ArrayList”全部拷貝到新陣列中  
        if (a.length < size)  
            return (T[]) Arrays.copyOf(elementData, size, a.getClass());  
 
        // 若陣列a的大小 >= ArrayList的元素個數;  
        // 則將ArrayList的全部元素都拷貝到陣列a中。  
        System.arraycopy(elementData, 0, a, 0, size);  
        if (a.length > size)  
            a[size] = null;  
        return a;  
    }  
 
    // 獲取index位置的元素值  
    public E get(int index) {  
        RangeCheck(index);  
 
        return (E) elementData[index];  
    }  
 
    // 設定index位置的值為element  
    public E set(int index, E element) {  
        RangeCheck(index);  
 
        E oldValue = (E) elementData[index];  
        elementData[index] = element;  
        return oldValue;  
    }  
 
    // 將e新增到ArrayList中  
    public boolean add(E e) {  
        ensureCapacity(size + 1);  // Increments modCount!!  
        elementData[size++] = e;  
        return true;  
    }  
 
    // 將e新增到ArrayList的指定位置  
    public void add(int index, E element) {  
        if (index > size || index < 0)  
            throw new IndexOutOfBoundsException(  
            "Index: "+index+", Size: "+size);  
 
        ensureCapacity(size+1);  // Increments modCount!!  
        System.arraycopy(elementData, index, elementData, index + 1,  
             size - index);  
        elementData[index] = element;  
        size++;  
    }  
 
    // 刪除ArrayList指定位置的元素  
    public E remove(int index) {  
        RangeCheck(index);  
 
        modCount++;  
        E oldValue = (E) elementData[index];  
 
        int numMoved = size - index - 1;  
        if (numMoved > 0)  
            System.arraycopy(elementData, index+1, elementData, index,  
                 numMoved);  
        elementData[--size] = null; // Let gc do its work  
 
        return oldValue;  
    }  
 
    // 刪除ArrayList的指定元素  
    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;  
    }  
 
 
    // 快速刪除第index個元素  
    private void fastRemove(int index) {  
        modCount++;  
        int numMoved = size - index - 1;  
        // 從"index+1"開始,用後面的元素替換前面的元素。  
        if (numMoved > 0)  
            System.arraycopy(elementData, index+1, elementData, index,  
                             numMoved);  
        // 將最後一個元素設為null  
        elementData[--size] = null; // Let gc do its work  
    }  
 
    // 刪除元素  
    public boolean remove(Object o) {  
        if (o == null) {  
            for (int index = 0; index < size; index++)  
            if (elementData[index] == null) {  
                fastRemove(index);  
            return true;  
            }  
        } else {  
            // 便利ArrayList,找到“元素o”,則刪除,並返回true。  
            for (int index = 0; index < size; index++)  
            if (o.equals(elementData[index])) {  
                fastRemove(index);  
            return true;  
            }  
        }  
        return false;  
    }  
 
    // 清空ArrayList,將全部的元素設為null  
    public void clear() {  
        modCount++;  
 
        for (int i = 0; i < size; i++)  
            elementData[i] = null;  
 
        size = 0;  
    }  
 
    // 將集合c追加到ArrayList中  
    public boolean addAll(Collection<? extends E> c) {  
        Object[] a = c.toArray();  
        int numNew = a.length;  
        ensureCapacity(size + numNew);  // Increments modCount  
        System.arraycopy(a, 0, elementData, size, numNew);  
        size += numNew;  
        return numNew != 0;  
    }  
 
    // 從index位置開始,將集合c新增到ArrayList  
    public boolean addAll(int index, Collection<? extends E> c) {  
        if (index > size || index < 0)  
            throw new IndexOutOfBoundsException(  
            "Index: " + index + ", Size: " + size);  
 
        Object[] a = c.toArray();  
        int numNew = a.length;  
        ensureCapacity(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;  
    }  
 
    // 刪除fromIndex到toIndex之間的全部元素。  
    protected void removeRange(int fromIndex, int toIndex) {  
    modCount++;  
    int numMoved = size - toIndex;  
        System.arraycopy(elementData, toIndex, elementData, fromIndex,  
                         numMoved);  
 
    // Let gc do its work  
    int newSize = size - (toIndex-fromIndex);  
    while (size != newSize)  
        elementData[--size] = null;  
    }  
 
    private void RangeCheck(int index) {  
    if (index >= size)  
        throw new IndexOutOfBoundsException(  
        "Index: "+index+", Size: "+size);  
    }  
 
 
    // 克隆函式  
    public Object clone() {  
        try {  
            ArrayList<E> v = (ArrayList<E>) super.clone();  
            // 將當前ArrayList的全部元素拷貝到v中  
            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();  
        }  
    }  
 
 
    // java.io.Serializable的寫入函式  
    // 將ArrayList的“容量,所有的元素值”都寫入到輸出流中  
    private void writeObject(java.io.ObjectOutputStream s)  
        throws java.io.IOException{  
    // Write out element count, and any hidden stuff  
    int expectedModCount = modCount;  
    s.defaultWriteObject();  
 
        // 寫入“陣列的容量”  
        s.writeInt(elementData.length);  
 
    // 寫入“陣列的每一個元素”  
    for (int i=0; i<size; i++)  
            s.writeObject(elementData[i]);  
 
    if (modCount != expectedModCount) {  
            throw new ConcurrentModificationException();  
        }  
 
    }  
 
 
    // java.io.Serializable的讀取函式:根據寫入方式讀出  
    // 先將ArrayList的“容量”讀出,然後將“所有的元素值”讀出  
    private void readObject(java.io.ObjectInputStream s)  
        throws java.io.IOException, ClassNotFoundException {  
        // Read in size, and any hidden stuff  
        s.defaultReadObject();  
 
        // 從輸入流中讀取ArrayList的“容量”  
        int arrayLength = s.readInt();  
        Object[] a = elementData = new Object[arrayLength];  
 
        // 從輸入流中將“所有的元素值”讀出  
        for (int i=0; i<size; i++)  
            a[i] = s.readObject();  
    }  
}

幾點總結

    關於ArrayList的原始碼,給出幾點比較重要的總結:

    1、注意其三個不同的構造方法。無參構造方法構造的ArrayList的容量預設為10,帶有Collection引數的構造方法,將Collection轉化為陣列賦給ArrayList的實現陣列elementData。

    2、注意擴充容量的方法ensureCapacity。ArrayList在每次增加元素(可能是1個,也可能是一組)時,都要呼叫該方法來確保足夠的容量。當容量不足以容納當前的元素個數時,就設定新的容量為舊的容量的1.5倍加1,如果設定後的新容量還不夠,則直接新容量設定為傳入的引數(也就是所需的容量),而後用Arrays.copyof()方法將元素拷貝到新的陣列(詳見下面的第3點)。從中可以看出,當容量不夠時,每次增加元素,都要將原來的元素拷貝到一個新的陣列中,非常之耗時,也因此建議在事先能確定元素數量的情況下,才使用ArrayList,否則建議使用LinkedList。

    3、ArrayList的實現中大量地呼叫了Arrays.copyof()和System.arraycopy()方法。我們有必要對這兩個方法的實現做下深入的瞭解。

    首先來看Arrays.copyof()方法。它有很多個過載的方法,但實現思路都是一樣的,我們來看泛型版本的原始碼:

    public static <T> T[] copyOf(T[] original, int newLength) {
        return (T[]) copyOf(original, newLength, original.getClass());
    }

    很明顯呼叫了另一個copyof方法,該方法有三個引數,最後一個引數指明要轉換的資料的型別,其原始碼如下:

    public static <T,U> T[] copyOf(U[] original, int newLength, Class<? extends T[]> newType) {
        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;
    }

    這裡可以很明顯地看出,該方法實際上是在其內部又建立了一個長度為newlength的陣列,呼叫System.arraycopy()方法,將原來陣列中的元素複製到了新的陣列中。

    下面來看System.arraycopy()方法。該方法被標記了native,呼叫了系統的C/C++程式碼,在JDK中是看不到的,但在openJDK中可以看到其原始碼。該函式實際上最終呼叫了C語言的memmove()函式,因此它可以保證同一個陣列內元素的正確複製和移動,比一般的複製方法的實現效率要高很多,很適合用來批量處理陣列。Java強烈推薦在複製大量陣列元素時用該方法,以取得更高的效率。

    4、注意ArrayList的兩個轉化為靜態陣列的toArray方法。

    第一個,Object[] toArray()方法。該方法有可能會丟擲java.lang.ClassCastException異常,如果直接用向下轉型的方法,將整個ArrayList集合轉變為指定型別的Array陣列,便會丟擲該異常,而如果轉化為Array陣列時不向下轉型,而是將每個元素向下轉型,則不會丟擲該異常,顯然對陣列中的元素一個個進行向下轉型,效率不高,且不太方便。

    第二個,<T> T[] toArray(T[] a)方法。該方法可以直接將ArrayList轉換得到的Array進行整體向下轉型(轉型其實是在該方法的原始碼中實現的),且從該方法的原始碼中可以看出,引數a的大小不足時,內部會呼叫Arrays.copyOf方法,該方法內部建立一個新的陣列返回,因此對該方法的常用形式如下:

public static Integer[] vectorToArray2(ArrayList<Integer> v) {  
    Integer[] newText = (Integer[])v.toArray(new Integer[0]);  
    return newText;  
}  

     5、ArrayList基於陣列實現,可以通過下標索引直接查詢到指定位置的元素,因此查詢效率高,但每次插入或刪除元素,就要大量地移動元素,插入刪除元素的效率低。

    6、在查詢給定元素索引值等的方法中,原始碼都將該元素的值分為null和不為null兩種情況處理,ArrayList中允許元素為null。
  

   

本篇博文參加了CSDN博文大賽,如果您覺得這篇博文不錯,希望您能幫我投一票,謝謝!

投票地址:http://vote.blog.csdn.net/Article/Details?articleid=35568011


相關文章