ArrayList源码解析（JDK1.8）

1. 概述

• 动态可调整大小的数组实现，允许null值。该类与Vector相似，但该类不是线程安全的，使用时需注意。
• 每个ArrayList都有一个capacity容量，指数组的大小，如果添加元素，其容量会自动增长。
• ArrayList的类图：
  
• ArrayList底层数据结构是数组，Object[]，对于数组的操作是线性的，但访问元素是随机访问的。

2. 继承和实现

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

• ArrayList同时继承 AbstractList<E> 和实现List<E>，表名该类拥有add()、get()等基本方法。
• 实现RandomAccess，目的是快速随机存取，有关效率的问题，在实现了该接口的话，那么使用普通的for循环来遍历，性能更高
• 实现Cloneable接口，包含Object.Clone()方法。
• 实现java.io.Serializable，序列化，能够保存在内存中，在网络之间传输，进行反序列化就能获得序列化前的类。

3. 常量或变量

    //序列化ID，可用于反序列的成功
    private static final long serialVersionUID = 8683452581122892189L;

    //默认容量为10
    private static final int DEFAULT_CAPACITY = 10;

    //初始内容为空
    private static final Object[] EMPTY_ELEMENTDATA = {};

    
    private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};

    //存储元素的缓冲区数组
    transient Object[] elementData; // non-private to simplify nested class access

    //已有元素的个数
    private int size;

4. 构造方法

   //初始化空ArrayList，默认容量值10，但实际为空，需要在第一次add元素的时候，扩容至10，或者更大
   public ArrayList() {
        this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;
    }
    
   //初始化空ArrayList，指定容量，进行容量合法检查
   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);
        }
    }
    //初始化内容为指定参数c
    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;
        }
    }
    

5. 方法

5.1 add

    //添加元素，时间复杂胡为O(1)
    public boolean add(E e) {
        //size + 1 表示最小容量，首次添加size = 0
        ensureCapacityInternal(size + 1);  // Increments modCount!!
        //向数组的最后添加元素
        elementData[size++] = e;
        return true;
    }
    //扩容的步骤：
    private void ensureCapacityInternal(int minCapacity) {
        ensureExplicitCapacity(calculateCapacity(elementData, minCapacity));
    }
    private static int calculateCapacity(Object[] elementData, int minCapacity) {       //相等表示第一次添加元素，此时elementData 还为空，没有分配空间
        if (elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA) {
            //返回需要的最小容量和默认容量10之间的最大值，
            return Math.max(DEFAULT_CAPACITY, minCapacity);
        }
        //不是第一次添加元素，就返回最小容量
        return minCapacity;
    }


    //最小的容量大于当前的容量，就需要扩容
    private void ensureExplicitCapacity(int minCapacity) {
        //修改值加一
        modCount++;
        // overflow-conscious code
        //所需要的最小容量大于当前的容量，就需要扩容
        if (minCapacity - elementData.length > 0)
            grow(minCapacity);
    }
    //
    private void grow(int minCapacity) {
        // overflow-conscious code
        int oldCapacity = elementData.length;
        //新容量就是当前容量的1.5倍
        int newCapacity = oldCapacity + (oldCapacity >> 1);
        //如果新容量还小于所需要的最小容量，那么就将新容量置为所需要的最小容量
        if (newCapacity - minCapacity < 0)
            newCapacity = minCapacity;
        //如果新的容量大于Integer.MAX_VALUE - 8 临界值，新的容量还需要调整
        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);
    }
    //
    private static int hugeCapacity(int minCapacity) {
        //如果minCapacity 小于0，就表示minCapacity 在扩大的过程中出现进位溢出的情况
        //所以会抛出Error
        if (minCapacity < 0) // overflow
            throw new OutOfMemoryError();
        //最小容量大于Integer.MAX_VALUE - 8 临界值，将新的最终的容量置为Integer.MAX_VALUE
        //否则置为Integer.MAX_VALUE - 8 
        return (minCapacity > MAX_ARRAY_SIZE) ?
            Integer.MAX_VALUE :
            MAX_ARRAY_SIZE;
    }

    //向指定位置添加元素，时间复杂度为O(n)
    public void add(int index, E element) {
        //判断元素是否合法，即应大于等于0，小于数组长度
        rangeCheckForAdd(index);
        //如果有需要就扩容
        ensureCapacityInternal(size + 1);  // Increments modCount!!
        //此方法就是将index包括index的元素向后移动一个位置，那么指定位置添加元素
        //的时间复杂度就是O(n)
        System.arraycopy(elementData, index, elementData, index + 1,
                         size - index);
        //将下标index处 的元素置为新值
        elementData[index] = element;
        size++;
    }

