java集合之ArrayList源碼分析

1.簡介

ArrayList集合是我們用的最多的一個集合類之一,也是java集合框架中比較重要的一個類,它繼承了AbstractList,實現了List接口,是一個長度可變的集合,提供了增刪除改查的功能,底層實現是--數組。它除了實現了List接口,還實現了RandomAccess, Cloneable, Serializable等接口

RandomAccess

下面是jdk的註解翻譯

List 實現所使用的標記接口,用來表明其支持快速(通常是固定時間)隨機訪問。此接口的主要目的是允許一般的算法更改其行爲,從而在將其應用到隨機或連續訪問列表時能提供良好的性能。

將操作隨機訪問列表的最佳算法(如 ArrayList )應用到連續訪問列表(如 LinkedList )時,可產生二次項的行爲。如果將某個算法應用到連續訪問列表,那麼在應用可能提供較差性能的算法前,鼓勵使用一般的列表算法檢查給定列表是否爲此接口的一個 instanceof ,如果需要保證可接受的性能,還可以更改其行爲。

現在已經認識到,隨機和連續訪問之間的區別通常是模糊的。例如,如果列表很大時,某些 List 實現提供漸進的線性訪問時間,但實際上是固定的訪問時間。這樣的 List 實現通常應該實現此接口。

強調:JDK中推薦的是對List集合儘量要實現RandomAccess接口

如果集合類是RandomAccess的實現,則儘量用for(int i = 0; i < size; i++) 來遍歷而不要用Iterator迭代器來遍歷。

Cloneable:說明可被複制

Serializable:說明能被序列化

2.看源碼

ArrayList底層使用的是java數組來存儲集合的元素,類型是Object類

 private transient Object[] elementData;
來表示集合的元素個數
private int size;

ArrayList集合有不同的構造函數

會默認創建一個數組長度爲10的集合 
public ArrayList() {
        this(10);
    }
創建一個自定義數組長度的集合,並且傳入的值不能小於0
public ArrayList(int initialCapacity) {
        super();
        if (initialCapacity < 0)
            throw new IllegalArgumentException("Illegal Capacity: "+
                                               initialCapacity);
        this.elementData = new Object[initialCapacity];
    }
//一個集合類爲參數
public ArrayList(Collection<? extends E> c) {
        //將傳入的集合類轉換爲數組類型賦值給elementData
        elementData = c.toArray();
       //當前集合的長度也等傳入集合的長度
        size = elementData.length;
        // c.toArray might (incorrectly) not return Object[] (see 6260652)
      //如果傳入的集合類型不等於Object類型
        if (elementData.getClass() != Object[].class)
         //通過Arrays.copOf()方法返回一個Object類型的數組,並賦值給elementData
        elementData = Arrays.copyOf(elementData, size, Object[].class);
    }
由於有可能表示集合長度的size和表示集合容量的elementDate長度不一樣,然後在不需要添加元素的情況下,可以使用此方法減小elementData的大小 
public void trimToSize() {
        modCount++;
        int oldCapacity = elementData.length;
        if (size < oldCapacity) {
            elementData = Arrays.copyOf(elementData, size);
        }
    }

底下的代碼是在需要擴容的情況下,給elementData數組擴容,默認擴容是原數組長度*1.5

 public void ensureCapacity(int minCapacity) {
        if (minCapacity > 0)
            ensureCapacityInternal(minCapacity);
    }
    //需要擴容 調用 grow()方法
    private void ensureCapacityInternal(int minCapacity) {
        modCount++;
        // overflow-conscious code
        if (minCapacity - elementData.length > 0)
            grow(minCapacity);
    }
private static final int MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8;//ArrayList設置的最大容量
    
private void grow(int minCapacity) {
        // overflow-conscious code
        int oldCapacity = elementData.length;
       //對原數組長度進行擴容,已1.5倍的倍數擴容
        int newCapacity = oldCapacity + (oldCapacity >> 1);
        //如果擴容後的數組長度還不夠,那麼已傳入的參數爲數組擴容的數值 minCa
        if (newCapacity - minCapacity < 0)
            newCapacity = minCapacity;
        //ArrayList設置了數組的最大容量,如果沒超出用Arrays.copyOf()進行復制,不夠的元素使用null
        //如果超出了調用hugeCapactity()檢查是否溢出,如果沒有溢出返回合適的數組擴容長度值,然後進行數組複製
        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);
    }
//檢查是否溢出,並返回一個合適的數組擴容長度值
private static int hugeCapacity(int minCapacity) {
      if (minCapacity < 0) // overflow
      throw new OutOfMemoryError(); 
     return (minCapacity > MAX_ARRAY_SIZE) ?
     Integer.MAX_VALUE : MAX_ARRAY_SIZE;
} 

檢查集合是否爲空,爲空返回true

public boolean isEmpty() {
        return size == 0;
    }

查詢該集合是否包含傳入的參數,包含返回true

public boolean contains(Object o) {
        return indexOf(o) >= 0;
    }

返回給定元素在集合中第一次出現的角標,如不存在返回-1

首先檢查o是否爲null,如果爲null,就返回集合中第一個null元素的位置;如果不爲null,就是用equals函數進行相等性檢查。之所以這樣,是因爲如果直接對null調用equals方法,會拋出空指針異常。同時也不能循環遍歷數組中的元素調用equals方法檢查是否相等,因爲ArrayList集合中允許有null元素的存在。

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

返回給定元素在集合中最後一次出現的角標,如不存在返回-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;
    }
集合複製,本質上就是使用Arrays類進行元素複製
  public Object clone() {
        try {
            @SuppressWarnings("unchecked")
                ArrayList<E> v = (ArrayList<E>) super.clone();
            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();
        }
    }

獲取元素

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

        return elementData(index);
    }
    也是操作的數組
 @SuppressWarnings("unchecked")
    E elementData(int index) {
        return (E) elementData[index];
    }
將給定位置的元素替換爲給定元素,返回替換前的元素
public E set(int index, E element) {
        rangeCheck(index);

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

添加元素,添加前先判斷是否需要對數組進行擴容,並對數組長度加一

public boolean add(E e) {
        ensureCapacityInternal(size + 1);  //在集合長度+1的情況下,是否需要對數組進行擴容
        elementData[size++] = e;
        return true;
    }

在給定位置添加給定元素,使用System類型進行數組拷貝,也需要判斷是否需要擴容

    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++;
    }
//將數據拷貝到新數組中,屬性:源數據,從哪個角標開始,目標數據源,,目標數組的起始位置,拷貝長度
System.arraycopy(elementData, index, elementData, index + 1, size - index); elementData[index] = element; size++; }

刪除給定角標的元素,原理也是 使用System類型進行數組拷貝,然後返回被刪除的元素

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

        modCount++;//這個是屬性來自父類AbstractList,是用來記錄列表已被結構修改的次數
        E oldValue = 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;
    }
刪除集合中給定的元素,循環數組比較數組中的值和給定值,找出給定元素的角標,然後調用刪除方法,沒有找到就返回false
    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; // Let gc do its work
    }

清空集合的數據,也很簡單,只是循環數據,將數組中的每個元素都賦值爲null

  public void clear() {
        modCount++;
        // Let gc do its work
        for (int i = 0; i < size; i++)
            elementData[i] = null;
        size = 0;
    }

基本上整個ArrayList的簡單增刪改查,大家也都理解了,也能自己實現個簡單ArrayList了











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