ArrayList原始碼分析（基於JDK8）
阿新 • • 發佈：2019-02-15
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不同，ArrayList中的操作不是執行緒安全的！所以，建議在單執行緒中才使用ArrayList，而在多執行緒中可以選擇Vector或者CopyOnWriteArrayList。
下面讓我們翻開ArrayList的原始碼，看看一些常用的方法屬性，以及一些需要注意的地方。
ArrayList屬性
ArrayList屬性主要就是當前陣列長度size，以及存放陣列的物件elementData陣列，除此之外還有一個經常用到的屬性就是從AbstractList繼承過來的modCount屬性，代表ArrayList集合的修改次數。
public class ArrayList<E> extends AbstractList<E> implements List<E>, RandomAccess, Cloneable, Serializable { // 序列化id private static final long serialVersionUID = 8683452581122892189L; // 預設初始的容量 private static final int DEFAULT_CAPACITY = 10; // 一個空物件 private static final Object[] EMPTY_ELEMENTDATA = new Object[0]; // 一個空物件，如果使用預設建構函式建立，則預設物件內容預設是該值 private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = new Object[0]; // 當前資料物件存放地方，當前物件不參與序列化 transient Object[] elementData; // 當前陣列長度 private int size; // 陣列最大長度 private static final int MAX_ARRAY_SIZE = 2147483639; // 省略方法。。 }
ArrayList建構函式
無參建構函式
如果不傳入引數，則使用預設無參構建方法建立ArrayList物件，如下： public ArrayList() {
this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;
}帶int型別的建構函式
如果傳入引數，則代表指定ArrayList的初始陣列長度，傳入引數如果是大於等於0，則使用使用者的引數初始化，如果使用者傳入的引數小於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); } }
帶Collection物件的建構函式
1）將collection物件轉換成陣列，然後將陣列的地址的賦給elementData。 2）更新size的值，同時判斷size的大小，如果是size等於0，直接將空物件EMPTY_ELEMENTDATA的地址賦給elementData 3）如果size的值大於0，則執行Arrays.copy方法，把collection物件的內容（可以理解為深拷貝）copy到elementData中。 注意：this.elementData = arg0.toArray(); 這裡執行的簡單賦值時淺拷貝，所以要執行Arrays,copy 做深拷貝 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;
}
}add方法
add的方法有兩個，一個是帶一個引數的，一個是帶兩個引數的，下面我們一個個講解。add(E e) 方法
add主要的執行邏輯如下： 1）確保陣列已使用長度（size）加1之後足夠存下 下一個資料 2）修改次數modCount 標識自增1，如果當前陣列已使用長度（size）加1後的大於當前的陣列長度，則呼叫grow方法，增長陣列，grow方法會將當前陣列的長度變為原來容量的1.5倍。 3）確保新增的資料有地方儲存之後，則將新元素新增到位於size的位置上。 4）返回新增成功布爾值。 新增元素方法入口： public boolean add(E e) {
ensureCapacityInternal(size + 1); // Increments modCount!!
elementData[size++] = e;
return true;
}確保新增的元素有地方儲存，當第一次新增元素的時候this.size+1 的值是1，所以第一次新增的時候會將當前elementData陣列的長度變為10：
private void ensureCapacityInternal(int minCapacity) {
if (elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA) {
minCapacity = Math.max(DEFAULT_CAPACITY, minCapacity);
}
ensureExplicitCapacity(minCapacity);
}
將修改次數（modCount）自增1，判斷是否需要擴充陣列長度,判斷條件就是用當前所需的陣列最小長度與陣列的長度對比，如果大於0，則增長陣列長度。
private void ensureExplicitCapacity(int minCapacity) {
modCount++;
// overflow-conscious code
if (minCapacity - elementData.length > 0)
grow(minCapacity);
}如果當前的陣列已使用空間（size）加1之後 大於陣列長度，則增大陣列容量，擴大為原來的1.5倍。
private void grow(int arg0) {
int arg1 = this.elementData.length;
int arg2 = arg1 + (arg1 >> 1);
if (arg2 - arg0 < 0) {
arg2 = arg0;
}
if (arg2 - 2147483639 > 0) {
arg2 = hugeCapacity(arg0);
}
this.elementData = Arrays.copyOf(this.elementData, arg2);
}add(int index, E element)方法
這個方法其實和上面的add類似，該方法可以按照元素的位置，指定位置插入元素，具體的執行邏輯如下： 1）確保數插入的位置小於等於當前陣列長度，並且不小於0，否則丟擲異常 2）確保陣列已使用長度（size）加1之後足夠存下 下一個資料 3）修改次數（modCount）標識自增1，如果當前陣列已使用長度（size）加1後的大於當前的陣列長度，則呼叫grow方法，增長陣列 4）grow方法會將當前陣列的長度變為原來容量的1.5倍。 5）確保有足夠的容量之後，使用System.arraycopy 將需要插入的位置（index）後面的元素統統往後移動一位。 6）將新的資料內容存放到陣列的指定位置（index）上
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++;
}注意：使用該方法的話將導致指定位置後面的陣列元素全部重新移動，即往後移動一位。
get方法
返回指定位置上的元素， public E get(int index) {
rangeCheck(index);
checkForComodification();
return ArrayList.this.elementData(offset + index);
}set方法
確保set的位置小於當前陣列的長度（size）並且大於0，獲取指定位置（index）元素，然後放到oldValue存放，將需要設定的元素放到指定的位置（index）上，然後將原來位置上的元素oldValue返回給使用者。
public E set(int index, E element) {
rangeCheck(index);
E oldValue = elementData(index);
elementData[index] = element;
return oldValue;
}contains方法
呼叫indexOf方法，遍歷陣列中的每一個元素作對比，如果找到對於的元素，則返回true，沒有找到則返回false。 public boolean contains(Object o) {
return indexOf(o) >= 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;
}remove方法
根據索引remove
1）判斷索引有沒有越界
2）自增修改次數
3）將指定位置（index）上的元素儲存到oldValue
4）將指定位置（index）上的元素都往前移動一位
5）將最後面的一個元素置空，好讓垃圾回收器回收
6）將原來的值oldValue返回
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; // clear to let GC do its work
return oldValue;
}注意：呼叫這個方法不會縮減陣列的長度，只是將最後一個數組元素置空而已。
根據物件remove
迴圈遍歷所有物件，得到物件所在索引位置，然後呼叫fastRemove方法，執行remove操作
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;
}定位到需要remove的元素索引，先將index後面的元素往前面移動一位（呼叫System.arraycooy實現），然後將最後一個元素置空。
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
}clear方法
新增操作次數（modCount），將陣列內的元素都置空，等待垃圾收集器收集，不減小陣列容量。 public void clear() {
modCount++;
// clear to let GC do its work
for (int i = 0; i < size; i++)
elementData[i] = null;
size = 0;
}sublist方法
我們看到程式碼中是建立了一個ArrayList 類裡面的一個內部類SubList物件，傳入的值中第一個引數時this引數，其實可以理解為返回當前list的部分檢視，真實指向的存放資料內容的地方還是同一個地方，如果修改了sublist返回的內容的話，那麼原來的list也會變動。
public List<E> subList(int arg0, int arg1) {
subListRangeCheck(arg0, arg1, this.size);
return new ArrayList.SubList(this, 0, arg0, arg1);
}trimToSize方法
1）修改次數加1 2）將elementData中空餘的空間（包括null值）去除，例如：陣列長度為10，其中只有前三個元素有值，其他為空，那麼呼叫該方法之後，陣列的長度變為3. public void trimToSize() {
modCount++;
if (size < elementData.length) {
elementData = (size == 0)
? EMPTY_ELEMENTDATA
: Arrays.copyOf(elementData, size);
}
}iterator方法
interator方法返回的是一個內部類，由於內部類的建立預設含有外部的this指標，所以這個內部類可以呼叫到外部類的屬性。 public Iterator<E> iterator() {
return new Itr();
} @SuppressWarnings("unchecked")
public E next() {
checkForComodification();
int i = cursor;
if (i >= size)
throw new NoSuchElementException();
Object[] elementData = ArrayList.this.elementData;
if (i >= elementData.length)
throw new ConcurrentModificationException();
cursor = i + 1;
return (E) elementData[lastRet = i];
}expectedModCount這個值是在使用者呼叫ArrayList的iterator方法時候確定的，但是在這之後使用者add，或者remove了ArrayList的元素，那麼modCount就會改變，那麼這個值就會不相等，將會引發ConcurrentModificationException異常，這個是在多執行緒使用情況下，比較常見的一個異常。
final void checkForComodification() {
if (modCount != expectedModCount)
throw new ConcurrentModificationException();
}System.arraycopy 方法
| 引數 | 說明 |
| src | 原陣列 |
| srcPos | 原陣列 |
| dest | 目標陣列 |
| destPos | 目標陣列的起始位置 |
| length | 要複製的陣列元素的數目 |
Arrays.copyOf方法
original - 要複製的陣列newLength - 要返回的副本的長度
newType - 要返回的副本的型別
其實Arrays.copyOf底層也是呼叫System.arraycopy實現的原始碼如下：
//基本資料型別（其他類似byte，short···）
public static int[] copyOf(int[] original, int newLength) {
int[] copy = new int[newLength];
System.arraycopy(original, 0, copy, 0,
Math.min(original.length, newLength));
return copy;
}小結
ArrayList總體來說比較簡單，不過ArrayList還有以下一些特點：
- ArrayList自己實現了序列化和反序列化的方法，因為它自己實現了 private void writeObject(java.io.ObjectOutputStream s)和 private void readObject(java.io.ObjectInputStream s) 方法
- ArrayList基於陣列方式實現，無容量的限制（會擴容）
- 新增元素時可能要擴容（所以最好預判一下），刪除元素時不會減少容量（若希望減少容量，trimToSize()），刪除元素時，將刪除掉的位置元素置為null，下次gc就會回收這些元素所佔的記憶體空間。
- 執行緒不安全
- add(int index, E element)：新增元素到陣列中指定位置的時候，需要將該位置及其後邊所有的元素都整塊向後複製一位
- get(int index)：獲取指定位置上的元素時，可以通過索引直接獲取（O(1)）
- remove(Object o)需要遍歷陣列
- remove(int index)不需要遍歷陣列，只需判斷index是否符合條件即可，效率比remove(Object o)高
- contains(E)需要遍歷陣列
- 使用iterator遍歷可能會引發多執行緒異常