JDK1.8源碼(五)——java.util.ArrayList 類

時間 2020-07-06

標籤 jdk1.8 jdk 源碼 java.util.arraylist java util arraylist 欄目 Java 简体版

原文原文鏈接

　　搞Java的，對於集合框架應該再熟悉不過了，前面幾篇文章咱們介紹了java.lang包下的幾種基本數據類型，接下來咱們將介紹java.util包下的幾個集合類，首先介紹的是 ArrayList 類。html

一、ArrayList 定義

　　ArrayList 是一個用數組實現的集合，支持隨機訪問，元素有序且能夠重複。java

public class ArrayList<E> extends AbstractList<E>
        implements List<E>, RandomAccess, Cloneable, java.io.Serializable

　　①、實現 RandomAccess 接口算法

　　這是一個標記接口，通常此標記接口用於 List 實現，以代表它們支持快速（一般是恆定時間）的隨機訪問。該接口的主要目的是容許通用算法改變其行爲，以便在應用於隨機或順序訪問列表時提供良好的性能。api

　　好比在工具類 Collections(這個工具類後面會詳細講解)中，應用二分查找方法時判斷是否實現了 RandomAccess 接口：數組

int binarySearch(List<? extends Comparable<? super T>> list, T key) {
        if (list instanceof RandomAccess || list.size()<BINARYSEARCH_THRESHOLD)
            return Collections.indexedBinarySearch(list, key);
        else
            return Collections.iteratorBinarySearch(list, key);
    }

　　②、實現 Cloneable 接口微信

　　這個類是 java.lang.Cloneable，前面咱們講解深拷貝和淺拷貝的原理時，咱們介紹了淺拷貝能夠經過調用 Object.clone() 方法來實現，可是調用該方法的對象必需要實現 Cloneable 接口，不然會拋出 CloneNoSupportException異常。併發

　　Cloneable 和 RandomAccess 接口同樣也是一個標記接口，接口內無任何方法體和常量的聲明，也就是說若是想克隆對象，必需要實現 Cloneable 接口，代表該類是能夠被克隆的。oracle

　　③、實現 Serializable 接口app

　　這個沒什麼好說的，也是標記接口，表示能被序列化。框架

　　④、實現 List 接口

　　這個接口是 List 類集合的上層接口，定義了實現該接口的類都必需要實現的一組方法，以下所示，下面咱們會對這一系列方法的實現作詳細介紹。

二、字段屬性

//集合的默認大小
        private static final int DEFAULT_CAPACITY = 10;
        //空的數組實例
        private static final Object[] EMPTY_ELEMENTDATA = {};
        //這也是一個空的數組實例，和EMPTY_ELEMENTDATA空數組相比是用於瞭解添加元素時數組膨脹多少
        private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};
        //存儲 ArrayList集合的元素，集合的長度即這個數組的長度
        //一、當 elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA 時將會清空 ArrayList
        //二、當添加第一個元素時，elementData 長度會擴展爲 DEFAULT_CAPACITY=10
        transient Object[] elementData;
        //表示集合的長度
        private int size;

三、構造函數

public ArrayList() {
         this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;
     }

　　此無參構造函數將建立一個 DEFAULTCAPACITY_EMPTY_ELEMENTDATA 聲明的數組，注意此時初始容量是0，而不是你們覺得的 10。

　　注意：根據默認構造函數建立的集合，ArrayList list = new ArrayList();此時集合長度是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 集合。當大於0時，給定多少那就建立多大的數組；當等於0時，建立一個空數組；當小於0時，拋出異常。

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 集合中去。

四、添加元素

　　經過前面的字段屬性和構造函數，咱們知道 ArrayList 集合是由數組構成的，那麼向 ArrayList 中添加元素，也就是向數組賦值。咱們知道一個數組的聲明是能肯定大小的，而使用 ArrayList 時，好像是能添加任意多個元素，這就涉及到數組的擴容。

　　擴容的核心方法就是調用前面咱們講過的Arrays.copyOf 方法，建立一個更大的數組，而後將原數組元素拷貝過去便可。下面咱們看看具體實現：

public boolean add(E e) {
        ensureCapacityInternal(size + 1);  //添加元素以前，首先要肯定集合的大小
        elementData[size++] = e;
        return true;
    }

