ArrayList源碼解析與實現

第1部分   ArrayList介紹
       ArrayList簡介
  

ArrayList 是一個數組隊列,相當於 動態數組。與Java中的數組相比,它的容量能動態增長。它繼承於AbstractList,實現了List, RandomAccess, Cloneable, java.io.Serializable這些接口。

ArrayList 繼承了AbstractList,實現了List。它是一個數組隊列,提供了相關的添加、刪除、修改、遍歷等功能。
ArrayList 實現了RandmoAccess接口,即提供了隨機訪問功能。RandmoAccess是java中用來被List實現,爲List提供快速訪問功能的。在ArrayList中,我們即可以通過元素的序號快速獲取元素對象;這就是快速隨機訪問。稍後,我們會比較List的“快速隨機訪問”和“通過Iterator迭代器訪問”的效率。

ArrayList 實現了Cloneable接口,即覆蓋了函數clone(),能被克隆。

ArrayList 實現java.io.Serializable接口,這意味着ArrayList支持序列化,能通過序列化去傳輸。

vector與ArryList有着類似操作,vector在jdk1.0出現,屬於元老級,ArrayList不是線程安全的,曾經在Tomcat小測試中用到過!所以建議在單線程下使用ArrayList,當然多線程我們可以使用vector或者CopyOnWriteArrayList,第二個沒有用到過,據說是用在併發中用。

    

    ArrayList的構造函數

// 默認構造函數
ArrayList()

// initialCapacity是ArrayList的默認容量大小。當由於增加數據導致容量不足時,通常容量會添加上一次容量大小的1.5倍。
ArrayList(int initialCapacity)

// 創建一個包含collection的ArrayList
ArrayList(Collection<? extends E> collection)

    ArrayList的繼承關係

  •    
    java.lang.Object
       ↳     java.util.AbstractCollection<E>
             ↳     java.util.AbstractList<E>
                   ↳     java.util.ArrayList<E>
    
    public class ArrayList<E> extends AbstractList<E>
            implements List<E>, RandomAccess, Cloneable, java.io.Serializable {}

  • ArrayList的方法(基於JDK1.7)


    boolean	add(E e)
    
    void  add(int index, E element)
    
    boolean	 addAll(Collection<? extends E> c)
    
    boolean	 addAll(int index, Collection<? extends E> c)
    
    void	clear()
    
    Object	clone()
    
    boolean	contains(Object o)
    
    void  ensureCapacity(int minCapacity)
    
    E   get(int index)
    
    int  indexOf(Object o)
    
    boolean	isEmpty()
    
    Iterator<E>  iterator()
    
    int  lastIndexOf(Object o)
    
    ListIterator<E>	 listIterator()
    
    ListIterator<E>	 listIterator(int index)
    
    E	remove(int index)
    
    boolean	   remove(Object o)
    
    boolean	    removeAll(Collection<?> c)
    
    protected    void   removeRange(int fromIndex, int toIndex)
    
    boolean	     retainAll(Collection<?> c)
    
    E	set(int index, E element)
    
    int	size()
    
    List<E>	    subList(int fromIndex, int toIndex)
    
    Object[]	toArray()
    
    <T> T[]	        toArray(T[] a)
    
    void	  trimToSize()
    


    第2部分   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;
        // c.toArray might (incorrectly) not return Object[] (see 6260652)
        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
        modCount++;
        int oldCapacity = elementData.length;
        // 若當前容量不足以容納當前的元素個數,設置 新的容量=“(原始容量x3)/2 + 1”
        if (minCapacity > oldCapacity) {
            Object oldData[] = elementData;
            int newCapacity = (oldCapacity * 3)/2 + 1;
            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的模板數組。所謂模板數組,即可以將T設爲任意的數據類型
    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();
    }
}

總結
(01) ArrayList 實際上是通過一個數組去保存數據的。當我們構造ArrayList時;若使用默認構造函數,則ArrayList的默認容量大小是10
(02) 當ArrayList容量不足以容納全部元素時,ArrayList會重新設置容量:新的容量=“int
((原始容量x3)/2 + 1)”
(03) ArrayList的克隆函數,即是將全部元素克隆到一個數組中。
(04) ArrayList實現java.io.Serializable的方式。當寫入到輸出流時,先寫入“容量”,再依次寫入“每一個元素”;當讀出輸入流時,先讀取“容量”,再依次讀取“每一個元素”。


第3部分   ArrayList實例測試
import java.util.*;


public class ArrayListTest {

    public static void main(String[] args) {
        
        // 創建ArrayList
        ArrayList list = new ArrayList();

        // 將“”
        list.add("1");
        list.add("2");
        list.add("3");
        list.add("4");
        // 將下面的元素添加到第1個位置
        list.add(0, "5");

        // 獲取第1個元素
        System.out.println("the first element is: "+ list.get(0));
        // 刪除“3”
        list.remove("3");
        // 獲取ArrayList的大小
        System.out.println("Arraylist size=: "+ list.size());
        // 判斷list中是否包含"3"
        System.out.println("ArrayList contains 3 is: "+ list.contains(3));
        // 設置第2個元素爲10
        list.set(1, "10");

        // 通過Iterator遍歷ArrayList
        for(Iterator iter = list.iterator(); iter.hasNext(); ) {
            System.out.println("next is: "+ iter.next());
        }

        // 將ArrayList轉換爲數組
        String[] arr = (String[])list.toArray(new String[0]);
        for (String str:arr)
            System.out.println("str: "+ str);

        // 清空ArrayList
        list.clear();
        // 判斷ArrayList是否爲空
        System.out.println("ArrayList is empty: "+ list.isEmpty());
    }
}


 運行結果:

the first element is: 5
Arraylist size=: 4
ArrayList contains 3 is: false
next is: 5
next is: 10
next is: 2
next is: 4
str: 5
str: 10
str: 2
str: 4
ArrayList is empty: true


  
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章