Java集合框架——ArrayList源码

本文通过源码来总结一下ArrayList

ArrayList

ArrayList 底层上是一个动态数组

属性

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

// 指定容量为0时，数组为该值
private static final Object[] EMPTY_ELEMENTDATA = {};

// 调用无参构造方法，数组为该值，初次add元素时扩容为默认10
private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};

// 元素数组，有transient关键字，不会被序列化
transient Object[] elementData; // non-private to simplify nested class access

// list的大小，就是elementData数组的长度
private int size;

可以看到这里有两个空数组，具体区别下面会提到

构造方法

提供了三个构造方法

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

1、指定初始化容量

• 大于0则初始化一个指定容量的数组
• 等于0则将EMPTY_ELEMENTDATA空数组作为elementData

2、无参数构造方法
将DEFAULTCAPACITY_EMPTY_ELEMENTDATA空数组作为elementData
默认容量大小为10，但是这时候还没有初始化

3、Collection参数
通过toArray方法获取到的数组赋值给elementData，长度为0则用空数组代替
但是这里可以看到，如果长度不为0的话，进行了类型的判断，将非Object[]类型的复制为Object[]类型
注释说明因为c.toArray可能返回的不是Object[]类型，官网查找该bug描述

Arrays.asList构建出来的List，如果创建的是String类型的，toArray方法返回的就是String[]类型的数组，如果之后在该List中再add其他类型的数据，会抛出ArrayStoreException异常
例如

List list = new ArrayList(Arrays.asList("one", "two", "three"));

所以此处为了避免这样的情况，对非Object[]类型做了特殊处理

获取元素

因为底层是数组，所以直接通过下标获取，时间复杂度为O(1)

public E get(int index) {
    // 范围检查，数组越界
    rangeCheck(index);

    return elementData(index);
}

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

添加元素

因为是动态数组，所以添加元素时会涉及到扩容
1、通过calculateCapacity方法计算当前所需容量大小
2、ensureExplicitCapacity方法确定是否执行扩容
3、grow方法执行扩容，进行数组copy

public boolean add(E e) {
    // 确认是否需要扩容，所需最小容量传递当前容量+1
    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) {
    // 如果是无参构造方法初始化的数组，返回默认大小10
    if (elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA) {
        return Math.max(DEFAULT_CAPACITY, minCapacity);
    }
    // 否则返回所需最小容量（当前size + 1）
    return minCapacity;
}

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

    // 现在的数组容量小于所需最小容量，则扩容
    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);
    // 1.5倍后还小于所需最小容量，则直接扩容为所需最小容量
    if (newCapacity - minCapacity < 0)
        newCapacity = minCapacity;
    // 如果大于最大数组容量，则扩容为Integer最大数值
    if (newCapacity - MAX_ARRAY_SIZE > 0)
        newCapacity = hugeCapacity(minCapacity);
    // 进行数组copy
    elementData = Arrays.copyOf(elementData, newCapacity);
}

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

默认容量为10，但是初始化的时候是个空数组，在第一次add元素的时候会扩容到10

可以看到，扩容需要进行数组copy，所以如果是数据量很大又频繁add数据的情况下，最好是初始化时能指定容量

更新元素

指定下标，直接替换新值，返回旧的值

public E set(int index, E element) {
    rangeCheck(index);

    E oldValue = elementData(index);
    elementData[index] = element;
    return oldValue;
}

删除元素

删除指定下标元素

public E remove(int index) {
    rangeCheck(index);

    modCount++;
    // 通过下标获取到待删除元素
    E oldValue = elementData(index);

    // 计算需要移动的元素数量，被删元素后面的都需要移动
    int numMoved = size - index - 1;
    if (numMoved > 0)
        // 数组copy移动
        System.arraycopy(elementData, index+1, elementData, index,
                         numMoved);
    elementData[--size] = null; // clear to let GC do its work

    return oldValue;
}

删除某个元素

public boolean remove(Object o) {
    if (o == null) {
        for (int index = 0; index < size; index++)
            if (elementData[index] == null) {
                fastRemove(index);
                return true;
            }
    } else {
        for (int index = 0; index < size; index++)
            if (o.equals(elementData[index])) {
                fastRemove(index);
                return true;
            }
    }
    return false;
}

找到被删除元素的下标，删除操作同指定下标的删除方法（数组copy），批量删除的方法也是如此

迭代

ArrayList继承自AbstractList，有个很重要的属性modCount，它表示数据结构被修改的次数
可以看到，只要是数据结构发生变化的时候，都会对应的变更modCount的值，如新增，删除，清除等方法
作用就是为了防止在迭代遍历的时候，其他线程对数据结构进行了修改
如果子类需要提供迭代时快速失败机制，就需要在数据结构性变化的方法记录modCount

private class Itr implements Iterator {
    int cursor;       // index of next element to return
    int lastRet = -1; // index of last element returned; -1 if no such
    // 记录modCount
    int expectedModCount = modCount;

    public boolean hasNext() {
        return cursor != size;
    }

    @SuppressWarnings("unchecked")
    public E next() {
        // 每次遍历前检查modCount
        checkForComodification();
        int i = cursor;
        if (i >= size)
            throw new NoSuchElementException();
        Object[] elementData = ArrayList.this.elementData;
        if (i >= elementData.length)
            throw new ConcurrentModificationException();
        cursor = i + 1;
        return (E) elementData[lastRet = i];
    }

    public void remove() {
        if (lastRet < 0)
            throw new IllegalStateException();
        // 遍历删除元素前，判断modCount
        checkForComodification();

        try {
            ArrayList.this.remove(lastRet);
            cursor = lastRet;
            lastRet = -1;
            // 更新modCount记录
            expectedModCount = modCount;
        } catch (IndexOutOfBoundsException ex) {
            throw new ConcurrentModificationException();
        }
    }

    @Override
    @SuppressWarnings("unchecked")
    public void forEachRemaining(Consumer consumer) {
        Objects.requireNonNull(consumer);
        final int size = ArrayList.this.size;
        int i = cursor;
        if (i >= size) {
            return;
        }
        final Object[] elementData = ArrayList.this.elementData;
        if (i >= elementData.length) {
            throw new ConcurrentModificationException();
        }
        while (i != size && modCount == expectedModCount) {
            consumer.accept((E) elementData[i++]);
        }
        // update once at end of iteration to reduce heap write traffic
        cursor = i;
        lastRet = i - 1;
        checkForComodification();
    }

    final void checkForComodification() {
        // modCount有变更，说明有其他线程对数组结构进行了修改，抛出异常
        if (modCount != expectedModCount)
            throw new ConcurrentModificationException();
    }
}    

总结

• ArrayList底层为动态数组
• 默认容量为10，在第一次添加元素时候会扩容到10
• 每次扩容会变为之前的1.5倍，会涉及到数组的拷贝
• 获取元素通过下标直接获取，速度快
• 在尾部进行元素的添加和删除效率较高，在中间添加和删除效率低，因为涉及到元素的移动
• 在大数据量的前提下，最好预估容量，初始化时候指定，避免扩容时进行的数组copy影响效率