5.2 indexOf

   //获取下标，时间复杂度为O(n)
   public int indexOf(Object o) {
        //如果参数为null，就依次判断当前元素是否有为null的
        if (o == null) {
            for (int i = 0; i < size; i++)
                if (elementData[i]==null)
                    return i;
        //不为null的话，就依次比较值是否相等
        } else {
            for (int i = 0; i < size; i++)
                if (o.equals(elementData[i]))
                    return i;
        }
        return -1;
    }
    //与indexOf()相似，不过此方法是从最后开始比较，那么得到的就是相匹配的最后一个下标
    //时间复杂度为O(n)
    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;
    }

5.3 set

   //向指定位置的元素设置为新的元素，时间复杂度为O(1)
   public E set(int index, E element) {
        //首先得判断参数下标是否超过当前数组的大小，超过会抛出IndexOutOfBoundsException异常
        rangeCheck(index);
        //获取指定位置的下标
        E oldValue = elementData(index);
        //设置新值
        elementData[index] = element;
        //返回旧值
        return oldValue;
    }

5.4 remove

    //将指定下标的元素移除，时间复杂度为O(n)
    public E remove(int index) {
        //检验参数index是否合法，是否大于等于数组长度，并没有检验是否小于0
        rangeCheck(index);
        modCount++;
        E oldValue = elementData(index);
        
        //numMoved表示在原数组中需要移动的元素的个数
        int numMoved = size - index - 1;
        //表示
        if (numMoved > 0)
            //当真正移动的时候调用本地方法
            //如果index<0，会抛出 IndexOutOfBoundsException 
            //此方法是将index+1处及往后的元素向前移动一个位置
            System.arraycopy(elementData, index+1, elementData, index,
                             numMoved);
        //最后将size减一，并末尾置为null
        elementData[--size] = null; // clear to let GC do its work
        //返回旧值
        return oldValue;
    }
    //移除元素，时间复杂度为O(n)
    public boolean remove(Object o) {
        //如果参数为null，就在当前数组中找到第一个为null的值，并移除
        if (o == null) {
            for (int index = 0; index < size; index++)
                if (elementData[index] == null) {
                    // 与remove(int index)相似
                    //不过fastRemove(int index)是私有方法，不判断index时候合法，不返回旧值
                    fastRemove(index);
                    return true;
                }
        //如果参数不为null，就在当前数组中找到第一相等的值，并移除
        } else {
            for (int index = 0; index < size; index++)
                if (o.equals(elementData[index])) {
                    // 与remove(int index)相似
                    //不过fastRemove(int index)是私有方法，不判断index时候合法，不返回旧值
                    fastRemove(index);
                    return true;
                }
        }
        return false;
    }
    //将指定范围内的元素移除，与remove(int index)移除单个元素相似
    protected void removeRange(int fromIndex, int toIndex) {
        modCount++;
        int numMoved = size - toIndex;
        //将toIndex及之后的元素向前移动
        System.arraycopy(elementData, toIndex, elementData, fromIndex,
                         numMoved);

        // clear to let GC do its work
        int newSize = size - (toIndex-fromIndex);
        //置为null
        for (int i = newSize; i < size; i++) {
            elementData[i] = null;
        }
        size = newSize;
    }