源码阅读：ArrayList（JDK 8）

Java 复习资料 （持续更新） 码云
Java 复习资料 （持续更新） Github

ArrayList 基本信息

type : class

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

类文档

可变大小数组实现了List接口。实现了所有List接口的可选操作，并且允许所有类型的元素，包括null。
除了实现了List接口之外，本类一些方法来操纵内部用于存储列表的数组的大小。（除了同步问题外，本类与Vector基本一致）

size、isEmpty、get、set、iterator、listIterator操作可以在常量时间内完成。add操作需要消耗固定时间，添加n元素，需要O（n）的时间。除此之外的其他所有操作在需要线性时间（粗略估计）。与LinkedList相比，常数因子比较低。

每个ArrayList实例都有一个容量。容量是List中用于存储元素的数组大小。容量至少是与List.size的大小一样。当元素被加入ArrayList的时候，他的容量会自动增长。

应用可以在增加大量元素之前使用ensureCapacity方法增加容量。这可以减少重新分配空间的次数。

注意，该实现类并不是线程安全的。如果多个线程同时访问ArrayList实例，并且至少有一个线程在结构上修改列表，则必须在外部进行同步。（结构修改是添加或删除一个或多个元素，或显式调整后备数组大小的任何操作。仅设置元素的值不是结构上的修改。）通常，通过在自然封装列表的某个对象上进行同步来完成此操作。

如果不存在这样的对象，则应使用Collections.SynchronizedList方法.最好在创建时完成此操作，以防止意外的不同步访问列表.

迭代器和列表迭代器在本类中的是现实属于快速失败的。如果在创建迭代器后的任何时间对列表进行结构修改，则可以通过迭代器自身的方式以任何方式进行修改。因此，面对并发修改，迭代器会快速干净地失败，而不会在未来的不确定时间内不确定的行为的风险。

请注意，迭代器的快速失败行为无法得到保证，因为通常来说，在存在不同步的并发修改的情况下，不可能做出任何严格的保证。快速失败的迭代器会尽最大努力抛出ConcurrentModificationException。因此，编写依赖于此异常的程序以确保其正确性是错误的：迭代器的快速失败行为应仅用于检测错误。

本类是Java集合框架中的成员。

部分变量说明

1. EMPTY_ELEMENTDATA 和 DEFAULTCAPACITY_EMPTY_ELEMENTDATA

1. private static final Object[] EMPTY_ELEMENTDATA = {};
2. private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};

这两个变量之所以放在一起说是因为他们的在实际使用中是相关的。本质上区分两者关系的作用并不是很大，但是好玩。

首先看一下DEFAULTCAPACITY_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.
共享空数组实例用于默认大小的空实例。我们与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);
    }
}

public ArrayList() {
 this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;
}

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;
    }
}

而对于上述两个静态变量而言，唯一的差距就是当传入参数为0、空集合、不传参的时候。而其他的时候，都会将elementData赋值为有长度的Object数组。所以我们把范围缩小到初始化的时候使用空数据，而不包括用集合作为参数的构造方法。因此我们要关注的是ArrayList(int)和ArrayList()。

我们可以看到

1. new ArrayList(0)使用的数组是 EMPTY_ELEMENTDATA;
2. new ArrayList() 使用的数组是 DEFAULTCAPACITY_EMPTY_ELEMENTDATA;

因为原文中说过，两者的差距出现在第一个元素添加的时候，影响的是数组的增长大小。

add源码

public boolean add(E e) {
    ensureCapacityInternal(size + 1);  // Increments modCount!!
    elementData[size++] = e;
    return true;
}

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++;
}

两个add方法重载中，都出现了ensureCapacityInternal(size + 1)方法，那再看一下ensureCapacityInternal方法的源码（我加了点注释）

