ArrayList源碼解讀(一)

時間 2019-12-06

原文原文鏈接

ArrayList源碼解讀

屬性

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;//實際存儲的數據量
    
    protected transient int modCount = 0;//集合被操做次數，次數對不上拋出ConcurrentModificationException();

構造方法

設置初始空間大小的構造方法java

public ArrayList(int initialCapacity) {
        if (initialCapacity > 0) {//大於0就構造對應長度的Object數組
            this.elementData = new Object[initialCapacity];
        } else if (initialCapacity == 0) {//等於0就直接賦值空的數組對象
            this.elementData = EMPTY_ELEMENTDATA;
        } else {//小於0就拋出異常
            throw new IllegalArgumentException("Illegal Capacity: "+
                                               initialCapacity);
        }
    }

無參構造方法數組

public ArrayList() {
        this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;//直接賦值空的數組對象
    }

集合子類參數的構造方法安全

public ArrayList(Collection<? extends E> c) {
        elementData = c.toArray();//參數c爲實現了Collection的類，toArray爲Collection接口定義方法
        if ((size = elementData.length) != 0) {
            if (elementData.getClass() != Object[].class)//Arrays.copyOf返回類型依賴於第一個參數的類型，此處防止Arrays.copyOf不返回 Object[]類型數據，bug見https://bugs.openjdk.java.net/browse/JDK-6260652
                elementData = Arrays.copyOf(elementData, size, Object[].class);//注意此處，僅拷貝實際數據長度
        } else {
            // replace with empty array.
            this.elementData = EMPTY_ELEMENTDATA;//c參數集合長度爲0，那麼elementData賦值爲空的數組對象
        }
    }

基礎方法

trimToSize elementData長度修剪到實際存儲數據長度app

public void trimToSize() {
        modCount++;//操做數+1
        if (size < elementData.length) {//若是實際存儲數量小於elementData長度
            elementData = (size == 0)
              ? EMPTY_ELEMENTDATA//若是實際存儲爲0，那麼elementData賦值爲空的數組對象
              : Arrays.copyOf(elementData, size);//不然拷貝實際存儲的長度的數據
        }
    }

ensureCapacity 確保elementData至少能夠容納minCapacity個數據函數

public void ensureCapacity(int minCapacity) {
        if (
        minCapacity > elementData.length//最低容納數量大於當前elementData長度
            && 
        !(elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA&& minCapacity <= DEFAULT_CAPACITY)//elementData不等於空數組對象而且最低容納量大於默認空間(10)
        ) {
            modCount++;//操做數+1
            grow(minCapacity);//符合條件則擴展數組
        }
    }

grow 擴展數組this

private Object[] grow() {
        return grow(size + 1);//按照實際存儲數據量+1來擴展
    }

grow(int minCapacity) 擴展數組.net

private Object[] grow(int minCapacity) {
        return elementData = Arrays.copyOf(elementData, newCapacity(minCapacity));//複製數組，長度爲newCapacity(minCapacity)的返回
    }

newCapacity(int minCapacity) 返回至少與給定最小容量同樣大的容量線程

private int newCapacity(int minCapacity) {
        // overflow-conscious code
        int oldCapacity = elementData.length;//獲取舊elementData長度
        int newCapacity = oldCapacity + (oldCapacity >> 1);//新的長度爲舊的1.5倍
        if (newCapacity - minCapacity <= 0) {//若是新的長度比最小容量小
            if (elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA)
                return Math.max(DEFAULT_CAPACITY, minCapacity);//若是elementData是空的，返回10和最小容量中比較大的一個
            if (minCapacity < 0) // overflow
                throw new OutOfMemoryError();//最小容量不容許爲負數
            return minCapacity;//若是新的長度比最小容量小，那麼直接返回最小容量
        }
        return (newCapacity - MAX_ARRAY_SIZE <= 0)//若是新的長度比最大長度小，那麼返回新的容量，不然返回hugeCapacity(minCapacity)返回值
            ? newCapacity
            : hugeCapacity(minCapacity);
    }

hugeCapacity(int minCapacity) 返回大的的容量code

private static int hugeCapacity(int minCapacity) {
        if (minCapacity < 0) // overflow
            throw new OutOfMemoryError();//最小容量不容許爲負數
        return (minCapacity > MAX_ARRAY_SIZE)
            ? Integer.MAX_VALUE//若是最小容量大於MAX_ARRAY_SIZE返回Integer的最大值
            : MAX_ARRAY_SIZE;//不然返回MAX_ARRAY_SIZE (MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8;)
    }

size 返回實際存儲的數據數對象