　　如上所示，在經過調用 add 方法添加元素以前，咱們要首先調用 ensureCapacityInternal 方法來肯定集合的大小，若是集合滿了，則要進行擴容操做。

private void ensureCapacityInternal(int minCapacity) {//這裏的minCapacity 是集合當前大小+1
        //elementData 是實際用來存儲元素的數組，注意數組的大小和集合的大小不是相等的，前面的size是指集合大小
        ensureExplicitCapacity(calculateCapacity(elementData, minCapacity));
    }
    private static int calculateCapacity(Object[] elementData, int minCapacity) {
        if (elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA) {//若是數組爲空，則從size+1的值和默認值10中取最大的
            return Math.max(DEFAULT_CAPACITY, minCapacity);
        }
        return minCapacity;//不爲空，則返回size+1
    }
    private void ensureExplicitCapacity(int minCapacity) {
        modCount++;

        // overflow-conscious code
        if (minCapacity - elementData.length > 0)
            grow(minCapacity);
    }

　　在 ensureExplicitCapacity 方法中，首先對修改次數modCount加一，這裏的modCount給ArrayList的迭代器使用的，在併發操做被修改時，提供快速失敗行爲（保證modCount在迭代期間不變，不然拋出ConcurrentModificationException異常，能夠查看源碼865行），接着判斷minCapacity是否大於當前ArrayList內部數組長度，大於的話調用grow方法對內部數組elementData擴容，grow方法代碼以下：

private void grow(int minCapacity) {
        int oldCapacity = elementData.length;//獲得原始數組的長度
        int newCapacity = oldCapacity + (oldCapacity >> 1);//新數組的長度等於原數組長度的1.5倍
        if (newCapacity - minCapacity < 0)//當新數組長度仍然比minCapacity小，則爲保證最小長度，新數組等於minCapacity
            newCapacity = minCapacity;
        //MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8 = 2147483639
        if (newCapacity - MAX_ARRAY_SIZE > 0)//當獲得的新數組長度比 MAX_ARRAY_SIZE 大時，調用 hugeCapacity 處理大數組
            newCapacity = hugeCapacity(minCapacity);
        //調用 Arrays.copyOf 將原數組拷貝到一個大小爲newCapacity的新數組（注意是拷貝引用）
        elementData = Arrays.copyOf(elementData, newCapacity);
    }
    
    private static int hugeCapacity(int minCapacity) {
        if (minCapacity < 0) // 
            throw new OutOfMemoryError();
        return (minCapacity > MAX_ARRAY_SIZE) ? //minCapacity > MAX_ARRAY_SIZE,則新數組大小爲Integer.MAX_VALUE
            Integer.MAX_VALUE :
            MAX_ARRAY_SIZE;
    }

　　對於 ArrayList 集合添加元素，咱們總結一下：

　　①、當經過 ArrayList() 構造一個空集合，初始長度是爲0的，第 1 次添加元素，會建立一個長度爲10的數組，並將該元素賦值到數組的第一個位置。

　　②、第 2 次添加元素，集合不爲空，並且因爲集合的長度size+1是小於數組的長度10，因此直接添加元素到數組的第二個位置，不用擴容。

　　③、第 11 次添加元素，此時 size+1 = 11，而數組長度是10，這時候建立一個長度爲10+10*0.5 = 15 的數組（擴容1.5倍），而後將原數組元素引用拷貝到新數組。並將第 11 次添加的元素賦值到新數組下標爲10的位置。

　　④、第 Integer.MAX_VALUE - 8 = 2147483639，而後 2147483639%1.5=1431655759（這個數是要進行擴容）次添加元素，爲了防止溢出，此時會直接建立一個 1431655759+1 大小的數組，這樣一直，每次添加一個元素，都只擴大一個範圍。

　　⑤、第 Integer.MAX_VALUE - 7 次添加元素時，建立一個大小爲 Integer.MAX_VALUE 的數組，在進行元素添加。

　　⑥、第 Integer.MAX_VALUE + 1 次添加元素時，拋出 OutOfMemoryError 異常。

　　注意：能向集合中添加 null 的，由於數組能夠有 null 值存在。

