集合-ArrayList 原始碼解析
ArrayList是一種以陣列實現的List,與陣列相比,它具有動態擴充套件的能力,因此也可稱之為動態陣列。
類圖
ArrayList實現了List, RandomAccess, Cloneable, java.io.Serializable等介面。
ArrayList實現了List,提供了基礎的新增、刪除、遍歷等操作。
ArrayList實現了RandomAccess,提供了隨機訪問的能力。
ArrayList實現了Cloneable,可以被克隆。
ArrayList實現了Serializable,可以被序列化。
原始碼解析
屬性
/** * 預設容量 */ private static final int DEFAULT_CAPACITY = 10; /** * 空陣列,如果傳入的容量為0時使用 */ private static final Object[] EMPTY_ELEMENTDATA = {}; /** * 空陣列,傳傳入容量時使用,新增第一個元素的時候會重新初始為預設容量大小 */ private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {}; /** * 儲存元素的陣列 */ transient Object[] elementData; // non-private to simplify nested class access /** * 集合中元素的個數 */ private int size;
(1)DEFAULT_CAPACITY
預設容量為10,也就是通過new ArrayList()建立時的預設容量。
(2)EMPTY_ELEMENTDATA
空的陣列,這種是通過new ArrayList(0)建立時用的是這個空陣列。
(3)DEFAULTCAPACITY_EMPTY_ELEMENTDATA
也是空陣列,這種是通過new ArrayList()建立時用的是這個空陣列,與EMPTY_ELEMENTDATA的區別是在新增第一個元素時使用這個空陣列的會初始化為DEFAULT_CAPACITY(10)個元素。
(4)elementData
真正存放元素的地方,使用transient是為了不序列化這個欄位。
至於沒有使用private修飾,後面註釋是寫的“為了簡化巢狀類的訪問”,但是樓主實測加了private巢狀類一樣可以訪問。
private表示是類私有的屬性,只要是在這個類內部都可以訪問,巢狀類或者內部類也是在類的內部,所以也可以訪問類的私有成員。
(5)size
真正儲存元素的個數,而不是elementData陣列的長度。
ArrayList(int initialCapacity)構造方法
傳入初始容量,如果大於0就初始化elementData為對應大小,如果等於0就使用EMPTY_ELEMENTDATA空陣列,如果小於0丟擲異常。
public ArrayList(int initialCapacity) { if (initialCapacity > 0) { // 如果傳入的初始容量大於0,就新建一個數組儲存元素 this.elementData = new Object[initialCapacity]; } else if (initialCapacity == 0) { // 如果傳入的初始容量等於0,使用空陣列EMPTY_ELEMENTDATA this.elementData = EMPTY_ELEMENTDATA; } else { // 如果傳入的初始容量小於0,丟擲異常 throw new IllegalArgumentException("Illegal Capacity: " + initialCapacity); } }
ArrayList()構造方法
不傳初始容量,初始化為DEFAULTCAPACITY_EMPTY_ELEMENTDATA空陣列,會在新增第一個元素的時候擴容為預設的大小,即10。
public ArrayList() { // 如果沒有傳入初始容量,則使用空陣列DEFAULTCAPACITY_EMPTY_ELEMENTDATA // 使用這個陣列是在新增第一個元素的時候會擴容到預設大小10 this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA; }
ArrayList 構造方法
傳入集合並初始化elementData,這裡會使用拷貝把傳入集合的元素拷貝到elementData陣列中,如果元素個數為0,則初始化為EMPTY_ELEMENTDATA空陣列。
/** * 把傳入集合的元素初始化到ArrayList中 */ public ArrayList(Collection<? extends E> c) { // 集合轉陣列 elementData = c.toArray(); if ((size = elementData.length) != 0) { // 檢查c.toArray()返回的是不是Object[]型別,如果不是,重新拷貝成Object[].class型別 if (elementData.getClass() != Object[].class) elementData = Arrays.copyOf(elementData, size, Object[].class); } else { // 如果c的空集合,則初始化為空陣列EMPTY_ELEMENTDATA this.elementData = EMPTY_ELEMENTDATA; } }
為什麼c.toArray();
返回的有可能不是Object[]型別呢?請看下面的程式碼:
public class ArrayTest { public static void main(String[] args) { Father[] fathers = new Son[]{}; // 列印結果為class [Lcom.coolcoding.code.Son; System.out.println(fathers.getClass()); List<String> strList = new MyList(); // 列印結果為class [Ljava.lang.String; System.out.println(strList.toArray().getClass()); } } class Father {} class Son extends Father {} class MyList extends ArrayList<String> { /** * 子類重寫父類的方法,返回值可以不一樣 * 但這裡只能用陣列型別,換成Object就不行 * 應該算是java本身的bug */ @Override public String[] toArray() { // 為了方便舉例直接寫死 return new String[]{"1", "2", "3"}; } }
add(E e)方法
新增元素到末尾,平均時間複雜度為O(1)。
public boolean add(E e) { // 檢查是否需要擴容 ensureCapacityInternal(size + 1); // 把元素插入到最後一位 elementData[size++] = e; return true; } private void ensureCapacityInternal(int minCapacity) { ensureExplicitCapacity(calculateCapacity(elementData, minCapacity)); } private static int calculateCapacity(Object[] elementData, int minCapacity) { // 如果是空陣列DEFAULTCAPACITY_EMPTY_ELEMENTDATA,就初始化為預設大小10 if (elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA) { return Math.max(DEFAULT_CAPACITY, minCapacity); } return minCapacity; } private void ensureExplicitCapacity(int minCapacity) { modCount++; if (minCapacity - elementData.length > 0) // 擴容 grow(minCapacity); } private void grow(int minCapacity) { int oldCapacity = elementData.length; // 新容量為舊容量的1.5倍 int newCapacity = oldCapacity + (oldCapacity >> 1); // 如果新容量發現比需要的容量還小,則以需要的容量為準 if (newCapacity - minCapacity < 0) newCapacity = minCapacity; // 如果新容量已經超過最大容量了,則使用最大容量 if (newCapacity - MAX_ARRAY_SIZE > 0) newCapacity = hugeCapacity(minCapacity); // 以新容量拷貝出來一個新陣列 elementData = Arrays.copyOf(elementData, newCapacity); }
(1)檢查是否需要擴容;
(2)如果elementData等於DEFAULTCAPACITY_EMPTY_ELEMENTDATA則初始化容量大小為DEFAULT_CAPACITY;
(3)新容量是老容量的1.5倍(oldCapacity + (oldCapacity >> 1)),如果加了這麼多容量發現比需要的容量還小,則以需要的容量為準;
(4)建立新容量的陣列並把老陣列拷貝到新陣列;
add(int index, E element)方法
新增元素到指定位置,平均時間複雜度為O(n)。
public void add(int index, E element) { // 檢查是否越界 rangeCheckForAdd(index); // 檢查是否需要擴容 ensureCapacityInternal(size + 1); // 將inex及其之後的元素往後挪一位,則index位置處就空出來了 System.arraycopy(elementData, index, elementData, index + 1, size - index); // 將元素插入到index的位置 elementData[index] = element; // 大小增1 size++; } private void rangeCheckForAdd(int index) { if (index > size || index < 0) throw new IndexOutOfBoundsException(outOfBoundsMsg(index)); }
(1)檢查索引是否越界;
(2)檢查是否需要擴容;
(3)把插入索引位置後的元素都往後挪一位;
(4)在插入索引位置放置插入的元素;
(5)大小加1;
addAll 方法
求兩個集合的並集。
/** * 將集合c中所有元素新增到當前ArrayList中 */ public boolean addAll(Collection<? extends E> c) { // 將集合c轉為陣列 Object[] a = c.toArray(); int numNew = a.length; // 檢查是否需要擴容 ensureCapacityInternal(size + numNew); // 將c中元素全部拷貝到陣列的最後 System.arraycopy(a, 0, elementData, size, numNew); // 大小增加c的大小 size += numNew; // 如果c不為空就返回true,否則返回false return numNew != 0; }
(1)拷貝c中的元素到陣列a中;
(2)檢查是否需要擴容;
(3)把陣列a中的元素拷貝到elementData的尾部;
get(int index)方法
獲取指定索引位置的元素,時間複雜度為O(1)。
public E get(int index) { // 檢查是否越界 rangeCheck(index); // 返回陣列index位置的元素 return elementData(index); } private void rangeCheck(int index) { if (index >= size) throw new IndexOutOfBoundsException(outOfBoundsMsg(index)); } E elementData(int index) { return (E) elementData[index]; }
(1)檢查索引是否越界,這裡只檢查是否越上界,如果越上界丟擲IndexOutOfBoundsException異常,如果越下界丟擲的是ArrayIndexOutOfBoundsException異常。
(2)返回索引位置處的元素;
remove(int index)方法
刪除指定索引位置的元素,時間複雜度為O(n)。
public E remove(int index) { // 檢查是否越界 rangeCheck(index); modCount++; // 獲取index位置的元素 E oldValue = elementData(index); // 如果index不是最後一位,則將index之後的元素往前挪一位 int numMoved = size - index - 1; if (numMoved > 0) System.arraycopy(elementData, index+1, elementData, index, numMoved); // 將最後一個元素刪除,幫助GC elementData[--size] = null; // clear to let GC do its work // 返回舊值 return oldValue; }
(1)檢查索引是否越界;
(2)獲取指定索引位置的元素;
(3)如果刪除的不是最後一位,則其它元素往前移一位;
(4)將最後一位置為null,方便GC回收;
(5)返回刪除的元素。
可以看到,ArrayList刪除元素的時候並沒有縮容。
remove(Object o)方法
刪除指定元素值的元素,時間複雜度為O(n)。
public boolean remove(Object o) { if (o == null) { // 遍歷整個陣列,找到元素第一次出現的位置,並將其快速刪除 for (int index = 0; index < size; index++) // 如果要刪除的元素為null,則以null進行比較,使用== if (elementData[index] == null) { fastRemove(index); return true; } } else { // 遍歷整個陣列,找到元素第一次出現的位置,並將其快速刪除 for (int index = 0; index < size; index++) // 如果要刪除的元素不為null,則進行比較,使用equals()方法 if (o.equals(elementData[index])) { fastRemove(index); return true; } } return false; } private void fastRemove(int index) { // 少了一個越界的檢查 modCount++; // 如果index不是最後一位,則將index之後的元素往前挪一位 int numMoved = size - index - 1; if (numMoved > 0) System.arraycopy(elementData, index+1, elementData, index, numMoved); // 將最後一個元素刪除,幫助GC elementData[--size] = null; // clear to let GC do its work }
(1)找到第一個等於指定元素值的元素;
(2)快速刪除;
fastRemove(int index)相對於remove(int index)少了檢查索引越界的操作,可見jdk將效能優化到極致。
retainAll方法
求兩個集合的交集。
public boolean retainAll(Collection<?> c) { // 集合c不能為null Objects.requireNonNull(c); // 呼叫批量刪除方法,這時complement傳入true,表示刪除不包含在c中的元素 return batchRemove(c, true); } /** * 批量刪除元素 * complement為true表示刪除c中不包含的元素 * complement為false表示刪除c中包含的元素 */ private boolean batchRemove(Collection<?> c, boolean complement) { final Object[] elementData = this.elementData; // 使用讀寫兩個指標同時遍歷陣列 // 讀指標每次自增1,寫指標放入元素的時候才加1 // 這樣不需要額外的空間,只需要在原有的陣列上操作就可以了 int r = 0, w = 0; boolean modified = false; try { // 遍歷整個陣列,如果c中包含該元素,則把該元素放到寫指標的位置(以complement為準) for (; r < size; r++) if (c.contains(elementData[r]) == complement) elementData[w++] = elementData[r]; } finally { // 正常來說r最後是等於size的,除非c.contains()丟擲了異常 if (r != size) { // 如果c.contains()丟擲了異常,則把未讀的元素都拷貝到寫指標之後 System.arraycopy(elementData, r, elementData, w, size - r); w += size - r; } if (w != size) { // 將寫指標之後的元素置為空,幫助GC for (int i = w; i < size; i++) elementData[i] = null; modCount += size - w; // 新大小等於寫指標的位置(因為每寫一次寫指標就加1,所以新大小正好等於寫指標的位置) size = w; modified = true; } } // 有修改返回true return modified; }
(1)遍歷elementData陣列;
(2)如果元素在c中,則把這個元素新增到elementData陣列的w位置並將w位置往後移一位;
(3)遍歷完之後,w之前的元素都是兩者共有的,w之後(包含)的元素不是兩者共有的;
(4)將w之後(包含)的元素置為null,方便GC回收;
removeAll
求兩個集合的單方向差集,只保留當前集合中不在c中的元素,不保留在c中不在當前集體中的元素。
public boolean removeAll(Collection<?> c) { // 集合c不能為空 Objects.requireNonNull(c); // 同樣呼叫批量刪除方法,這時complement傳入false,表示刪除包含在c中的元素 return batchRemove(c, false); }
與retainAll(Collection<?> c)方法類似,只是這裡保留的是不在c中的元素。
總結
(1)ArrayList內部使用陣列儲存元素,當陣列長度不夠時進行擴容,每次加一半的空間,ArrayList不會進行縮容;
(2)ArrayList支援隨機訪問,通過索引訪問元素極快,時間複雜度為O(1);
(3)ArrayList新增元素到尾部極快,平均時間複雜度為O(1);
(4)ArrayList新增元素到中間比較慢,因為要搬移元素,平均時間複雜度為O(n);
(5)ArrayList從尾部刪除元素極快,時間複雜度為O(1);
(6)ArrayList從中間刪除元素比較慢,因為要搬移元素,平均時間複雜度為O(n);
(7)ArrayList支援求並集,呼叫addAll(Collection<? extends E> c)方法即可;
(8)ArrayList支援求交集,呼叫retainAll(Collection<? extends E> c)方法即可;
(7)ArrayList支援求單向差集,呼叫removeAll(Collection<? extends E> c)方法即可;
思考
elementData設定成了transient,那ArrayList是怎麼把元素序列化的呢?
private void writeObject(java.io.ObjectOutputStream s) throws java.io.IOException{ // 防止序列化期間有修改 int expectedModCount = modCount; // 寫出非transient非static屬性(會寫出size屬性) s.defaultWriteObject(); // 寫出元素個數 s.writeInt(size); // 依次寫出元素 for (int i=0; i<size; i++) { s.writeObject(elementData[i]); } // 如果有修改,丟擲異常 if (modCount != expectedModCount) { throw new ConcurrentModificationException(); } } private void readObject(java.io.ObjectInputStream s) throws java.io.IOException, ClassNotFoundException { // 宣告為空陣列 elementData = EMPTY_ELEMENTDATA; // 讀入非transient非static屬性(會讀取size屬性) s.defaultReadObject(); // 讀入元素個數,沒什麼用,只是因為寫出的時候寫了size屬性,讀的時候也要按順序來讀 s.readInt(); if (size > 0) { // 計算容量 int capacity = calculateCapacity(elementData, size); SharedSecrets.getJavaOISAccess().checkArray(s, Object[].class, capacity); // 檢查是否需要擴容 ensureCapacityInternal(size); Object[] a = elementData; // 依次讀取元素到陣列中 for (int i=0; i<size; i++) { a[i] = s.readObject(); } } }
檢視writeObject()方法可知,先呼叫s.defaultWriteObject()方法,再把size寫入到流中,再把元素一個一個的寫入到流中。
一般地,只要實現了Serializable介面即可自動序列化,writeObject()和readObject()是為了自己控制序列化的方式,這兩個方法必須宣告為private,在java.io.ObjectStreamClass#getPrivateMethod()方法中通過反射獲取到writeObject()這個方法。
在ArrayList的writeObject()方法中先呼叫了s.defaultWriteObject()方法,這個方法是寫入非static非transient的屬性,在ArrayList中也就是size屬性。同樣地,在readObject()方法中先呼叫了s.defaultReadObject()方法解析出了size屬性。
elementData定義為transient的優勢,自己根據size序列化真實的元素,而不是根據陣列的長度序列化元素,減少了空間佔用。
&n