ArrayList扩容源码角度解析

最近在学习JDK的部分源码，看了下ArrayList的部分API实现，自己也做了部分注解在这里分享下：

首先我们先来看下ArrayList中几个成员变量表示的意思：

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

    private static final long serialVersionUID = 8683452581122892189L;

    /**
     * Default initial capacity.
     * 默认的数据容量, 当构造list数组时没有指出数据长度, 将使用此默认容量
     */
    private static final int DEFAULT_CAPACITY = 10;

    /**
     * Shared empty array instance used for empty instances.
     * 空数组, 当构造list数组时指出数组长度为0时, 将使用此构造空数组
     */
    private static final Object[] EMPTY_ELEMENTDATA = {};

    /**
     * Shared empty array instance used for default sized empty instances. We
     * distinguish this from EMPTY_ELEMENTDATA to know how much to inflate when
     * first element is added.
     * 当构造list数组时没有指定数组长度时, 将使用此数据对象, 容量为默认的10
     */
    private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};

    /**
     * The array buffer into which the elements of the ArrayList are stored.
     * The capacity of the ArrayList is the length of this array buffer. Any
     * empty ArrayList with elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA
     * will be expanded to DEFAULT_CAPACITY when the first element is added.
     * ArrayList的底层数据结构只是一个对象数组, 用于存放数组实际元素, 并且被标记为transient
     * transient关键字意味着该字段在序列化的时候是不会被序列化的
     */
    transient Object[] elementData;

    /**
     * The size of the ArrayList (the number of elements it contains).
     * 表示当前数组的大小, 类型是int, 没有用volatile修饰, 非线程安全
     * @serial
     */
    private int size;
}

 接着我们看下ArrayList的几个构造方法：

    /**
     * Constructs an empty list with an initial capacity of ten.
     * 无参构造方法, 将成员变量elementData的值变为DEFAULTCAPACITY_EMPTY_ELEMENTDATA
     * 默认为缺省空数组, 初始容量10是在第一次add的时候扩容成的容量
     */
    public ArrayList() {
        this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;
    }


    /**
     * Constructs an empty list with the specified initial capacity.
     * 有参构造方法, 参数传入初始数组容量
     * @param  initialCapacity  the initial capacity of the list
     * @throws IllegalArgumentException if the specified initial capacity
     *         is negative
     */
    public ArrayList(int initialCapacity) {
        // 如果传入的初始容量大于0, 就创建一个大小为这个容量的对象数组赋值给成员变量elementData
        if (initialCapacity > 0) {
            this.elementData = new Object[initialCapacity];
        } else if (initialCapacity == 0) {
            // 如果传入的初始容量=0, 就将EMPTY_ELEMENTDATA赋值给elementData
            this.elementData = EMPTY_ELEMENTDATA;
        } else {
            throw new IllegalArgumentException("Illegal Capacity: "+
                                               initialCapacity);
        }
    }


    /**
     * Constructs a list containing the elements of the specified
     * collection, in the order they are returned by the collection's
     * iterator.
     * 有参构造方法, 参数为传入的集合
     * @param c the collection whose elements are to be placed into this list
     * @throws NullPointerException if the specified collection is null
     */
    public ArrayList(Collection<? extends E> c) {
        // 将参数集合转化为数组并赋值给成员变量elementData
        elementData = c.toArray();
        // 将elementData的元素大小赋值给成员变量size, 并判断非空
        if ((size = elementData.length) != 0) {
            // c.toArray might (incorrectly) not return Object[] (see 6260652)
            // 判断elementData是否是对象数组类型, 如果不是就进行元素复制转化为对象数组
            if (elementData.getClass() != Object[].class) {
                elementData = Arrays.copyOf(elementData, size, Object[].class);
            }
        } else {
            // replace with empty array.
            // 如果elementData为空, 则将EMPTY_ELEMENTDATA空数组赋值给elementData
            this.elementData = EMPTY_ELEMENTDATA;
        }
    }

 最后是ArrayList的add()方法及其扩容：

    @Override
    public boolean add(E e) {
        // 确保当前数组大小是否足够, 不够则进行扩容
        ensureCapacityInternal(size + 1);
        // 将元素添加到elementData数组的指定位置, 在新增时并没有对值进行校验
        // 所以是允许添null值的
        // 并且赋值过程没有任何锁操作, 所以是线程非安全的
        elementData[size++] = e;
        return true;
    }


    private void ensureCapacityInternal(int minCapacity) {
        // calculateCapacity判断是否需要赋予默认容量
        ensureExplicitCapacity(calculateCapacity(elementData, minCapacity));
    }


    private static int calculateCapacity(Object[] elementData, int minCapacity) {
        // 如果存放元素的对象数组是缺省的默认空数组, 则将默认容量10赋值给minCapacity
        if (elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA) {
            return Math.max(DEFAULT_CAPACITY, minCapacity);
        }
        return minCapacity;
    }


    private void ensureExplicitCapacity(int minCapacity) {
        // 该变量在AbstractList中被transient关键字修饰, 统计当前数组被修改的版本次数
        // 数组结构有变动时+1
        modCount++;

        // overflow-conscious code
        // 判断minCapacity与当前元素数组的长度的大小
        // 如果minCapacity比当前元素数组的长度的大小大的时候需要扩容
        if (minCapacity - elementData.length > 0) {
            grow(minCapacity);
        }
    }



    private void grow(int minCapacity) {
        // overflow-conscious code
        // oldCapacity为未add前的数组容量, 旧容量
        int oldCapacity = elementData.length;
        // 新容量即扩容后的容量, oldCapacity >> 1位移运算表示旧容量除以2
        // 保证新容量是旧容量的1.5倍
        int newCapacity = oldCapacity + (oldCapacity >> 1);
        // 比较扩容后的新容量和minCapacity期待的最小容量, 如果新容量小于参数指定容量
        // 修改扩容后的新容量=minCapacity
        if (newCapacity - minCapacity < 0) {
            newCapacity = minCapacity;
        }
        // 如果扩容后的新容量大于jvm所能分配的数组的最大容量, 那么就用Integer的最大值作为新容量
        if (newCapacity - MAX_ARRAY_SIZE > 0) {
            // hugeCapacity(minCapacity)这个方法说明了ArrayList中的数组的最大值是 
            // Integer.MAX_VALUE
            // 超过这个值或者扩容后数组的大小下界小于0都会报错数组大小溢出
            newCapacity = hugeCapacity(minCapacity);
        }
        // minCapacity is usually close to size, so this is a win:
        // 拷贝复制进行扩容, 通过System.arraycopy方法进行浅拷贝, 此方法是native的方法
        elementData = Arrays.copyOf(elementData, newCapacity);
    }

    private static int hugeCapacity(int minCapacity) {
        if (minCapacity < 0) {
            throw new OutOfMemoryError();
        }
        return (minCapacity > MAX_ARRAY_SIZE) ?
            Integer.MAX_VALUE :
            MAX_ARRAY_SIZE;
    }