public int size() {
        return size;
    }

isEmpty 判斷實際存儲的數據是否爲空

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

contains 判斷一個元素是否存在

public boolean contains(Object o) {
        return indexOf(o) >= 0;
    }

indexOf 獲取一個元素位置

public int indexOf(Object o) {
        return indexOfRange(o, 0, size);
    }

indexOfRange(Object o, int start, int end) 範圍內查詢目標數據在集合中的位置

int indexOfRange(Object o, int start, int end) {
        Object[] es = elementData;
        if (o == null) {//若是目標數據爲空
            for (int i = start; i < end; i++) {//從start循環到end
                if (es[i] == null) {
                    return i;//若是數據爲null,則返回對應的下標
                }
            }
        } else {//目標數據不爲空
            for (int i = start; i < end; i++) {//從start循環到end
                if (o.equals(es[i])) {//調用的是目標函數的equals方法，這很重要
                    return i;
                }
            }
        }
        return -1;
    }

lastIndexOf(Object o) 查找元素最後一次出現位置

public int lastIndexOf(Object o) {
        return lastIndexOfRange(o, 0, size);
    }

lastIndexOfRange(Object o, int start, int end) 範圍內查詢元素最後一次出現位置（即逆第一次出現位置）

int lastIndexOfRange(Object o, int start, int end) {
        Object[] es = elementData;
        if (o == null) {//若是目標數據爲空
            for (int i = end - 1; i >= start; i--) {//從end-1
                if (es[i] == null) {
                    return i;
                }
            }
        } else {
            for (int i = end - 1; i >= start; i--) {
                if (o.equals(es[i])) {//調用的是目標函數的equals方法，這很重要
                    return i;
                }
            }
        }
        return -1;
    }

clone() 克隆集合

public Object clone() {
        try {
            ArrayList<?> v = (ArrayList<?>) super.clone();
            v.elementData = Arrays.copyOf(elementData, size);//克隆出elementData長度爲實際元素長度
            v.modCount = 0;
            return v;
        } catch (CloneNotSupportedException e) {
            // this shouldn't happen, since we are Cloneable
            throw new InternalError(e);
        }
    }

toArray() 返回數組

public Object[] toArray() {
        return Arrays.copyOf(elementData, size);//僅返回實際元素長度的數組
    }

toArray(T[] a) 返回數組

public <T> T[] toArray(T[] a) {
        if (a.length < size)
            // Make a new array of a's runtime type, but my contents:
            return (T[]) Arrays.copyOf(elementData, size, a.getClass());
        System.arraycopy(elementData, 0, a, 0, size);
        if (a.length > size)
            a[size] = null;//若是傳入的數組長度大於集合實際存儲數目，那麼將a數組size位置空後返回（不理解）
        return a;
    }

get(int index) 或許元素

public E get(int index) {
        Objects.checkIndex(index, size);//確認index>0,且index<size,不然拋出IndexOutOfBoundsException
        return elementData(index);
    }

set(int index, E element) 設置元素值

public E set(int index, E element) {
        Objects.checkIndex(index, size);//確認index>0,且index<size,不然拋出IndexOutOfBoundsException
        E oldValue = elementData(index);//獲取舊值
        elementData[index] = element;//設置新值
        return oldValue;//返回舊值
    }

elementData(int index) 獲取元素

E elementData(int index) {
        return (E) elementData[index];
    }

elementAt(Object[] es, int index) 獲取傳入數組的index位元素

static <E> E elementAt(Object[] es, int index) {
        return (E) es[index];
    }

add(E e) 添加元素到集合裏（尾插入）

public boolean add(E e) {
        modCount++;
        add(e, elementData, size);
        return true;//注意這裏永遠返回true
    }

add(E e, Object[] elementData, int s) 添加元素到集合裏

private void add(E e, Object[] elementData, int s) {
        if (s == elementData.length)
            elementData = grow();//滿了就擴容
        elementData[s] = e;//把s位值設置爲e, s必定會是空的
        size = s + 1;//手動將實際元素數+1
    }

add(int index, E element) 將元素插入到固定位置（中部插入）

public void add(int index, E element) {
        rangeCheckForAdd(index);//確認index>0,且index<size,不然拋出IndexOutOfBoundsException
        modCount++;
        final int s;
        Object[] elementData;
        if ((s = size) == (elementData = this.elementData).length)
            elementData = grow();//若是滿了就擴容
        System.arraycopy(elementData, index,
                         elementData, index + 1,
                         s - index);//複製index位開始的元素到index+1位，即index位開始元素所有日後挪1位
        elementData[index] = element;//index位賦值爲element
        size = s + 1;//手動將實際元素數+1
    }

