一周一源码之ArrayList源码解析

前言

准备开始我的一周一源码系列了！保证每周至少阅读一部分jdk或者开源框架的源码，督促自己，可以稳定的积累基础，也记录一下学习的过程。因为是刚开始，所以就从比较常见而且简单的集合类入手吧！

ArrayList简介

ArrayList实际上是个可扩容的数组。继承了AbstractList抽象类，实现了List接口，提供添加、删除、修改、遍历等功能。

源码分析

JDK1.8中，ArrayList类的源码有1400余行，在这里不会对诸多的方法一一详细介绍，只针对核心、常用的代码分为几个部分来解析，以探究ArrayList的实现与特性。

继承实现关系

核心成员变量

elementData

ArrayList的本质是数组，因此，该类中最重要的数据结构，当属elementData了。

transient Object[] elementData;

我们对ArrayList中的元素进行添加、修改、删除的操作，实质上都是对数组elementData进行操作。

size

private int size;

size是ArrayList的大小，也就是存储元素的个数。然而这个大小与elementData的长度并不同。我们每次添加元素时，都要根据size与elementData的长度比较来判断是否要对ArrayList扩容。而常见的下标越界异常也是根据与size做比较来判断是否越界。

其他成员变量

// ArrayList的默认初始化大小。
private static final int DEFAULT_CAPACITY = 10;
// ArrayList的最大长度
private static final int MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8;
// 初始化空数组，虽然两个都是空数组，但是用途不同，具体差别会在构造方法处分析
private static final Object[] EMPTY_ELEMENTDATA = {};
private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};

三个构造方法

ArrayList有三个构造方法，对list进行初始化操作。
无参的构造方法，会直接把elementData初始化为默认的空数组：

private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};

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

参数为Collection的构造方法，会将接受到的Collection转为数组。如果数组长度不为0则将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;
    }
}

参数为int的构造方法，则会将elementData初始化为对应长度的数组：

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

这里会发现，在使用无参构造方法实例化ArrayList时，会将elementData初始化为DEFAULTCAPACITY_EMPTY_ELEMENTDATA，但是传参为Collection和初始容量的构造方法会在collection长度为0或者初始容量为0时将elementData初始化为EMPTY_ELEMENTDATA。这里引用jdk中声明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.

我们可以这样理解：DEFAULTCAPACITY_EMPTY_ELEMENTDATA是在ArrayList给我们创建的默认大小为0的数组。而EMPTY_ELEMENTDATA是我们告诉ArrayList我们要创建一个大小为0的数组。虽然都是空数组，但是DEFAULTCAPACITY_EMPTY_ELEMENTDATA会在后面的扩容时用到。

添加元素与扩容

只要是添加元素，则会改变size的大小，保证size值为元素的数量。

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

将元素添加到指定下标。其中rangeCheckForAdd方法会对传入的下标是否越界进行判断并根据情况抛出异常。之后使用System.arraycopy对数组进行复制，相当于把index后面部分的元素整体向后移动一位，并将传入的元素放到数组index的位置。
这里来看看重点的扩容相关的方法ensureCapacityInternal：

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

        ensureExplicitCapacity(minCapacity);
    }

首先考虑当前的ArrayList是不是一个被用户初始化过的空数组，如果是，则选取DEFAULT_CAPACITY与加入一个元素后容量大小中最大的数值，作为可接受的最小容量。
之后调用ensureExplicitCapacity方法判断是否需要扩容：

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

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

首先对modCount进行自增操作。凡是涉及到容量大小变化的操作，都会对modCount进行自增以记录。之后判断最小容量minCapacity与当前内部数组elementData的长度，如果大于当前数组的长度，则用grow方法扩容到minCapacity的大小，以确保能够存放新加入的元素：

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

这部分的逻辑我们可以看到，ArrayList扩容时是默认扩容为原来数组大小的1.5倍，如果不够，则扩容为minCapacity。这里还会判断一下扩容大小是否会超过ArrayList的最大容量，之后返回integer的最大值或者是ArrayList的最大值。（这里有个疑虑，如果容量真的不够大了，会出现什么情况呢？）

addAll

其实与两个add方法类似，只不过追加的不是一个元素，而是一个集合，将集合转换成数组按照相似逻辑追加到ArrayList末尾即可。

    public boolean addAll(Collection<? extends E> c) {
        Object[] a = c.toArray();
        int numNew = a.length;
        ensureCapacityInternal(size + numNew);  // Increments modCount
        System.arraycopy(a, 0, elementData, size, numNew);
        size += numNew;
        return numNew != 0;
    }
        public boolean addAll(int index, Collection<? extends E> c) {
        rangeCheckForAdd(index);

        Object[] a = c.toArray();
        int numNew = a.length;
        ensureCapacityInternal(size + numNew);  // Increments modCount

        int numMoved = size - index;
        if (numMoved > 0)
            System.arraycopy(elementData, index, elementData, index + numNew,
                             numMoved);

        System.arraycopy(a, 0, elementData, index, numNew);
        size += numNew;
        return numNew != 0;
    }

修改

通过使用set方法，将对应下标的元素替换成新的元素:

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

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

取值

我将需要从ArrayList中获取元素的方法归结为取值一类。

indexOf