Object[] obj = {null,1};

ArrayList list = new ArrayList();
list.add(null);
list.add(1);
System.out.println(list.size());//2

五、刪除元素

　　①、根據索引刪除元素

public E remove(int index) {
        rangeCheck(index);//判斷給定索引的範圍，超過集合大小則拋出異常

        modCount++;
        E oldValue = elementData(index);//獲得索引處的刪除元素

        int numMoved = size - index - 1;
        if (numMoved > 0)//size-index-1 > 0 表示 0<= index < (size-1),即索引不是最後一個元素
            //經過 System.arraycopy()將數組elementData 的下標index+1以後長度爲 numMoved的元素拷貝到從index開始的位置
            System.arraycopy(elementData, index+1, elementData, index,
                             numMoved);
        elementData[--size] = null; //將數組最後一個元素置爲 null，便於垃圾回收

        return oldValue;
    }

　　remove(int index) 方法表示刪除索引index處的元素，首先經過 rangeCheck(index) 方法判斷給定索引的範圍，超過集合大小則拋出異常；接着經過 System.arraycopy 方法對數組進行自身拷貝。關於這個方法的用法能夠參考這篇博客。

　　②、直接刪除指定元素

public boolean remove(Object o) {
        if (o == null) {//若是刪除的元素爲null
            for (int index = 0; index < size; index++)
                if (elementData[index] == null) {
                    fastRemove(index);
                    return true;
                }
        } else {//不爲null，經過equals方法判斷對象是否相等
            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; // 
    }

　　remove(Object o)方法是刪除第一次出現的該元素。而後經過System.arraycopy進行數組自身拷貝。

六、修改元素

　　經過調用 set(int index, E element) 方法在指定索引 index 處的元素替換爲 element。並返回原數組的元素。

public E set(int index, E element) {
        rangeCheck(index);//判斷索引合法性

        E oldValue = elementData(index);//得到原數組指定索引的元素
        elementData[index] = element;//將指定所引處的元素替換爲 element
        return oldValue;//返回原數組索引元素
    }

　　經過調用 rangeCheck(index) 來檢查索引合法性。

private void rangeCheck(int index) {
        if (index >= size)
            throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
    }

　　當索引爲負數時，會拋出 java.lang.ArrayIndexOutOfBoundsException 異常。當索引大於集合長度時，會拋出 IndexOutOfBoundsException 異常。

七、查找元素

　　①、根據索引查找元素

public E get(int index) {
        rangeCheck(index);

        return elementData(index);
    }

　　同理，首先仍是判斷給定索引的合理性，而後直接返回處於該下標位置的數組元素。

　　②、根據元素查找索引

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;
    }

　　注意：indexOf(Object o) 方法是返回第一次出現該元素的下標，若是沒有則返回 -1。

　　還有 lastIndexOf(Object o) 方法是返回最後一次出現該元素的下標。

八、遍歷集合

　　①、普通 for 循環遍歷
　　前面咱們介紹查找元素時，知道能夠經過get(int index)方法，根據索引查找元素，那麼遍歷同理：

ArrayList list = new ArrayList();
list.add("a");
list.add("b");
list.add("c");
for(int i = 0 ; i < list.size() ; i++){
    System.out.print(list.get(i)+" ");
}

　　②、迭代器 iterator
　　先看看具體用法：

ArrayList<String> list = new ArrayList<>();
list.add("a");
list.add("b");
list.add("c");
Iterator<String> it = list.iterator();
while(it.hasNext()){
    String str = it.next();
    System.out.print(str+" ");
}

　　在介紹 ArrayList 時，咱們知道該類實現了 List 接口，而 List 接口又繼承了 Collection 接口，Collection 接口又繼承了 Iterable 接口，該接口有個 Iterator<T> iterator() 方法，能獲取 Iterator 對象，能用該對象進行集合遍歷，爲何能用該對象進行集合遍歷？咱們再看看 ArrayList 類中的該方法實現：

public Iterator<E> iterator() {
         return new Itr();
     }

　　該方法是返回一個 Itr 對象，這個類是 ArrayList 的內部類。

