ArrayList源码解读（基于JDK8）

一、ArrayList简介

ArrayList的实现原理就是数组，是线程不安全的，允许其中元素为null。
它实现了List<E>, RandomAccess, Cloneable, java.io.Serializable接口，其中RandomAccess代表了其拥有随机快速访问的能力，ArrayList可以以O（1）的时间复杂度去根据下标访问元素。
因为底层是数组，所以会占用一块连续的内存空间，初始化时默认大小为10，缺点是空间效率不高，增加删除效率不高，优点是查询速度快。
当集合的元素超出数组的长度时，就要扩容操作，每次扩容都要消耗一定的时间，所以我们如果事先预知数据量的大小，可以通过public ArrayList(int initialCapacity) {}构造方法来指定集合的大小，以减少扩容次数，提高写入效率。

构造方法详解：

    //集合的默认初始容量为10
    private static final int DEFAULT_CAPACITY = 10;
    //默认构造函数里的空数组
    private static final Object[] EMPTY_ELEMENTDATA = {};
    //真正存放元素的数组
    private transient Object[] elementData;
    //自定义初始容量的构造方法
    public ArrayList(int initialCapacity) {
        super();
        //如果初始容量小于0则报IllegalArgumentException异常
        if (initialCapacity < 0)
            throw new IllegalArgumentException("Illegal Capacity: " + initialCapacity);
        this.elementData = new Object[initialCapacity];
    }
    //默认的构造方法
    public ArrayList() {
        super();
        //默认的构造方法是将空数组赋值给了elementData
        this.elementData = EMPTY_ELEMENTDATA;
    }
    //将别的集合直接赋值进行创建的构造方法
    public ArrayList(Collection<? extends E> c) {
        //直接用toArray()的方法获取集合的数组对象，并且直接赋值给elementData
        elementData = c.toArray();
        size = elementData.length;
        // 这里是当c.toArray出错，没有返回Object[]时，利用Arrays.copyOf 来复制集合c中的元素到elementData数组中
        if (elementData.getClass() != Object[].class)
            elementData = Arrays.copyOf(elementData, size, Object[].class);
    }

特别注意的是：在使用默认无参构造方法创建ArrayList时，只是将空数组赋给真正的数组，并没有初始化大小，只有在第一次添加元素的时候，才会判断进行第一次扩容时就是第一次初始化大小为默认的10.

二、常见API详解

1、添加元素：每次添加元素之前都会判断添加后的容量是否需要扩容。

    //添加单个元素
    public boolean add(E e) {
        //判断添加后的长度是否需要扩容
        ensureCapacityInternal(size + 1); 
        //在数组末尾添加上当前元素，并且修改size大小
        elementData[size++] = e;
        return true;
    }
    //集合的初始容量为10
    private static final int DEFAULT_CAPACITY = 10;
    //判断是否是第一次初始化数组
    private void ensureCapacityInternal(int minCapacity) {
        //判断当前数组是否 == EMPTY_ELEMENTDATA，因为默认构造函数创建时是将空数组EMPTY_ELEMENTDATA赋值给elementData
        if (elementData == EMPTY_ELEMENTDATA) {
            //判断默认容量10和当前数据长度的大小，取其中大的值作为判断本次是否需要扩容的依据，由于第一次数组是空的，所以默认要使数组扩容到10的长度
            minCapacity = Math.max(DEFAULT_CAPACITY, minCapacity);
        }
        //判断是否需要扩容
        ensureExplicitCapacity(minCapacity);
    }
    //判断扩容的方法
    private void ensureExplicitCapacity(int minCapacity) {
        //如果需要扩容modCount++，此参数是指当前列表结构被修改的次数
        modCount++;
        // 判断当前数据量是否大于数组的长度
        if (minCapacity - elementData.length > 0)
            //如果大于则进行扩容操作
            grow(minCapacity);
    }
    //扩容方法
    private void grow(int minCapacity) {
        // 记录扩容前数组的长度
        int oldCapacity = elementData.length;
        //将原数组的长度扩大0.5倍作为扩容后新数组的长度
        //（如果扩容前数组长度为10，那么经过扩容后的数组长度应该为15）
        int newCapacity = oldCapacity + (oldCapacity >> 1);
        //如果扩容后的长度小于当前数据量，那么就将当前数据量的长度作为本次扩容的长度
        if (newCapacity - minCapacity < 0)
            newCapacity = minCapacity;
        //判断新数组长度是否大于可分配数组的最大大小
        if (newCapacity - MAX_ARRAY_SIZE > 0)
            //将扩容长度设置为最大可用长度
            newCapacity = hugeCapacity(minCapacity);
        // 拷贝，扩容，构建一个新的数组
        elementData = Arrays.copyOf(elementData, newCapacity);
    }
    //判断如果新数组长度超过当前数组定义的最大长度时，就将扩容长度设置为Interger.MAX_VALUE,也就是int的最大长度
    private static int hugeCapacity(int minCapacity) {
        if (minCapacity < 0) // overflow
            throw new OutOfMemoryError();
        return (minCapacity > MAX_ARRAY_SIZE) ? Integer.MAX_VALUE : MAX_ARRAY_SIZE;
        }