实际上就是通过循环将传入元素与数组中的元素对比判断是否相同，并返回下标：

    public int indexOf(Object o) {
        if (o == null) {
            for (int i = 0; i < size; i++)
                if (elementData[i]==null)
                    return i;
        } else {
            for (int i = 0; i < size; i++)
                if (o.equals(elementData[i]))
                    return i;
        }
        return -1;
    }

lastIndexOf

实际上就是通过倒循环将传入元素与数组中的元素对比判断是否相同，并返回下标：

    public int lastIndexOf(Object o) {
        if (o == null) {
            for (int i = size-1; i >= 0; i--)
                if (elementData[i]==null)
                    return i;
        } else {
            for (int i = size-1; i >= 0; i--)
                if (o.equals(elementData[i]))
                    return i;
        }
        return -1;
    }

contains

通过indexOf方法来确认元素是否在数组中，如果不在数组中就肯定是要遍历整个数组了。

    public boolean contains(Object o) {
        return indexOf(o) >= 0;
    }

get

先判断传入的下标是否合法，然后直接取数组里对应的元素。

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

        return elementData(index);
    }

isEmpty

判断size是否为0。

    public boolean isEmpty() {
        return size == 0;
    }

移除元素

clear

清空ArrayList，实际上是循环将数组中的对象置为null，并将size置为0.

    public void clear() {
        modCount++;

        // clear to let GC do its work
        for (int i = 0; i < size; i++)
            elementData[i] = null;

        size = 0;
    }

remove

移除处于某下标的元素：

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

        modCount++;
        E oldValue = elementData(index);

        int numMoved = size - index - 1;
        if (numMoved > 0)
            System.arraycopy(elementData, index+1, elementData, index,
                             numMoved);
        elementData[--size] = null; // clear to let GC do its work

        return oldValue;
    }

使用System.arraycopy方法将传入下标的后面的元素整体前移一位，然后将最后一位置为null，并修改size的大小，返回这个对象。
移除某个对象：

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

先找到这个对象在数组中的位置，然后调用fastRemove方法移除：

    private void fastRemove(int index) {
        modCount++;
        int numMoved = size - index - 1;
        if (numMoved > 0)
            System.arraycopy(elementData, index+1, elementData, index,
                             numMoved);
        elementData[--size] = null; // clear to let GC do its work
    }

逻辑与前一个remove方法的逻辑一致。

removeAll

逻辑与remvoe相似，不再赘述。

转数组

    public Object[] toArray() {
        return Arrays.copyOf(elementData, size);
    }

内部类

Itr类

实现Iterator接口，提供迭代器功能。

private class Itr implements Iterator<E> {
    // 下一个元素的下标
    int cursor;
    // 最后一个元素的下标，-1为无
    int lastRet = -1; 
    // 
    int expectedModCount = modCount;

    // 下一个元素的下标如果为当前ArrayList大小，则无下一个元素
    public boolean hasNext() {
        return cursor != size;
    }

    // 校验后返回下一个元素，修改cursor和lastRet值
    @SuppressWarnings("unchecked")
    public E next() {
        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];
    }

    // 调用remove方法删除元素，并修改cursor值为lastRet的值
    public void remove() {
        if (lastRet < 0)
            throw new IllegalStateException();
        checkForComodification();

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

    @Override
    @SuppressWarnings("unchecked")
    public void forEachRemaining(Consumer<? super E> 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() {
        if (modCount != expectedModCount)
            throw new ConcurrentModificationException();
    }
}

ListItr类

继承了Itr类，实现了ListIterator接口。可以逆向遍历，也可以添加元素。
参考文章：JAVA中ListIterator和Iterator详解与辨析

private class ListItr extends Itr implements ListIterator<E> {
    ListItr(int index) {
        super();
        cursor = index;
    }
    // 判断是否有前一个元素
    public boolean hasPrevious() {
        return cursor != 0;
    }

    // 获取下一个元素下标
    public int nextIndex() {
        return cursor;
    }
    // 获取前一个元素下标
    public int previousIndex() {
        return cursor - 1;
    }
    // 返回前一个元素
    @SuppressWarnings("unchecked")
    public E previous() {
        checkForComodification();
        int i = cursor - 1;
        if (i < 0)
            throw new NoSuchElementException();
        Object[] elementData = ArrayList.this.elementData;
        if (i >= elementData.length)
            throw new ConcurrentModificationException();
        cursor = i;
        return (E) elementData[lastRet = i];
    }
    // 重置元素
    public void set(E e) {
        if (lastRet < 0)
            throw new IllegalStateException();
        checkForComodification();

        try {
            ArrayList.this.set(lastRet, e);
        } catch (IndexOutOfBoundsException ex) {
            throw new ConcurrentModificationException();
        }
    }
    // 添加元素
    public void add(E e) {
        checkForComodification();

        try {
            int i = cursor;
            ArrayList.this.add(i, e);
            cursor = i + 1;
            lastRet = -1;
            expectedModCount = modCount;
        } catch (IndexOutOfBoundsException ex) {
            throw new ConcurrentModificationException();
        }
    }
}

SubList类

支持ArrayList中的subList方法，返回截取的一部分list。

静态成员类ArrayListSpliterator

实现了Spliterator接口，支持并行遍历。
参考文章：Java8里面的java.util.Spliterator接口有什么用？