private class Itr implements Iterator<E> {
        int cursor;       //遊標， 下一個要返回的元素的索引
        int lastRet = -1; // 返回最後一個元素的索引; 若是沒有這樣的話返回-1.
        int expectedModCount = modCount;

        //經過 cursor ！= size 判斷是否還有下一個元素
        public boolean hasNext() {
            return cursor != size;
        }

        @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];//返回索引爲i處的元素，並將 lastRet賦值爲i
        }

        public void remove() {
            if (lastRet < 0)
                throw new IllegalStateException();
            checkForComodification();

            try {
                ArrayList.this.remove(lastRet);//調用ArrayList的remove方法刪除元素
                cursor = lastRet;//遊標指向刪除元素的位置，原本是lastRet+1的，這裏刪除一個元素，而後遊標就不變了
                lastRet = -1;//lastRet恢復默認值-1
                expectedModCount = modCount;//expectedModCount值和modCount同步，由於進行add和remove操做，modCount會加1
            } catch (IndexOutOfBoundsException ex) {
                throw new ConcurrentModificationException();
            }
        }

        @Override
        @SuppressWarnings("unchecked")
        public void forEachRemaining(Consumer<? super E> consumer) {//便於進行forEach循環
            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();
        }

        //前面在新增元素add() 和 刪除元素 remove() 時，咱們能夠看到 modCount++。修改set() 是沒有的
        //也就是說不能在迭代器進行元素迭代時進行增長和刪除操做，不然拋出異常
        final void checkForComodification() {
            if (modCount != expectedModCount)
                throw new ConcurrentModificationException();
        }
    }

　　注意在進行 next() 方法調用的時候，會進行 checkForComodification() 調用，該方法表示迭代器進行元素迭代時，若是同時進行增長和刪除操做，會拋出 ConcurrentModificationException 異常。好比：

ArrayList<String> list = new ArrayList<>();
list.add("a");
list.add("b");
list.add("c");
Iterator<String> it = list.iterator();
while(it.hasNext()){
    String str = it.next();
    System.out.print(str+" ");
    list.remove(str);//集合遍歷時進行刪除或者新增操做，都會拋出 ConcurrentModificationException 異常
    //list.add(str);
    list.set(0, str);//修改操做不會形成異常
}

　　解決辦法是不調用 ArrayList.remove() 方法，轉而調用迭代器的 remove() 方法：

Iterator<String> it = list.iterator();
while(it.hasNext()){
    String str = it.next();
    System.out.print(str+" ");
    //list.remove(str);//集合遍歷時進行刪除或者新增操做，都會拋出 ConcurrentModificationException 異常
    it.remove();
}

　　注意：迭代器只能向後遍歷，不能向前遍歷，可以刪除元素，可是不能新增元素。

　　③、迭代器的變種 forEach

ArrayList<String> list = new ArrayList<>();
list.add("a");
list.add("b");
list.add("c");
for(String str : list){
    System.out.print(str + " ");
}

　　這種語法能夠當作是 JDK 的一種語法糖，經過反編譯 class 文件，咱們能夠看到生成的 java 文件，其具體實現仍是經過調用 Iterator 迭代器進行遍歷的。以下：

ArrayList list = new ArrayList();
        list.add("a");
        list.add("b");
        list.add("c");
        String str;
        for (Iterator iterator1 = list.iterator(); iterator1.hasNext(); System.out.print((new StringBuilder(String.valueOf(str))).append(" ").toString()))
            str = (String)iterator1.next();

　　④、迭代器 ListIterator
　　仍是先看看具體用法：

ArrayList<String> list = new ArrayList<>();
list.add("a");
list.add("b");
list.add("c");
ListIterator<String> listIt = list.listIterator();

//向後遍歷
while(listIt.hasNext()){
    System.out.print(listIt.next()+" ");//a b c
}

//向後前遍歷,此時因爲上面進行了向後遍歷，遊標已經指向了最後一個元素，因此此處向前遍歷能有值
while(listIt.hasPrevious()){
    System.out.print(listIt.previous()+" ");//c b a
}

　　還能一邊遍歷，一邊進行新增或者刪除操做：

ArrayList<String> list = new ArrayList<>();
list.add("a");
list.add("b");
list.add("c");
ListIterator<String> listIt = list.listIterator();

