ArrayList的扩容机制

今天学习一下 ArrayList 的扩容机制。

1. 先看下 ArrayList 的构造方法，有三种

（1）带初始容量参数的构造函数，用户可以自己定义容量
（2）默认构造函数，使用初始容量10构造一个空列表(无参数构造)
（3）构造包含指定collection元素的列表，这些元素利用该集合的迭代器按顺序返回

源码如下：

    /**
     * 默认初始化大小，10
     */
    private static final int DEFAULT_CAPACITY = 10;

    /**
     * 用于空实例的共享空数组实例
     */
    private static final Object[] EMPTY_ELEMENTDATA = {};

    /**
     * 用于默认大小的空实例的共享空数组实例。我们将其与空的元素数据区分开来，以了解添加第一个元素时要添加多少
     */
    private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};

    /**
     * ArrayList 的大小
     */
    private int size;

    /**
     * 带初始容量参数的构造函数。（用户自己指定容量）
     *
     * @param  initialCapacity  the initial capacity of the list
     * @throws IllegalArgumentException if the specified initial capacity
     *         is negative
     */
    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);
        }
    }

    /**
     * 默认构造函数，使用初始容量10构造一个空列表(无参数构造)
     */
    public ArrayList() {
        this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;
    }

    /**
     * 构造包含指定collection元素的列表，这些元素利用该集合的迭代器按顺序返回
     *如果指定的集合为null，throws NullPointerException。
     *
     * @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 = 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;
        }
    }

2. 通过源码分析 ArrayList 的扩容机制

通过以上，可以发现以无参数构造方法创建 ArrayList 时，实际上初始化赋值的是一个空数组。当真正对数组进行添加元素操作时，才真正分配容量。即向数组中添加第一个元素时，数组容量扩为10

接下来分析一下添加元素和扩容的过程。

当调用add(E e)方法进行添加元素时，首先会调用 ensureCapacityInternal 方法

    /**
     * 将指定的元素追加到此列表的末尾
     */
    public boolean add(E e) {
        ensureCapacityInternal(size + 1);  // 增加 modCount!!
        elementData[size++] = e;
        return true;
    }

分析 ensureCapacityInternal 方法，当添加第一个元素时，size为0，得到minCapacity为1，判断数组的数据是不是空，如果是空将传进来的值和默认大小值进行比较，获取两个的最大值，当前可以得到 minCapacity变为10。然后再执行 ensureExplicitCapacity 方法，判断是否需要扩容。

    /**
     * 得到最小扩容量
     * @param minCapacity
     */
    private void ensureCapacityInternal(int minCapacity) {
        if (elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA) {
	    // 获取默认容量和传进来参数的最大值
            minCapacity = Math.max(DEFAULT_CAPACITY, minCapacity);
        }

        ensureExplicitCapacity(minCapacity);
    }

当插入的是第一个元素时，elementData.length为0，此时minCapacity为10，10>0，需要进行扩容，执行grow方法，扩展后的容量为10。
当插入的是第2至第10个元素时，minCapacity - elementData.length > 0 就不会成立，不会执行grow扩容操作，当到了第11个元素的时候就会开始扩容。

    /**
     * 判断是否需要扩容
     * @param minCapacity
     */
    private void ensureExplicitCapacity(int minCapacity) {
        modCount++;

        // 当要插入的元素下标索引超过原有长度时，进行扩容
        if (minCapacity - elementData.length > 0)
            // 进行扩容
            grow(minCapacity);
    }

当插入的是第一个元素时，minCapacity为10，此时elementData.length=0，故 int newCapacity = oldCapacity + (oldCapacity >> 1); 计算后得到的值还是0；所以 newCapacity - minCapacity < 0 成立，newCapacity = minCapacity;第一次扩容的容量为10。

扩容的机制如下：
首先获取数组的旧容量，然后计算新容量的值，计算使用位运算，将其扩容至原来的1.5倍。
得到新容量的值后，校验扩容后的容量是否大于需要的容量，如果小于，则把最小需要容量当作扩容后的新容量。并确保扩容后的容量不超过数组能设置的最大大小值。
最后将老数组的数据复制到新的数组中。

    /**
     * 数组的最大大小分配。
     */
    private static final int MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8;

    /**
     * 增加容量，以确保它至少可以容纳指定的元素数。（扩容核心）
     *
     * @param minCapacity the desired minimum capacity
     */
    private void grow(int minCapacity) {
        // 获取旧容量
        int oldCapacity = elementData.length;
        // 使用位运算，扩容1.5倍，得到新容量
        //  >> 1 等价于 /2
        int newCapacity = oldCapacity + (oldCapacity >> 1);
        // 校验扩容后的容量是否大于需要的容量，如果小于，则把最小需要容量当作扩容后的新容量
        if (newCapacity - minCapacity < 0)
            newCapacity = minCapacity;
        // 确保扩容后的容量不超过数组能设置的最大大小值
        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) {
        if (minCapacity < 0) // overflow
            throw new OutOfMemoryError();
        // 如果新容量大于最大容量，则新容量为 Integer.MAX_VALUE；否则为 Integer.MAX_VALUE - 8
        return (minCapacity > MAX_ARRAY_SIZE) ?
                Integer.MAX_VALUE :
                MAX_ARRAY_SIZE;
    }

参考：

• https://github.com/Snailclimb/JavaGuide/blob/master/docs/java/collection/ArrayList-Grow.md