走進 JDK 之 ArrayList（一）
這篇本來是準備寫 Java 集合框架概述 的，就是寫起來效果不怎麼樣，可能是對整個 Java 集合框架還沒有做到了然於心。所以還是先來原始碼分析，寫完所有集合類的分析之後，再來總體概述。今天就從最最常用的 ArrayList 說起。
概述
ArrayList 是一種可以動態增長和縮減的線性表資料結構，允許重複元素，允許 null 值。基於動態陣列實現，在記憶體中是連續的，這點和連結串列不同。另外，它不是執行緒安全的，與之相對應的同樣基於動態陣列實現的有序序列 Vector 則是執行緒安全的。
由於陣列在記憶體中佔用連續的記憶體空間，所以 ArrayList 具備隨機訪問能力，其根據下標隨機訪問的時間複雜度是 O(1) 。同樣，為了保證記憶體的連續性，其 插入 和 刪除 操作就相對低效的多。在指定位置插入資料，就要將該位置之後的資料都往後挪，才能騰出空間。在指定位置刪除資料，就要將該位置之後的資料全部往前挪，才能保證空間連續性。它們的平均時間複雜度都是 O(n) 。
ArrayList 的使用還是比較簡單的，下面還是帶著兩個問題看原始碼:
ArrayList 初始大小是多少？它是如何動態擴容的？
原始碼解析
類宣告
public class ArrayList<E> extends AbstractList<E>
implements List<E>, RandomAccess, Cloneable, java.io.Serializable {}
複製程式碼
-
Collection是所有集合的根介面，定義了一些通用性的行為，抽象類AbstractCollection提供了部分集合型別無關的通用實現。List介面針對有序集合擴充套件了Collection介面，抽象類AbstractList提供了部分預設實現，當然ArrayList並沒有照單全收，更多的是重寫提供了自己的實現。 - 實現了
RandomAccess介面說明其支援快速隨機訪問，其實並沒有實現任何方法，應該僅僅只是起一個標記的作用。 - 實現
Cloneable介面，提供淺拷貝。 - 實現了
Serializable介面，提供序列化能力，且重寫了readObject()和writeObject()方法。
成員變數
private static final int DEFAULT_CAPACITY = 10; // 預設初始容量
private static final Object[] EMPTY_ELEMENTDATA = {}; // 共享空陣列
private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {}; // 預設共享空陣列
transient Object[] elementData; // 真正儲存資料的陣列
private int size; // 當前元素個數
private static final int MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8; // 陣列容量最大值
複製程式碼
elementData 是真正用來儲存資料的陣列。關於它的預設大小，讓人很容易搞錯。一看到 DEFAULT_CAPACITY 為 10，讓人情不自禁的認為我一旦新建了一個 ArrayList ，它的預設大小就是 10。其實並不是這樣的，後面看到建構函式的時候你就理解了。
陣列的最大容量是 Integer.MAX_VALUE - 8 ，看到這個數字你應該很熟悉。 AbstractStringBuilder 類用來儲存字元的 char[] ，最大容量也是這個數字。考慮到一些虛擬機器實現會保留陣列物件的頭資訊，大於此值可能會導致 OOM ，注意只是可能。但是如果大於 Integer.MAX_VALUE 的話，就會直接丟擲 OOM 。
建構函式
public ArrayList() {
this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;
}
複製程式碼
DEFAULTCAPACITY_EMPTY_ELEMENTDATA 是一個空陣列，所以當你執行 List list = new ArrayList() 時，實際上建立了一個空陣列，並不是容量為 10 的陣列。
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);
}
}
複製程式碼
當我們可以預估到 ArrayList 需要容納的元素數量時，我們可以直接指定陣列大小 initialCapacity ，避免後續自動擴容帶來的效能損耗和空間浪費。 initialCapacity 大小按如下規則：
EMPTY_ELEMENTDATA
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;
}
}
複製程式碼
我們也可以用一個集合來初始化 ArrayList 。呼叫集合的 toArray() 方法轉換為陣列並賦給 elementData 。如果傳入的集合長度為 0，則將空陣列 EMPTY_ELEMENTDATA 賦給 elementData 。
方法
ArrayList 提供了插入，刪除，清空，查詢，遍歷等基本集合操作。下面從 add() 開始，通過原始碼更加深刻的理解 ArrayList 的實現。
add()
public void add(int index, E element) {
rangeCheckForAdd(index); // 邊界檢測
ensureCapacityInternal(size + 1);// Increments modCount!!
System.arraycopy(elementData, index, elementData, index + 1,
size - index); // 移動 index 之後的所有元素
elementData[index] = element;
size++;
}
複製程式碼
rangeCheckForAdd() 這個方法在後面也會用到很多次，主要做邊界檢測，當 index 大於 size 或者小於 0 時，都會丟擲 IndexOutOfBoundsException 異常。
第二步 ensureCapacityInternal() 的作用是保證集合的空間足以繼續新增元素，空間不足時會自動擴容。這個方法很重要，可以說是 ArrayList 的核心了。我們來看一下到底是如何擴容的。
private void ensureCapacityInternal(int minCapacity) {
ensureExplicitCapacity(calculateCapacity(elementData, minCapacity));
}
private void ensureExplicitCapacity(int minCapacity) {
modCount++;
// overflow-conscious code
if (minCapacity - elementData.length > 0)
grow(minCapacity); // 擴容
}
複製程式碼
通過 calculateCapacity() 方法計算合適的最少空間：
private static int calculateCapacity(Object[] elementData, int minCapacity) {
if (elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA) {
return Math.max(DEFAULT_CAPACITY, minCapacity); // 如果當前是空陣列，取 minCapacity 和 10 的較大值
}
return minCapacity;
}
複製程式碼
如果初始化時沒有指定集合大小，則取 DEFAULT_CAPACITY （等於10）和 minCapacity 的較大值。所以，如果我們構建了一個空 ArrayList，當我們新增第一個元素的時候，就會預設擴容至 10 。
當 minCapacity 大於當前陣列長度時，就需要擴容了， grow() 方法就是擴容的具體實現：
private void grow(int minCapacity) {
// overflow-conscious code
int oldCapacity = elementData.length; // 原陣列大小
int newCapacity = oldCapacity + (oldCapacity >> 1); // 擴容至原來的 1.5 倍
if (newCapacity - minCapacity < 0)
newCapacity = minCapacity;
if (newCapacity - MAX_ARRAY_SIZE > 0)
newCapacity = hugeCapacity(minCapacity); // 容量最大最大隻能是 Integer.MAX_VALUE
// minCapacity is usually close to size, so this is a win:
elementData = Arrays.copyOf(elementData, newCapacity);
}
複製程式碼
每次擴容後為原來容量的 1.5 倍，所以當我們可以預估元素數量的時候，直接在建構函式中指定，就可以節約空間了。如果擴容後的新容量大於 MAX_ARRAY_SIZE ，即 Integer.MAX_VALUE - 8 ，呼叫 hugeCapacity() 方法再做一次判斷。
private static int hugeCapacity(int minCapacity) {
if (minCapacity < 0) // overflow
throw new OutOfMemoryError(); // 小於 0，即發生溢位，丟擲 OOM
return (minCapacity > MAX_ARRAY_SIZE) ? // 最大隻可能為 Integer.MAX_VALUE
Integer.MAX_VALUE : MAX_ARRAY_SIZE;
}
複製程式碼
最後使用 Arrays.copyOf() 方法建立新陣列：
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;
}
複製程式碼
擴容完成之後，就可以愉快的新增元素了，直接給 elementData[size++] 賦值即可。
一個引數的 add(E element) 方法是在陣列尾部新增元素，除此之外，ArrayList 還支援在指定位置新增元素， add(int index, E element) :
public void add(int index, E element) {
rangeCheckForAdd(index); // 邊界檢測
ensureCapacityInternal(size + 1);// Increments modCount!!
System.arraycopy(elementData, index, elementData, index + 1,
size - index); // 移動 index 之後的所有元素
elementData[index] = element;
size++;
}
複製程式碼
在指定位置 index 處插入一個元素，就需要把 index 後面的元素都依次往後移動，給要新增的元素騰出來位置，所以 ArrayList 的插入操作並不是那麼的高效。
remove()
remove() 方法也有兩個，第一個是移除指定位置的元素：
public E remove(int index) {
rangeCheck(index); // 邊界檢測
modCount++;
E oldValue = elementData(index);
int numMoved = size - index - 1;
if (numMoved > 0) // 移動 index 之後的所有元素
System.arraycopy(elementData, index+1, elementData, index,
numMoved);
elementData[--size] = null; // clear to let GC do its work
return oldValue;
}
複製程式碼
邏輯比較簡單，將 index 之後的所有元素都依次往前移動，注意在完成移動之後，將集合尾部元素置空，以便 GC 回收。和插入一樣， ArrayList 的刪除也不是那麼的高效，時間複雜度都是 O(n) 。
第二個是移除指定元素：
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 還是其他物件， remove() 方法只會移除其中的第一個。這裡用的移除用的是 fastRemove() 方法，其實和普通的 remove() 方法沒什麼區別，只是取消了邊界檢測，且沒有返回值，所以更 fast 一點。
/*
* Private remove method that skips bounds checking and does not
* return the value removed.
* 取消邊界檢查，且不返回 remove 掉的值
*/
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
}
複製程式碼
removeAll() && retainAll()
public boolean removeAll(Collection<?> c) {
Objects.requireNonNull(c);
return batchRemove(c, false);
}
複製程式碼
removeAll() 方法是移除所有包含在集合 c 中的元素，呼叫 batchRemove() 實現。
public boolean retainAll(Collection<?> c) {
Objects.requireNonNull(c);
return batchRemove(c, true);
}
複製程式碼
retainAll() 方法正好與 removeAll() 相反，是保留所有包含在集合 c 中的元素，移除其他元素，也是呼叫 batchRemove() 實現。
batchRemove() 方法應該是 ArrayList 中比較複雜的一個方法了，但是絕對值得仔細一看。
/**
*
* @param c 集合
* @param complement 為 true 時，保留指定集合中的值，為 false 時，刪除指定集合中的值
* @return 陣列中重複的元素都會被刪除，只要發生刪除就會返回 true
*/
private boolean batchRemove(Collection<?> c, boolean complement) {
final Object[] elementData = this.elementData;
int r = 0, w = 0;
boolean modified = false;
try {
// 遍歷陣列，並檢查這個集合是否包含對應的值，移動要保留的值到陣列前面，w 最終值為要保留的元素的數量
// 也就是說，如果是 retainAll()，就將相同元素移動到陣列前面。
// 如果是 removeAll()，就將不同元素移動到陣列前面
for (; r < size; r++)
if (c.contains(elementData[r]) == complement)
elementData[w++] = elementData[r];
} finally {
// Preserve behavioral compatibility with AbstractCollection,
// even if c.contains() throws.
if (r != size) { // r != size，說明發生異常，迴圈未執行完成
System.arraycopy(elementData, r,
elementData, w,
size - r); // 將 r 之後的元素移動過去
w += size - r;
}
// w == size 說明保留全部元素，modified 返回 false
if (w != size) {
// clear to let GC do its work
for (int i = w; i < size; i++)
elementData[i] = null;
modCount += size - w; // 更新 modCount
size = w; // w 就是要儲存的元素個數
modified = true;
}
}
return modified;
}
複製程式碼
總之，不管你是 removeAll() 還是 retainAll() ，我 batchRemove() 一律把要保留的元素移到前面，要刪掉的元素扔後面，並記錄下面要保留元素的個數。
其他
後面的方法都很簡單直白，大致瀏覽一下就可以了。
// 獲取集合大小
public int size() {
return size;
}
// 判斷集合是否為空
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 E set(int index, E element) {
rangeCheck(index);
E oldValue = elementData(index);
elementData[index] = element;
return oldValue;
}
// 獲取指定位置的元素
public E get(int index) {
rangeCheck(index);
return elementData(index);
}
// 清空集合
public void clear() {
modCount++;
// clear to let GC do its work
for (int i = 0; i < size; i++)
elementData[i] = null;
size = 0;
}
複製程式碼
總結
簡單總結一下 ArrayList：
O(1) O(n)
既然標題是 走進 JDK 之 ArrayList（一） ，那麼肯定還有二嘛。如果你有認真看 ArrayList 原始碼，你會發現一個經常出現的欄位 modCount ，字面意思就是修改次數。基本但凡涉及到修改集合的方法，大多都會執行 modCount++ 操作，以 clear() 方法為例：
public void clear() {
modCount++;
// clear to let GC do its work
for (int i = 0; i < size; i++)
elementData[i] = null;
size = 0;
}
複製程式碼
那麼，這個 modCount 究竟有什麼作用，這便是 走進 JDK 之 ArrayList（二） 所要詳細說明的。
文章首發微信公眾號： 秉心說 ， 專注 Java 、 Android 原創知識分享，LeetCode 題解。
更多 JDK 原始碼解析，掃碼關注我吧！