特别注意的是：每次添加add元素前，都需要先判断添加后的长度size+1是否需要扩容（通过判断当前数据量是否大于数组的长度elementData.length），然后在数组末尾添加当前元素，修改size大小。当第一次添加元素时（通过判断是否为空数组），需要初始化大小为10。之后的每次扩容都是扩大为原来的1.5倍，但如果扩容后还小于当前的数据量，那就直接将当前的数据量作为扩容后数组的长度。当数组的长度超过当前定义的最大长度时，则将扩容长度设置为Interger.MAX_VALUE。每次扩容后都要将原有数组复制到扩容后的数组。

2、向指定下标添加元素：需要将指定下标后面的元素全部向后移动一位。

    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++;
    }
    //判断下标是否越界
    private void rangeCheckForAdd(int index) {
        if (index > size || index < 0)
            throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
    }

3、添加多个元素：调用parent.addAll()方法将集合c的所有元素添加到数组的size后面。

    //添加多个元素
    public boolean addAll(Collection<? extends E> c) {
            return addAll(this.size, c);
    }
    //添加多个元素到指定下标
    public boolean addAll(int index, Collection<? extends E> c) {
        //判断下标是否越界
        rangeCheckForAdd(index);
        //判断c的大小是否大于0
        int cSize = c.size();
        if (cSize==0)
            return false;
        checkForComodification();
        //将元素插入到数组中
        parent.addAll(parentOffset + index, c);
        //将修改次数赋值给modCount
        this.modCount = parent.modCount;
        this.size += cSize;
        return true;
    }

4、删除指定索引下的元素：删除之后要将index后面的元素前移，并将后面空闲出来的位置赋值为null，有利于GC收集，修改size–。

//删除某个下标的元素，并且返回该下标元素值
    public E remove(int index) {
        //判断下标是否越界
        rangeCheck(index);
        //修改次数加一
        modCount++;
        //查询该下标的元素赋值为oldValue
        E oldValue = elementData(index);
        //计算出需要移动数组的数据长度（有一个10长度的数组，我要删除下标1的元素，所以下标在1之后的元素都要依次往前移动1,10 - 1 - 1 = 8，需要挪动的元素数量为8）
        int numMoved = size - index - 1;
        //判断挪动数量是否大于0
        if (numMoved > 0)
            //拷贝数组，重新赋值
            System.arraycopy(elementData, index+1, elementData, index,
                             numMoved);
        //将空闲出来的位置赋值为null
        elementData[--size] = null;
        return oldValue;
    }
    //直接删除该下标的元素，不返回值
    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
    }

5、删除给定元素第一次出现时该位置的数据：注意判断该元素是否为null。

//删除该元素在数组中出现的第一个位置上的数据。如果该数据存在返回true，否则返回false
    public boolean remove(Object o) {
        //判断删除元素是否为null
        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;
    }

6、批量删除给定集合的所有元素：删除元素一定会修改modCount。