//add方法调用的时候，传入的minCapacity 为 size + 1
//由于仅考虑添加第一个数据，因此size = 0 所以 minCapacity = 1
private void ensureCapacityInternal(int minCapacity) {
	ensureExplicitCapacity(calculateCapacity(elementData, minCapacity));
}

该法方法中是保证数组容量足够的方法
该方法中调用了两个方法，ensureExplicitCapacity()和(calculateCapacity)方法
先看一下(calculateCapacity)方法源码(我加了一些注释)

private static int calculateCapacity(Object[] elementData, int minCapacity) {
	//如果用DEFAULTCAPACITY_EMPTY_ELEMENTDATA作为数据源
	//	则会返回DEFAULT_CAPACITY和minCapacity的最大值
	//否则直接返回minCapacity
	//由于第一个数据添加的时候，size = 0，因此此处的minCapacity = size + 1  = 1
    if (elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA) {
	    //在1.8中，DEFAULT_CAPACITY = 10
        return Math.max(DEFAULT_CAPACITY, minCapacity);
    }
    return minCapacity;
}

可以看到，如果使用DEFAULTCAPACITY_EMPTY_ELEMENTDATA作为数组源，则返回传入数据大小
和DEFAULTY_CAPACITY较大的，否则直接返回minCapacity。

所以 如果使用的是DEFAULTCAPACITY_EMPTY_ELEMENTDATA则返回10，否则返回1。
然后是ensureExplicitCapacity源码

private void ensureExplicitCapacity(int minCapacity) {
    modCount++;

    // overflow-conscious code
    if (minCapacity - elementData.length > 0)
        grow(minCapacity);
}

当第一数据被添加的时候，minCapacity = 1 > elementData.length, 因此一定发生了数据增长（grow方法）

grow(int)方法源码

private void grow(int minCapacity) {
    //overflow-conscious code
    int oldCapacity = elementData.length;
    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);
}

原来的数据长度为size + 1 = 0 + 1 = 1，新长度为

1 + 1 >> 1 = 1 + 0 = 1

然后grow会进行一次比较，如果新长度小于传入参数，则使用参数，最后进行数组示例。

所以DEFAULTCAPACITY_EMPTY_ELEMENTDATA会再第一次添加数据的时候，申请10个空间，而另外的那个，只会获得一个。

以同样添加10个数据作为标准

• ArrayList()方法增长1次，最后空间量为10

• ArrayList(0)方法增长4次，最后空间量为10

两者性能分析

两者差距仅出现在10个元素之前，如果ArrayList的实例非常多，但是每个实例包含的元素不是特别多
则使用ArrayList(0)进行构造比较合适。

对于实例数量有限，而且元素个数也不是特别多，那就使用ArrayList()进行构造。

如果实例数量有限，元素个数还很多，请用ArrayList(int bigCount);进行构造

部分方法

1. private boolean batchRemove(Collection<?> c, boolean complement);

部分诡异的部分我增加了注释

public class ArrayList{
    private boolean batchRemove(Collection<?> c, boolean complement) {
        final Object[] elementData = this.elementData;
        int r = 0, w = 0;
        boolean modified = false;
        try {
            for (; r < size; r++)
                //当complement为true,则c中存在则保留 - retainAll
                //当complement为false，则c中不存在则保留 - removeAll
                if (c.contains(elementData[r]) == complement)
                    //保留语句，保留第r位元素
                    elementData[w++] = elementData[r];
        } finally {
            //最后结果处理，保证大小同时，保证不存在数据为null，让GC正常工作
            if (r != size) {
                System.arraycopy(elementData, r,
                                 elementData, w,
                                 size - r);
                w += size - r;
            }
            if (w != size) {
                // clear to let GC do its work
                // 避免引用可达，则GC无法有效清除该部分数据
                for (int i = w; i < size; i++)
                    elementData[i] = null;
                modCount += size - w;
                size = w;
                modified = true;
            }
        }
        return modified;
    }
}

其他变量和方法都和简单，不再赘述。