//向後遍歷
while(listIt.hasNext()){
    System.out.print(listIt.next()+" ");//a b c
    listIt.add("1");//在每個元素後面增長一個元素 "1"
}

//向後前遍歷,此時因爲上面進行了向後遍歷，遊標已經指向了最後一個元素，因此此處向前遍歷能有值
while(listIt.hasPrevious()){
    System.out.print(listIt.previous()+" ");//1 c 1 b 1 a 
}

　　也就是說相比於 Iterator 迭代器，這裏的 ListIterator 多出了能向前迭代，以及可以新增元素。下面咱們看看具體實現：

　　對於 Iterator 迭代器，咱們查看 JDK 源碼，發現還有 ListIterator 接口繼承了 Iterator:

public interface ListIterator<E> extends Iterator<E>

　　該接口有以下方法：

　　咱們看在 ArrayList 類中，有以下方法能夠得到 ListIterator 接口：

public ListIterator<E> listIterator() {
        return new ListItr(0);
    }

　　這裏的 ListItr 也是一個內部類。

//注意 內部類 ListItr 繼承了另外一個內部類 Itr
    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;
        }

        public int previousIndex() {//返回上一個元素的索引
            return cursor - 1;
        }

        //該方法獲取當前索引的上一個元素
        @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;//遊標指向上一個元素
            return (E) elementData[lastRet = i];//返回上一個元素的值
        }

        
        public void set(E e) {
            if (lastRet < 0)
                throw new IllegalStateException();
            checkForComodification();

            try {
                ArrayList.this.set(lastRet, e);
            } catch (IndexOutOfBoundsException ex) {
                throw new ConcurrentModificationException();
            }
        }

        //相比於迭代器 Iterator ，這裏多了一個新增操做
        public void add(E e) {
            checkForComodification();

            try {
                int i = cursor;
                ArrayList.this.add(i, e);
                cursor = i + 1;
                lastRet = -1;
                expectedModCount = modCount;
            } catch (IndexOutOfBoundsException ex) {
                throw new ConcurrentModificationException();
            }
        }
    }

### 九、SubList
　　在 ArrayList 中有這樣一個方法：

public List<E> subList(int fromIndex, int toIndex) {
         subListRangeCheck(fromIndex, toIndex, size);
         return new SubList(this, 0, fromIndex, toIndex);
     }

　　做用是返回從 fromIndex(包括) 開始的下標，到 toIndex(不包括) 結束的下標之間的元素視圖。以下：

ArrayList<String> list = new ArrayList<>();
list.add("a");
list.add("b");
list.add("c");

List<String> subList = list.subList(0, 1);
for(String str : subList){
    System.out.print(str + " ");//a
}

　　這裏出現了 SubList 類，這也是 ArrayList 中的一個內部類。

　　注意：返回的是原集合的視圖，也就是說，若是對 subList 出來的集合進行修改或新增操做，那麼原始集合也會發生一樣的操做。

ArrayList<String> list = new ArrayList<>();
list.add("a");
list.add("b");
list.add("c");

List<String> subList = list.subList(0, 1);
for(String str : subList){
    System.out.print(str + " ");//a
}
subList.add("d");
System.out.println(subList.size());//2
System.out.println(list.size());//4,原始集合長度也增長了

　　想要獨立出來一個集合，解決辦法以下：

List<String> subList = new ArrayList<>(list.subList(0, 1));

十、size()

public int size() {
        return size;
    }

　　注意：返回集合的長度，而不是數組的長度，這裏的 size 就是定義的全局變量。

十一、isEmpty()

public boolean isEmpty() {
         return size == 0;
     }

　　返回 size == 0 的結果。

十二、trimToSize()

public void trimToSize() {
        modCount++;
        if (size < elementData.length) {
            elementData = Arrays.copyOf(elementData, size);
        }
    }

　　該方法用於回收多餘的內存。也就是說一旦咱們肯定集合不在添加多餘的元素以後，調用 trimToSize() 方法會將實現集合的數組大小恰好調整爲集合元素的大小。

　　注意：該方法會花時間來複制數組元素，因此應該在肯定不會添加元素以後在調用。

參考文檔：
https://docs.oracle.com/javas...