Java类集框架 —— ArrayList源码分析

ArrayList可以说是在Java开发中最常用的集合容器了，今天就来分析一下ArrayList的源码，可以更加深入的理解ArrayList实现原理。

ArrayList的成员变量：

// 初始容量:10
private static final int DEFAULT_CAPACITY = 10;
// 空数组，没有元素数据
private static final Object[] EMPTY_ELEMENTDATA = {};
// 空数组，默认容量为空，没有元素数据
private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};
// 数组，用来存储ArrayList的元素
transient Object[] elementData;
// size为ArrayList的大小，在elementData不为空数组的情况下，size是小于elementData.length的
private int size;

根据elementData也能看出来，ArrayList的内部是通过数组来实现的，ArrayList对元素的增删改查实际上都是对数组的操作。

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

构造ArrayList时，可以指定容器的初始容量initialCapacity，构造一个给定初始大小的数组作为数据集；使用无参构造时，则默认容量为空的数组作为初始数据集；也可以使用其他任意的集合Collection作为构造参数，可以看到，源码中就是直接将集合c转换数组来作为数据集（如果数据集是非Object数组，比如多维数组，则将元素拷贝到数据集数组中）。ArrayList的构造实际上就是对其内部数组的初始化。

add方法：

public boolean add(E e) {
    // 确保当前数据集数组能够放得下新加入的元素
    ensureCapacityInternal(size + 1);  // Increments modCount!!
    // 将列表大小size自增1，并在数据集数组中放入元素e
    elementData[size++] = e;
    return true;
}

public void add(int index, E element) {
    // 检查新加入的位置index是否越界
    rangeCheckForAdd(index);
    // 确保当前数据集数组能够放得下新加入的元素，如果需要扩容的话就扩容
    ensureCapacityInternal(size + 1);  // Increments modCount!!
    // 将index位置及后面的元素都向后移动一位
    System.arraycopy(elementData, index, elementData, index + 1,
                     size - index);
    // 将index位置的元素设置为新建如的element
    elementData[index] = element;
    size++;
}

在添加元素时，如果不指定加入的位置，会添加到内部数组中已有元素的最后一位，也就是添加到了ArrayList的末尾。如果指定了添加位置index，判断index是否越界，是否需要扩容，最后移动index位置后的元素，并将index位置设置为新添加的元素。

需要注意的是，添加的元素并没有判空，所以ArrayList中的元素是可以为null的。

在add方法中，都调用了ensureCapacityInternal(int minCapacity)这个方法来确保数据集数组能够放得下新的元素：

private void ensureCapacityInternal(int minCapacity) {
    if (elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA) {
        minCapacity = Math.max(DEFAULT_CAPACITY, minCapacity);
    }
    ensureExplicitCapacity(minCapacity);
}

private void ensureExplicitCapacity(int minCapacity) {
    modCount++;
    // overflow-conscious code
    // 如果添加新元素需要的最小容量大于数组的长度，就需要扩容
    if (minCapacity - elementData.length > 0)
        grow(minCapacity);
}

看下扩容的方法grow(int minCapacity)：

private void grow(int minCapacity) {
    // overflow-conscious code
    int oldCapacity = elementData.length;
    // 扩展至新的容量newCapacity为旧的容量的1.5倍
    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);
}

数组扩容的过程，实际上是新建了一个需要扩容的长度的数组，然后将原素组中的元素拷贝到这个新建的数组中，新的数组指定为ArrayList内部数据集数组。

总结：ArrayList在添加元素时，首先会判断添加的位置是否在内部数组中越界，如果越界，抛出异常；如果没有越界，则判断数组能否放得下新添加的元素，如果放得下，则直接存放到数组中；如果放不下，则将数组扩容，扩容后再存放到数组中。

remove方法：

public E remove(int index) {
    // 检查越界
    rangeCheck(index);
    modCount++;
    // 需要移除的元素
    E oldValue = elementData(index);
    // 需要移动位置的元素的数量
    int numMoved = size - index - 1;
    // 将需要移除元素的位置后的所有元素复制到index位置开始后的numMoved个位置
    if (numMoved > 0)
        System.arraycopy(elementData, index+1, elementData, index,
                         numMoved);
    // size减1，并将之前的最后一个位置元素置空
    elementData[--size] = null; // clear to let GC do its work
    return oldValue;
}

remove还有一个重载的方法，是移除给定的元素，它的实现就是遍历数组，找到元素的索引值，然后调用remove(int index)方法，根据索引值去删除。

总结：ArrayList在删除元素时，根据删除的索引值判断是否越界，如果越界，抛出异常；如果没有越界，取出要删除的元素，然后将这个元素后面所有的元素向前移动一位。

set方法：

public E set(int index, E element) {
    rangeCheck(index);
    E oldValue = elementData(index);
    elementData[index] = element;
    return oldValue;
}

set方法即修改列表中指定位置的元素值。它的实现非常简单：直接修改数组指定位置的值。

get方法：

public E get(int index) {
    rangeCheck(index);
    return elementData(index);
}

E elementData(int index) {
    return (E) elementData[index];
}

get方法实现非常简单只需要堆获取位置判断是否越界，然后直接从数组中取值即可。

从上面分析的源码中可以看出，ArrayList的实现就是对数组的操作，在添加和删除元素的时候，会涉及到数组的扩容和数组元素位置的移动，相对查询和修改元素要复杂一些，所以ArrayList适合用在查询和修改比较频繁，而添加和删除较少的情况下。