原創文章,轉載請標註出處:《Java基礎系列-ArrayList》java
ArrayList底層使用的是數組。是List的可變數組實現,這裏的可變是針對List而言,而不是底層數組。git
數組有自身的特色,不變性,一旦數組被初始化,那麼其長度就固定了,不可被改變。這就致使了ArrayList中的一個重要特性:擴容。github
public class ArrayList<E> extends AbstractList<E> implements List<E>, RandomAccess, Cloneable, java.io.Serializable {/*...*/}
能夠看到ArrayList類實現了四個接口:編程
還繼承自AbstractList
public class ArrayList<E> extends AbstractList<E> implements List<E>, RandomAccess, Cloneable, java.io.Serializable { // 默認的初始容量 private static final int DEFAULT_CAPACITY = 10; // 共享使用的空實例,這個空實例是沒有容量的空實例 private static final Object[] EMPTY_ELEMENTDATA = {}; // 共享使用的空實例,這個空實例可被擴容到初始容量(10) private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {}; // ArrayList中保存元素的緩衝數組,DEFAULTCAPACITY_EMPTY_ELEMENTDATA標識的空數組在第一個添加元素時會被擴容到10個大小。 transient Object[] elementData; // non-private to simplify nested class access // ArrayList集合中包含的元素數量 private int size; // 集合的容量最大值爲Integer的最大值-8,這裏爲何減去8呢?主要是由於一些虛擬機會在數組中保存一些頭信息,這些信息是區別於使用者添加的元素以外的存在,若是最大爲Integer的最大,當頭信息添加以後,再添加元素就有可能會形成內存溢出。 private static final int MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8; }
字段中有幾個須要注意的點:安全
elementData字段是保存元素的緩衝數組,被transient修飾表示它不會被序列化,這意味着集合對象保存的元素不會被自動序列化,因此後面添加了writeObject和readObject方法,用來序列化和反序列化數組中的元素。app
public class ArrayList<E> extends AbstractList<E> implements List<E>, RandomAccess, Cloneable, java.io.Serializable { // 構建一個初始容量是10的ArrayList public ArrayList() { this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA; } // 根據給定的初始容量initialCapacity構建一個ArrayList // 若是initialCapacity>0則直接直接建立容量爲initialCapacity的ArrayList // 若是initialCapacity=0則直接使用EMPTY_ELEMENTDATA空集合 // 若是initialCapacity<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 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; } } }
咱們最常使用的實際上是第一種,可是在咱們實際編程時,若是能夠預估到集合的最大容量,那麼可使用第二種方式,這樣能夠減小擴容的時間和內存消耗,一次性到位。dom
public class ArrayList<E> extends AbstractList<E> implements List<E>, RandomAccess, Cloneable, java.io.Serializable { public boolean add(E e) { ensureCapacityInternal(size + 1); // Increments modCount!! elementData[size++] = e; return true; } }
ensureCapacityInternal方法主要用於校驗當前List的容量是否已經達到極限,若是達到極限須要進行擴容。具體參照2.11中擴容解析。函數
剩下的就是添加新元素的邏輯,簡單至極,直接將新元素到添加到底層數組elementData的下一下標位size++便可。ui
public class ArrayList<E> extends AbstractList<E> implements List<E>, RandomAccess, Cloneable, java.io.Serializable { 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++; } }
首先校驗給定的添加位置index,index必須小於size的值,並大於等於0。
而後一樣校驗容量是否達到極限,達到極限須要擴容。
以後執行一個本地方法,System.arraycopy方法用於將指定位置及其後面的全部元素整個經過複製遷移到從index+1開始的位置,即總體後移一位,將index位空出來用於保存新元素。
最後將新元素添加到空出的index位置。
public class ArrayList<E> extends AbstractList<E> implements List<E>, RandomAccess, Cloneable, java.io.Serializable { public boolean addAll(Collection<? extends E> c) { Object[] a = c.toArray(); int numNew = a.length; ensureCapacityInternal(size + numNew); // Increments modCount System.arraycopy(a, 0, elementData, size, numNew); size += numNew; return numNew != 0; } }
首先將給定的集合轉換爲數組Object[]。
而後以目標List的size+給定集合轉化的數組的容量爲總容量進行容量校驗,若容量不足,執行擴容操做。
再而後經過本地方法執行數組複製操做將給定集合轉換數組的元素複製到目標List的底層數組的尾部。
最後不要忘記將size增長。
public class ArrayList<E> extends AbstractList<E> implements List<E>, RandomAccess, Cloneable, java.io.Serializable { public boolean addAll(int index, Collection<? extends E> c) { rangeCheckForAdd(index); Object[] a = c.toArray(); int numNew = a.length; ensureCapacityInternal(size + numNew); // Increments modCount int numMoved = size - index; if (numMoved > 0) System.arraycopy(elementData, index, elementData, index + numNew, numMoved); System.arraycopy(a, 0, elementData, index, numNew); size += numNew; return numNew != 0; } }
首先校驗下標index,index必須小於size,大於等於0。
而後將給定集合轉換爲數組Object[],再執行容量校驗,擴容操做。
經過本地方法數組複製操做將給定位置開始的全部元素總體後移必定的距離,具體的距離爲給定集合轉換後數組的容量大小,這樣就能空出容量大小的空位來存放給定的集合元素。
最後再次經過本地數組複製方法將給定的集合轉換的數組元素總體複製到上一步空出來的位置上。
public class ArrayList<E> extends AbstractList<E> implements List<E>, RandomAccess, Cloneable, java.io.Serializable { public E set(int index, E element) { rangeCheck(index); E oldValue = elementData(index); elementData[index] = element; return oldValue; } }
修改指定位置的元素爲新元素,首先須要校驗給定index的值,index必須大於等於0,小於size,而後將新元素保存到index位置,並將舊元素返回。
public class ArrayList<E> extends AbstractList<E> implements List<E>, RandomAccess, Cloneable, java.io.Serializable { public E get(int index) { rangeCheck(index); return elementData(index); } }
獲取指定下標位置的元素值,首先須要校驗給定的下標index,index必須大於等於0,小於size。
public class ArrayList<E> extends AbstractList<E> implements List<E>, RandomAccess, Cloneable, java.io.Serializable { 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 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; } }
indexOf是經過正序遍歷的方式搜索給定的元素的下標,lastIndexOf是經過逆序遍歷的方式搜索給定元素的下標,這兩個方法找到的下標都是正序或者逆序該元素首次出現的位置下標。若是o爲null,那麼將會搜索第一個null值元素的下標。
public class ArrayList<E> extends AbstractList<E> implements List<E>, RandomAccess, Cloneable, java.io.Serializable { 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; } }
首先校驗給定的下標值index,index必須小於size,這裏的校驗和添加元素的下標校驗有點不一樣:
public class ArrayList<E> extends AbstractList<E> implements List<E>, RandomAccess, Cloneable, java.io.Serializable { private void rangeCheck(int index) { if (index >= size) throw new IndexOutOfBoundsException(outOfBoundsMsg(index)); } private void rangeCheckForAdd(int index) { if (index > size || index < 0) throw new IndexOutOfBoundsException(outOfBoundsMsg(index)); } }
前者是此處的index校驗,後者是添加元素的index校驗。
那爲什麼後者比前者要多一個index<0的校驗呢,那是由於在add(int,E)方法中,校驗完成後緊接着就是調用本地方法進行數組複製操做,若是index小於0,那麼出錯位置在C代碼中,沒法在Java代碼中得以體現,因此提早進行校驗,保證調用本地C代碼以前參數的準確性。前者校驗完成以後,緊接着的是Java代碼獲取指定下標的元素,若是下標小於0,也會出錯可是JVM會拋出異常,不會無聲無息,因此沒有必要校驗是否小於0。
index校驗完成後,經過本地方法數組複製將index+1及其以後的元素總體複製到index位置。
最後將原來的最後一個位置元素置空。
public class ArrayList<E> extends AbstractList<E> implements List<E>, RandomAccess, Cloneable, java.io.Serializable { 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; // clear to let GC do its work } }
首先經過循環操做找到首個指定的元素,而後將針對找到的元素執行刪除操做。
刪除操做仍是依靠本地的數組複製操做完成的。
public class ArrayList<E> extends AbstractList<E> implements List<E>, RandomAccess, Cloneable, java.io.Serializable { public void clear() { modCount++; // clear to let GC do its work for (int i = 0; i < size; i++) elementData[i] = null; size = 0; } }
至於清空元素,就是經過循環將List中的每一個元素都刪除,將整個List置空。
public class ArrayList<E> extends AbstractList<E> implements List<E>, RandomAccess, Cloneable, java.io.Serializable { // 刪除當前List中全部包含在給定集合中的元素 public boolean removeAll(Collection<?> c) { Objects.requireNonNull(c); return batchRemove(c, false); } // 刪除當前List中全部不包含在給定集合中的元素 public boolean retainAll(Collection<?> c) { Objects.requireNonNull(c); return batchRemove(c, true); } private boolean batchRemove(Collection<?> c, boolean complement) { final Object[] elementData = this.elementData; int r = 0, w = 0; boolean modified = false; try { 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) { System.arraycopy(elementData, r, elementData, w, size - r); w += size - r; } if (w != size) { // clear to let GC do its work for (int i = w; i < size; i++) elementData[i] = null; modCount += size - w; size = w; modified = true; } } return modified; } }
ArrayList的遍歷方式有不少:
ListIterator是繼承自Iterator的,在其基礎上添加了反向遍歷的功能方法。
public class ArrayList<E> extends AbstractList<E> implements List<E>, RandomAccess, Cloneable, java.io.Serializable { // 截取從執行下標開始的元素組成迭代器實例,進行遍歷 public ListIterator<E> listIterator(int index) { if (index < 0 || index > size) throw new IndexOutOfBoundsException("Index: "+index); return new ListItr(index); } // 將集合中全部元素組成迭代器實例,進行遍歷 public ListIterator<E> listIterator() { return new ListItr(0); } }
源碼中的ListItr是ListIterator的實現類。
Iterator擁有正向遍歷的功能。
public class ArrayList<E> extends AbstractList<E> implements List<E>, RandomAccess, Cloneable, java.io.Serializable { public Iterator<E> iterator() { return new Itr(); } }
源碼中的Itr就是Iterator的實現類。
Spliiterator是分割迭代器,詳情參見Java集合系列-Spliterator
public class ArrayList<E> extends AbstractList<E> implements List<E>, RandomAccess, Cloneable, java.io.Serializable { public Spliterator<E> spliterator() { return new ArrayListSpliterator<>(this, 0, -1, 0); } }
forEach方式是java 1.8中新增的方式,接受一個行爲做爲參數,即接收一個方法引用或者Lambda表達式。
public class ArrayList<E> extends AbstractList<E> implements List<E>, RandomAccess, Cloneable, java.io.Serializable { // action表明接受的行爲,是一個函數式接口類型Consumer,表示消費之意,消費就是將資源處理掉,因此有一個入參,無返回值。 public void forEach(Consumer<? super E> action) { Objects.requireNonNull(action); final int expectedModCount = modCount; @SuppressWarnings("unchecked") final E[] elementData = (E[]) this.elementData; final int size = this.size; for (int i=0; modCount == expectedModCount && i < size; i++) { action.accept(elementData[i]);// 執行函數式接口行爲 } if (modCount != expectedModCount) { throw new ConcurrentModificationException(); } } }
實例:
public class ArrayListTest { public static void main(String[] args) { List<String> list = new ArrayList<>(); list.addAll(Arrays.asList("123","444444","2123")); ListIterator<String> listIterator = list.listIterator();// 第一種 listIterator.forEachRemaining(System.out::println); System.out.println("-------------"); ListIterator<String> listIterator1 = list.listIterator(1);// 第二種 listIterator1.forEachRemaining(System.out::println); System.out.println("-------------"); Iterator<String> iterator = list.iterator();// 第三種 iterator.forEachRemaining(System.out::println); System.out.println("-------------"); Spliterator<String> spliterator = list.spliterator();// 第四種 spliterator.forEachRemaining(System.out::println); System.out.println("-------------"); list.forEach(System.out::println);// 第五種 } }
public class ArrayList<E> extends AbstractList<E> implements List<E>, RandomAccess, Cloneable, java.io.Serializable { public boolean isEmpty() { return size == 0; } }
size表示的就是List中包含的元素的個數。
public class ArrayList<E> extends AbstractList<E> implements List<E>, RandomAccess, Cloneable, java.io.Serializable { public boolean contains(Object o) { return indexOf(o) >= 0; } }
該校驗經過indexOf()方法來實現,若是能找到元素的下標,則存在,不然不存在。
在add和addAll方法中屢次出現的ensureCapacityInternal方法就是通向擴容邏輯的通道。
public class ArrayList<E> extends AbstractList<E> implements List<E>, RandomAccess, Cloneable, java.io.Serializable { // 確保底層數組的容量足夠保存當前的元素或元素集,若是容量不足即進行擴容。 private void ensureCapacityInternal(int minCapacity) { ensureExplicitCapacity(calculateCapacity(elementData, minCapacity)); } // 處理首次添加元素時的容量擴容操做,被指定爲DEFAULTCAPACITY_EMPTY_ELEMENTDATA的空數組在首次添加元素時須要自動擴容到默認容量10 private static int calculateCapacity(Object[] elementData, int minCapacity) { if (elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA) { return Math.max(DEFAULT_CAPACITY, minCapacity); } return minCapacity; } // 校驗是否須要擴容,只有當給定容量值比當前數組的長度要大時,才須要擴容, // 由於通常狀況下給定容量即爲新添加元素後的容量,當前容量達不到這個值是沒有位置保存當前元素的,因此才須要擴容。 private void ensureExplicitCapacity(int minCapacity) { modCount++; // overflow-conscious code if (minCapacity - elementData.length > 0) grow(minCapacity); } }
ensureCapacityInternal方法的目的是確保給定的參數指定的容量值。
真正的擴容邏輯位於grow方法中:
public class ArrayList<E> extends AbstractList<E> implements List<E>, RandomAccess, Cloneable, java.io.Serializable { 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); // minCapacity is usually close to size, so this is a win: elementData = Arrays.copyOf(elementData, newCapacity); } // 處理超限問題 // 若是給定的minCapacity爲負數(首位爲1)則拋出異常錯誤OutOfMemoryError // 若是給定容量大於數組最大容量,則取整數的最大值爲容量,不然使用數組的最大容量做爲擴容容量 private static int hugeCapacity(int minCapacity) { if (minCapacity < 0) // overflow throw new OutOfMemoryError(); return (minCapacity > MAX_ARRAY_SIZE) ? Integer.MAX_VALUE : MAX_ARRAY_SIZE; } }
首先要根據規則計算一個新容量newCapacity,而後將這個新容量值與給定須要的容量值minCapacity進行比較,若是新容量值大於給定容量值,則用新容量值進行擴容,不然使用給定容量值進行擴容。而後進行超限校驗和處理。
最後使用肯定好的容量newCapacity來做爲新的底層數組容量來進行擴容操做:建立一個新的數組,並遷移元素。
Java中排序能夠經過兩種方式實現:
具體參見Java基礎系列-Comparable和Comparator
這裏很明顯ArrayList的繼承體系中並沒有Comparable接口,那麼只能經過Comparator來實現,這就涉及到了ArrayList中的sort方法:
public class ArrayList<E> extends AbstractList<E> implements List<E>, RandomAccess, Cloneable, java.io.Serializable { public void sort(Comparator<? super E> c) { final int expectedModCount = modCount; Arrays.sort((E[]) elementData, 0, size, c); if (modCount != expectedModCount) { throw new ConcurrentModificationException(); } modCount++; } }
使用這種方式來排序須要傳遞一個Comparator比較器做爲參數,最簡單的方式就是匿名內部類方式,在Java 1.8以後直接使用Lambda來實現。
public class ComparatorTest { public static void main(String[] args) { List<String> list = new ArrayList<>(); list.addAll(Arrays.asList("123","45612","7839")); list.sort((o1, o2) -> o1.length()-o2.length()); list.forEach(System.out::println); } }
執行結果爲:
123 7839 45612
由於ArrayList實現了Cloneable接口,重寫了clone方法,便擁有了對象克隆的功能。
public class ArrayList<E> extends AbstractList<E> implements List<E>, RandomAccess, Cloneable, java.io.Serializable { public Object clone() { try { ArrayList<?> v = (ArrayList<?>) 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(e); } } }
這是一個淺拷貝的實現。
因爲ArrayList中使用transient修飾了elementData,它表明的是底層的元素數組,序列化的主要內容就是它,或者說是它裏面的內容,而它又沒法被序列化,所以咱們只能經過自定義writeObject方法來手動序列化,定義readObject方法來手動反序列化。
public class ArrayList<E> extends AbstractList<E> implements List<E>, RandomAccess, Cloneable, java.io.Serializable { private void writeObject(java.io.ObjectOutputStream s) throws java.io.IOException{ // Write out element count, and any hidden stuff int expectedModCount = modCount; s.defaultWriteObject(); // Write out size as capacity for behavioural compatibility with clone() s.writeInt(size); // Write out all elements in the proper order. 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; // Read in size, and any hidden stuff s.defaultReadObject(); // Read in capacity s.readInt(); // ignored if (size > 0) { // be like clone(), allocate array based upon size not capacity int capacity = calculateCapacity(elementData, size); SharedSecrets.getJavaOISAccess().checkArray(s, Object[].class, capacity); ensureCapacityInternal(size); Object[] a = elementData; // Read in all elements in the proper order. for (int i=0; i<size; i++) { a[i] = s.readObject(); } } } }
至此,ArrayList的大部份內容都介紹完畢了。
最後作一下總結,知識點概括: