目錄
什么是ArrayList？
ArrayList是Java集合常用的數據結構之一，繼承自AbstractList，實現了List，RandomAccess、Cloneable、Serializable等一系列接口，支持快速訪問，復制和序列化。底層是基於數組實現容量大小動態變化，允許null值存在。
默認size的初始大小為10：
擴容公式為
當前容量長度*1.5
即：默認長度為10
第一次擴充后的長度為15
第二次擴充后的長度為22
第三次擴從后的長度為33
源碼解析
類屬性
/**
* 序列號
*/
private static final long serialVersionUID = 8683452581122892189L;
/**
* 默認容量
*/
private static final int DEFAULT_CAPACITY = 10;
/**
* 一個空數組
* 當用戶指定該 ArrayList 容量為 0 時，返回該空數組
*/
private static final Object[] EMPTY_ELEMENTDATA = {};
/**
* 一個空數組實例
* - 當用戶調用無參構造函數，返回的是該數組==>剛創建一個 ArrayList 時，其內數據量為 0。
* - 當用戶第一次添加元素時，該數組將會擴容，變成默認容量為 10(DEFAULT_CAPACITY) 的一個數組===>通過 ensureCapacityInternal() 實現
* 它與 EMPTY_ELEMENTDATA 的區別就是：該數組是默認返回的，而后者是在用戶指定容量為 0 時返回
*/
private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};
/**
* ArrayList基於數組實現，用該數組保存數據, ArrayList 的容量就是該數組的長度
* - 該值為 DEFAULTCAPACITY_EMPTY_ELEMENTDATA 時，當第一次添加元素進入 ArrayList 中時，數組將擴容值 DEFAULT_CAPACITY(10)
*/
transient Object[] elementData;
/**
* ArrayList實際存儲的數據數量
*/
private int size;
構造方法：
/**
* 創建一個具有初試容量的ArrayList
* @param initialCapacity 初始容量
* @throws IllegalArgumentException 當初試容量值非法(小於0)時拋出
*/
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，此時其內數組緩沖區 elementData = {}, 長度為 0
* - 當元素第一次被加入時，擴容至默認容量 10
*/
public ArrayList() {
this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;
}
/**
* 創建一個包含collection的ArrayList
* @param c 要放入 ArrayList 中的集合，其內元素將會全部添加到新建的 ArrayList 實例中
* @throws NullPointerException 當參數 c 為 null 時拋出異常
*/
public ArrayList(Collection<? extends E> c) {
//將集合轉化成Object[]數組
elementData = c.toArray();
//把轉化后的Object[]數組長度賦值給當前ArrayList的size，並判斷是否為0
if ((size = elementData.length) != 0) {
// c.toArray might (incorrectly) not return Object[] (see 6260652)
// 這句話意思是：c.toArray 可能不會返回 Object[]，可以查看 java 官方編號為 6260652 的 bug
if (elementData.getClass() != Object[].class)
// 若 c.toArray() 返回的數組類型不是 Object[]，則利用 Arrays.copyOf(); 來構造一個大小為 size 的 Object[] 數組
elementData = Arrays.copyOf(elementData, size, Object[].class);
} else {
// 替換空數組
this.elementData = EMPTY_ELEMENTDATA;
}
}
類方法
/**
* 將數組緩沖區大小調整到實際 ArrayList 存儲元素的大小，即 elementData = Arrays.copyOf(elementData, size);
* - 該方法由用戶手動調用，以減少空間資源浪費的目的 ce.
*/
public void trimToSize() {
// modCount 是 AbstractList 的屬性值：protected transient int modCount = 0;
// [問] modCount 有什么用？
modCount++;
// 當實際大小 < 數組緩沖區大小時
// 如調用默認構造函數后，剛添加一個元素，此時 elementData.length = 10，而 size = 1
// 通過這一步，可以使得空間得到有效利用，而不會出現資源浪費的情況
if (size < elementData.length) {
// 注意這里：這里的執行順序不是 (elementData = (size == 0) ) ? EMPTY_ELEMENTDATA : Arrays.copyOf(elementData, size);
// 而是：elementData = ((size == 0) ? EMPTY_ELEMENTDATA : Arrays.copyOf(elementData, size));
// 這里是運算符優先級的語法
// 調整數組緩沖區 elementData，變為實際存儲大小 Arrays.copyOf(elementData, size)
//先判斷size是否為0，如果為0:實際存儲為EMPTY_ELEMENTDATA,如果有數據就是Arrays.copyOf(elementData, size)
elementData = (size == 0)
? EMPTY_ELEMENTDATA
: Arrays.copyOf(elementData, size);
}
}
/**
* 指定 ArrayList 的容量
* @param minCapacity 指定的最小容量
*/
public void ensureCapacity(int minCapacity) {
// 最小擴充容量，默認是 10
//這句就是：判斷是不是空的ArrayList,如果是的最小擴充容量10，否則最小擴充量為0
//上面無參構造函數創建后，當元素第一次被加入時，擴容至默認容量 10,就是靠這句代碼
int minExpand = (elementData != DEFAULTCAPACITY_EMPTY_ELEMENTDATA)
? 0
: DEFAULT_CAPACITY;
// 若用戶指定的最小容量 > 最小擴充容量，則以用戶指定的為准，否則還是 10
if (minCapacity > minExpand) {
ensureExplicitCapacity(minCapacity);
}
}
/**
* 私有方法：明確 ArrayList 的容量，提供給本類使用的方法
* - 用於內部優化，保證空間資源不被浪費：尤其在 add() 方法添加時起效
* @param minCapacity 指定的最小容量
*/
private void ensureCapacityInternal(int minCapacity) {
// 若 elementData == {}，則取 minCapacity 為 默認容量和參數 minCapacity 之間的最大值
// 注：ensureCapacity() 是提供給用戶使用的方法，在 ArrayList 的實現中並沒有使用
if (elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA) {
minCapacity= Math.max(DEFAULT_CAPACITY, minCapacity);
}
ensureExplicitCapacity(minCapacity);
}
/**
* 私有方法：明確 ArrayList 的容量
* - 用於內部優化，保證空間資源不被浪費：尤其在 add() 方法添加時起效
* @param minCapacity 指定的最小容量
*/
private void ensureExplicitCapacity(int minCapacity) {
// 將“修改統計數”+1，該變量主要是用來實現fail-fast機制的
modCount++;
// 防止溢出代碼：確保指定的最小容量 > 數組緩沖區當前的長度
// overflow-conscious code
if (minCapacity - elementData.length > 0)
grow(minCapacity);
}
/**
* 數組緩沖區最大存儲容量
* - 一些 VM 會在一個數組中存儲某些數據--->為什么要減去 8 的原因
* - 嘗試分配這個最大存儲容量，可能會導致 OutOfMemoryError(當該值 > VM 的限制時)
*/
private static final int MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8;
/**
* 私有方法：擴容，以確保 ArrayList 至少能存儲 minCapacity 個元素
* - 擴容計算：newCapacity = oldCapacity + (oldCapacity >> 1); 擴充當前容量的1.5倍
* @param minCapacity 指定的最小容量
*/
private void grow(int minCapacity) {
// 防止溢出代碼
int oldCapacity = elementData.length;
// 運算符 >> 是帶符號右移. 如 oldCapacity = 10,則 newCapacity = 10 + (10 >> 1) = 10 + 5 = 15
int newCapacity = oldCapacity + (oldCapacity >> 1);
if (newCapacity - minCapacity < 0) // 若 newCapacity 依舊小於 minCapacity
newCapacity = minCapacity;
if (newCapacity - MAX_ARRAY_SIZE > 0) // 若 newCapacity 大於最大存儲容量，則進行大容量分配
newCapacity = hugeCapacity(minCapacity);
// minCapacity is usually close to size, so this is a win:
elementData = Arrays.copyOf(elementData, newCapacity);
}
/**
* 私有方法：大容量分配，最大分配 Integer.MAX_VALUE
* @param minCapacity
*/
private static int hugeCapacity(int minCapacity) {
if (minCapacity < 0) // overflow
throw new OutOfMemoryError();
return (minCapacity > MAX_ARRAY_SIZE) ?
Integer.MAX_VALUE :
MAX_ARRAY_SIZE;
}
/**
* 返回ArrayList實際存儲的元素數量
*/
public int size() {
return size;
}
/**
* ArrayList是否有元素
*/
public boolean isEmpty() {
return size == 0;
}
/**
* 是否包含o元素
*/
public boolean contains(Object o) {
// 根據 indexOf() 的值(索引值)來判斷，大於等於 0 就包含
// 注意：等於 0 的情況不能漏，因為索引號是從 0 開始計數的
return indexOf(o) >= 0;
}
/**
* 順序查找，返回元素的最低索引值(最首先出現的索引位置)
* @return 存在？最低索引值：-1
*/
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;
}
/**
* 逆序查找，返回元素的最低索引值(最首先出現的索引位置)
* @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;
}
/**
* 返回 ArrayList 的 Object 數組
* - 包含 ArrayList 的所有儲存元素
* - 對返回的該數組進行操作，不會影響該 ArrayList（相當於分配了一個新的數組）==>該操作是安全的
* - 元素存儲順序與 ArrayList 中的一致
*/
public Object[] toArray() {
return Arrays.copyOf(elementData, size);
}
/**
* 返回 ArrayList 元素組成的數組
* @param a 需要存儲 list 中元素的數組
* 若 a.length >= list.size，則將 list 中的元素按順序存入 a 中，然后 a[list.size] = null, a[list.size + 1] 及其后的元素依舊是 a 的元素
* 否則，將返回包含list 所有元素且數組長度等於 list 中元素個數的數組
* 注意：若 a 中本來存儲有元素，則 a 會被 list 的元素覆蓋，且 a[list.size] = null
* @return
* @throws ArrayStoreException 當 a.getClass() != list 中存儲元素的類型時
* @throws NullPointerException 當 a 為 null 時
*/
@SuppressWarnings("unchecked")
public <T> T[] toArray(T[] a) {
// 若數組a的大小 < ArrayList的元素個數,則新建一個T[]數組，
// 數組大小是"ArrayList的元素個數",並將“ArrayList”全部拷貝到新數組中
if (a.length < size)
// Make a new array of a's runtime type, but my contents:
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;
}
/**
* 獲取指定位置上的元素，從0開始
*/
public E get(int index) {
rangeCheck(index);//檢查是否越界
return elementData(index);
}
/**
* 設置 index 位置元素的值
* @param index 索引值
* @param element 需要存儲在 index 位置的元素值
* @return 替換前在 index 位置的元素值
* @throws IndexOutOfBoundsException {@inheritDoc}
*/
public E set(int index, E element) {
rangeCheck(index);//越界檢查
E oldValue = elementData(index);//獲取舊數值
elementData[index] = element;
return oldValue;
}
/**
*增加指定的元素到ArrayList的最后位置
* @param e 要添加的元素
* @return
*/
public boolean add(E e) {
// 確定ArrayList的容量大小---嚴謹
// 注意：size + 1，保證資源空間不被浪費，
// ☆☆☆按當前情況，保證要存多少個元素，就只分配多少空間資源
ensureCapacityInternal(size + 1); // Increments modCount!!
elementData[size++] = e;
return true;
}
/**
*
*在這個ArrayList中的指定位置插入指定的元素，
* - 在指定位置插入新元素，原先在 index 位置的值往后移動一位
* @param index 指定位置
* @param element 指定元素
* @throws IndexOutOfBoundsException
*/
public void add(int index, E element) {
rangeCheckForAdd(index);//判斷角標是否越界
//看上面的，size+1，保證資源空間不浪費，按當前情況，保證要存多少元素，就只分配多少空間資源
ensureCapacityInternal(size + 1); // Increments modCount!!
//第一個是要復制的數組，第二個是從要復制的數組的第幾個開始，
// 第三個是復制到那，四個是復制到的數組第幾個開始，最后一個是復制長度
System.arraycopy(elementData, index, elementData, index + 1,
size - index);
elementData[index] = element;
size++;
}
/**
* 移除指定位置的元素
* index 之后的所有元素依次左移一位
* @param index 指定位置
* @return 被移除的元素
* @throws IndexOutOfBoundsException
*/
public E remove(int index) {
rangeCheck(index);
modCount++;
E oldValue = elementData(index);
int numMoved = size - index - 1;//要移動的長度
if (numMoved > 0)
System.arraycopy(elementData, index+1, elementData, index,
numMoved);
// 將最后一個元素置空
elementData[--size] = null;
return oldValue;
}
/**
* 移除list中指定的第一個元素(符合條件索引最低的)
* 如果list中不包含這個元素，這個list不會改變
* 如果包含這個元素，index 之后的所有元素依次左移一位
* @param o 這個list中要被移除的元素
* @return
*/
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 個元素
* 和public E remove(int index)相比
* 私有方法，跳過檢查，不返回被刪除的值
* @param index 要刪除的腳標
*/
private void fastRemove(int index) {
modCount++;//這個地方改變了modCount的值了
int numMoved = size - index - 1;//移動的個數
if (numMoved > 0)
System.arraycopy(elementData, index+1, elementData, index,
numMoved);
elementData[--size] = null; //將最后一個元素清除
}
/**
* 移除list中的所有元素，這個list表將在調用之后置空
* - 它會將數組緩沖區所以元素置為 null
* - 清空后，我們直接打印 list，卻只會看見一個 [], 而不是 [null, null, ….] ==> toString() 和 迭代器進行了處理
*/
public void clear() {
modCount++;
// clear to let GC do its work
for (int i = 0; i < size; i++)
elementData[i] = null;
size = 0;
}
/**
* 將一個集合的所有元素順序添加（追加）到 lits 末尾
* - ArrayList 是線程不安全的。
* - 該方法沒有加鎖，當一個線程正在將 c 中的元素加入 list 中，但同時有另一個線程在更改 c 中的元素，可能會有問題
* @param c 要追加的集合
* @return <tt>true</tt> ？ list 元素個數有改變時，成功：失敗
* @throws NullPointerException 當 c 為 null 時
*/
public boolean addAll(Collection<? extends E> c) {
Object[] a = c.toArray();
int numNew = a.length;//要添加元素的個數
ensureCapacityInternal(size + numNew); //擴容
System.arraycopy(a, 0, elementData, size, numNew);
size += numNew;
return numNew != 0;
}
/**
* 從 List 中指定位置開始插入指定集合的所有元素,
* -list中原來位置的元素向后移
* - 並不會覆蓋掉在 index 位置原有的值
* - 類似於 insert 操作，在 index 處插入 c.length 個元素（原來在此處的 n 個元素依次右移）
* @param index 插入指定集合的索引
* @param c 要添加的集合
* @return ？ list 元素個數有改變時，成功：失敗
* @throws IndexOutOfBoundsException {@inheritDoc}
* @throws NullPointerException if the specified collection is null
*/
public boolean addAll(int index, Collection<? extends E> c) {
rangeCheckForAdd(index);
Object[] a = c.toArray();//是將list直接轉為Object[] 數組
int numNew = a.length; //要添加集合的元素數量
ensureCapacityInternal(size + numNew); // 擴容
int numMoved = size - index;//list中要移動的數量
if (numMoved > 0)
System.arraycopy(elementData, index, elementData, index + numNew,
numMoved);
System.arraycopy(a, 0, elementData, index, numNew);
size += numNew;
return numNew != 0;
}
/**
* 移除list中指定集合包含的所有元素
* @param c 要從list中移除的指定集合
* @return {@code true} if this list changed as a result of the call
* @throws ClassCastException 如果list中的一個元素的類和指定集合不兼容
* (<a href="Collection.html#optional-restrictions">optional</a>)
* @throws NullPointerException 如果list中包含一個空元素，而指定集合中不允許有空元素
*/
public boolean removeAll(Collection<?> c) {
Objects.requireNonNull(c);//判斷集合是否為空，如果為空報NullPointerException
//批量移除c集合的元素，第二個參數：是否采補集
return batchRemove(c, false);
}
/**
* 返回從指定索引開始到結束的帶有元素的list迭代器
*/
public ListIterator<E> listIterator(int index) {
if (index < 0 || index > size)
throw new IndexOutOfBoundsException("Index: "+index);
return new ListItr(index);
}
/**
* 返回從0索引開始到結束的帶有元素的list迭代器
*/
public ListIterator<E> listIterator() {
return new ListItr(0);
}
/**
* 以一種合適的排序返回一個iterator到元素的結尾
*/
public Iterator<E> iterator() {
return new Itr();
}
/**
* Itr是AbstractList.Itr的優化版本
* 為什么會報ConcurrentModificationException異常?
* 1. Iterator 是工作在一個獨立的線程中，並且擁有一個 mutex 鎖。
* 2. Iterator 被創建之后會建立一個指向原來對象的單鏈索引表，當原來的對象數量發生變化時，
* 這個索引表的內容不會同步改變，所以當索引指針往后移動的時候就找不到要迭代的對象，
* 3. 所以按照 fail-fast 原則 Iterator 會馬上拋出 java.util.ConcurrentModificationException 異常。
* 4. 所以 Iterator 在工作的時候是不允許被迭代的對象被改變的。
* 但你可以使用 Iterator 本身的方法 remove() 來刪除對象，
* 5. Iterator.remove() 方法會在刪除當前迭代對象的同時維護索引的一致性。
*/
private class Itr implements Iterator<E> {
int cursor; // 下一個元素返回的索引
int lastRet = -1; // 最后一個元素返回的索引 -1 if no such
int expectedModCount = modCount;
/**
* 是否有下一個元素
*/
public boolean hasNext() {
return cursor != size;
}
/**
* 返回list中的值
*/
@SuppressWarnings("unchecked")
public E next() {
checkForComodification();
int i = cursor;//i當前元素的索引
if (i >= size)//第一次檢查：角標是否越界越界
throw new NoSuchElementException();
Object[] elementData = ArrayList.this.elementData;
if (i >= elementData.length)//第二次檢查,list集合中數量是否發生變化
throw new ConcurrentModificationException();
cursor = i + 1; //cursor 下一個元素的索引
return (E) elementData[lastRet = i];//最后一個元素返回的索引
}
/**
* 移除集合中的元素
*/
public void remove() {
if (lastRet < 0)
throw new IllegalStateException();
checkForComodification();
try {
//移除list中的元素
ArrayList.this.remove(lastRet);
//由於cursor比lastRet大1，所有這行代碼是指指針往回移動一位
cursor = lastRet;
//將最后一個元素返回的索引重置為-1
lastRet = -1;
//重新設置了expectedModCount的值，避免了ConcurrentModificationException的產生
expectedModCount = modCount;
} catch (IndexOutOfBoundsException ex) {
throw new ConcurrentModificationException();
}
}
/**
* jdk 1.8中使用的方法
* 將list中的所有元素都給了consumer，可以使用這個方法來取出元素
*/
@Override
@SuppressWarnings("unchecked")
public void forEachRemaining(Consumer<? super E> consumer) {
Objects.requireNonNull(consumer);
final int size = ArrayList.this.size;
int i = cursor;
if (i >= size) {
return;
}
final Object[] elementData = ArrayList.this.elementData;
if (i >= elementData.length) {
throw new ConcurrentModificationException();
}
while (i != size && modCount == expectedModCount) {
consumer.accept((E) elementData[i++]);
}
// update once at end of iteration to reduce heap write traffic
cursor = i;
lastRet = i - 1;
checkForComodification();
}
/**
* 檢查modCount是否等於expectedModCount
* 在 迭代時list集合的元素數量發生變化時會造成這兩個值不相等
*/
final void checkForComodification() {
//當expectedModCount和modCount不相等時，就拋出ConcurrentModificationException
if (modCount != expectedModCount)
throw new ConcurrentModificationException();
}
}
/**
* AbstractList.ListItr 的優化版本
* ListIterator 與普通的 Iterator 的區別：
* - 它可以進行雙向移動，而普通的迭代器只能單向移動
* - 它可以添加元素(有 add() 方法)，而后者不行
*/
private class ListItr extends Itr implements ListIterator<E> {
ListItr(int index) {
super();
cursor = index;
}
/**
* 是否有前一個元素
*/
public boolean hasPrevious() {
return cursor != 0;
}
/**
* 獲取下一個元素的索引
*/
public int nextIndex() {
return cursor;
}
/**
* 獲取 cursor 前一個元素的索引
* - 是 cursor 前一個，而不是當前元素前一個的索引。
* - 若調用 next() 后馬上調用該方法，則返回的是當前元素的索引。
* - 若調用 next() 后想獲取當前元素前一個元素的索引，需要連續調用兩次該方法。
*/
public int previousIndex() {
return cursor - 1;
}
/**
* 返回 cursor 前一元素
*/
@SuppressWarnings("unchecked")
public E previous() {
checkForComodification();
int i = cursor - 1;
if (i < 0)//第一次檢查：索引是否越界
throw new NoSuchElementException();
Object[] elementData = ArrayList.this.elementData;
if (i >= elementData.length)//第二次檢查
throw new ConcurrentModificationException();
cursor = i;//cursor回移
return (E) elementData[lastRet = i];//返回 cursor 前一元素
}
/**
* 將數組的最后一個元素,設置成元素e
*/
public void set(E e) {
if (lastRet < 0)
throw new IllegalStateException();
checkForComodification();
try {
//將數組最后一個元素，設置成元素e
ArrayList.this.set(lastRet, e);
} catch (IndexOutOfBoundsException ex) {
throw new ConcurrentModificationException();
}
}
/**
* 添加元素
*/
public void add(E e) {
checkForComodification();
try {
int i = cursor;//當前元素的索引后移一位
ArrayList.this.add(i, e);//在i位置上添加元素e
cursor = i + 1;//cursor后移一位
lastRet = -1;
expectedModCount = modCount;
} catch (IndexOutOfBoundsException ex) {
throw new ConcurrentModificationException();
}
}
}