//批量删除
    public boolean removeAll(Collection<?> c) {
        return batchRemove(c, false);
    }
    //批量移动
    private boolean batchRemove(Collection<?> c, boolean complement) {
        //将数组赋值给一个新数组
        final Object[] elementData = this.elementData;
        //w表示批量删除后数组还剩多少元素
        int r = 0, w = 0;
        boolean modified = false;
        try {
            //保存两个集合的共有元素
            for (; r < size; r++)
                //如果c中不包含当前元素则保留
                if (c.contains(elementData[r]) == complement)
                    elementData[w++] = elementData[r];
        } finally {
            // 出现异常会导致r != size，则将出现异常的数据全部添加到保留的数组里，不进行删除
            if (r != size) {
                //将异常的数据插入要保留的数组里
                System.arraycopy(elementData, r, elementData, w, size - r);
                //修改w的数量，将剩余异常的数据长度加到要保留的长度上
                w += size - r;
            }
            //判断要保留的长度和集合长度是否一致，
            if (w != size) {
                // 将删除空出来的下标全部置为null
                for (int i = w; i < size; i++)
                    elementData[i] = null;
                //修改次数
                modCount += size - w;
                //集合大小等于最后保留的数据长度
                size = w;
                modified = true;
            }
        }
        return modified;
    }

特别注意：如果删除的数据多于数组里的数据也不会出现问题，它只会删除他们共有的元素。将原数组赋值给一个新数组，用w来记录剩余的多于个数，遍历原数组，判断集合c是否包含该元素，不包含则添加到新数组中，如果有异常发生， 将异常之后的数据都插入到新数组中。最后将删除空出来的下标全部置为null，更新数组大小size为w。

7、修改元素：就是取出index下的元素值，重新赋值，是高效操作，不会修改modCount。

    public E set(int index, E e) {
        //判断下标是否越界
        rangeCheck(index);
        //取出下标为index的元素值
        E oldValue = elementData(index);
        //重新赋值
        elementData[index] = element;
        //返回旧数据
        return oldValue;
    }

8、查找元素：高效操作，不会修改modCount。

    public E get(int index) {
        //越界问题
        rangeCheck(index);
        //查询数据
        return elementData(index);
    }
    E elementData(int index) {
        return (E) elementData[index];
    }

9、是否包含某个元素：contains

    //检查是否包含某个元素
    public boolean contains(Object o) {
        return indexOf(o) >= 0;
    }
    //没什么好说的，只是做了null和非null情况的判断
    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;
    }

10、清空元素clear

    public void clear() {
        //修改modCount
        modCount++;
    
        // 将所有下标数据都置为null，保留数组大小
        for (int i = 0; i < size; i++)
            elementData[i] = null;
        //修改size大小
        size = 0;
    }

11、判断是否为空isEmpty

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

12、克隆集合clone：直接调用父类的clone方法，强制转化为ArrayList类型，将数组复制过去。

    public Object clone() {
        try {
            @SuppressWarnings("unchecked")
            //直接调用父类的clone方法
            ArrayList<E> v = (ArrayList<E>) super.clone();
            //将elementData拷贝到v.elementData中
            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();
        }
    }

13、迭代器Iterator：hasNext方法判断是否有下一个元素，Next方法来获取下一个元素，remove删除掉上一次next的元素。

    public Iterator<E> iterator() {
        return new Itr();
    }
    private class Itr implements Iterator<E> {
        int cursor;       // index of next element to return
        int lastRet = -1; // index of last element returned; -1 if no such
        //用来判断集合是否修改过结构的标志
        int expectedModCount = modCount;
        //判断是否还有下一个元素
        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];
        }
        //删除掉上一次next的元素
        public void remove() {
            //判断是否执行过next
            if (lastRet < 0)
                throw new IllegalStateException();
            checkForComodification();
            try {
                ArrayList.this.remove(lastRet);
                //要删除的下标
                cursor = lastRet;
                //防止重复删除，将下标置为-1
                lastRet = -1;
                expectedModCount = modCount;
            } catch (IndexOutOfBoundsException ex) {
                throw new ConcurrentModificationException();
            }
        }
            //判断是否修改过集合的结构，如果修改过直接抛出异常
            final void checkForComodification() {
                if (modCount != expectedModCount)
                    throw new ConcurrentModificationException();
            }
        }

总结：
1 增删改查操作中，增需要扩容modCount，删除一定会修改modCount。修改和查询一定不会修改modCount。
2 增操作会导致数组扩容和数组复制，批量删除会找出两个数组的交集，以及数组复制操作，所以，增删操作时间复杂度相对较高。而修改和查询的效率很高。
3 当然上述情况都是建立在数据量比较大的情况下，小数据量相差无几，所以在查询和修改操作较多的情况下建议使用ArrayList。