remove(int index)刪除index位處的數據

public E remove(int index) {
        Objects.checkIndex(index, size);//確認index>0,且index<size
        final Object[] es = elementData;

        @SuppressWarnings("unchecked") E oldValue = (E) es[index];
        fastRemove(es, index);//快速刪除

        return oldValue;//返回舊值
    }

fastRemove(Object[] es, int i)快速刪除

private void fastRemove(Object[] es, int i) {
        modCount++;
        final int newSize;
        if ((newSize = size - 1) > i)//i在實際存儲數據範圍內（數組下標從0開始）
            System.arraycopy(es, i + 1, es, i, newSize - i);//把i+1位後的newSize - i個數據往前移一位
        es[size = newSize] = null;//把末位置空
    }

equals(Object o)比較對象是否相等

public boolean equals(Object o) {
        if (o == this) {//判斷內存地址
            return true;
        }

        if (!(o instanceof List)) {//不是List子類，直接返回false
            return false;
        }

        final int expectedModCount = modCount;//賦值指望的操做數
        // ArrayList can be subclassed and given arbitrary behavior, but we can
        // still deal with the common case where o is ArrayList precisely
        boolean equal = (o.getClass() == ArrayList.class)
            ? equalsArrayList((ArrayList<?>) o)//是ArrayList
            : equalsRange((List<?>) o, 0, size);//不是ArrayList

        checkForComodification(expectedModCount);//確認線程安全
        return equal;
    }

equalsArrayList(ArrayList<?> other)ArrayList判斷相等

private boolean equalsArrayList(ArrayList<?> other) {
        final int otherModCount = other.modCount;
        final int s = size;
        boolean equal;
        if (equal = (s == other.size)) {//比較存儲數據量
            final Object[] otherEs = other.elementData;//傳入的緩衝區
            final Object[] es = elementData;//當前的緩衝區
            if (s > es.length || s > otherEs.length) {
                throw new ConcurrentModificationException();//線程不安全
            }
            for (int i = 0; i < s; i++) {
                if (!Objects.equals(es[i], otherEs[i])) {//比較每一個元素，一個不相等就break
                    equal = false;
                    break;
                }
            }
        }
        other.checkForComodification(otherModCount);//查看線程是否安全
        return equal;
    }

equalsRange(List<?> other, int from, int to)判斷List相等

boolean equalsRange(List<?> other, int from, int to) {
        final Object[] es = elementData;//當前緩衝區
        if (to > es.length) {
            throw new ConcurrentModificationException();//線程不安全
        }
        var oit = other.iterator();//獲取迭代器
        for (; from < to; from++) {
            if (!oit.hasNext() || !Objects.equals(es[from], oit.next())) {//判斷每一個元素，跑不到oit.hasNext()爲false,由於for循環會先進不來
                return false;
            }
        }
        return !oit.hasNext();//for循環結束後oit.hasNext()一定爲false,即!oit.hasNext()是true
            }

checkForComodification(final int expectedModCount)確認線程是否安全

private void checkForComodification(final int expectedModCount) {
        if (modCount != expectedModCount) {
            throw new ConcurrentModificationException();
        }
    }

hashCode()返回哈希碼

public int hashCode() {
        int expectedModCount = modCount;
        int hash = hashCodeRange(0, size);//範圍內哈希
        checkForComodification(expectedModCount);//確認線程安全
        return hash;
    }

hashCodeRange(int from, int to)範圍內哈希

int hashCodeRange(int from, int to) {
        final Object[] es = elementData;
        if (to > es.length) {
            throw new ConcurrentModificationException();//線程不安全
        }
        int hashCode = 1;
        for (int i = from; i < to; i++) {
            Object e = es[i];
            hashCode = 31 * hashCode + (e == null ? 0 : e.hashCode());//對象爲空則取0
        }
        return hashCode;
    }

boolean remove(Object o)移除一個對象

public boolean remove(Object o) {
        final Object[] es = elementData;
        final int size = this.size;
        int i = 0;
        found: {
            if (o == null) {//空對象
                for (; i < size; i++)
                    if (es[i] == null)//循環比對內存地址獲取被刪除對象下標
                        break found;//跳出標記found
            } else {//不是空對象
                for (; i < size; i++)
                    if (o.equals(es[i]))//調用要被刪除對象的equals方法
                        break found;//跳出標記found
            }
            return false;//要刪除的數據不在緩衝區中，直接返回false
        }
        fastRemove(es, i);//調用快速刪除，按照下標刪除
        return true;//成功返回true
    }