ArrayList源码解析

简介

ArrayList 是一种以数组实现的 List，与数组相比，它具有动态扩展的能力，因此也可称之为动态数组。

ArrayList 线程不安全，除该类未实现同步外，其余跟 Vector 大致相同。

Java 泛型只是编译器提供的语法糖，所以这里的数组是一个 Object 数组，以便能够容纳任何类型的对象。

继承体系

• ArrayList 实现了 List，RandomAccess，Cloneable，java.io.Serializable 等接口。
• ArrayList 实现了 List，提供了基础的添加、删除、遍历等操作。
• ArrayList 实现了 RandomAccess，提供了随机访问的能力。
• ArrayList 实现了 Cloneable，可以被克隆。
• ArrayList 实现了 Serializable，可以被序列化。

源码解析

属性

    /*
     * 默认容量为10，也就是通过new ArrayList()创建时的默认容量
     */
    private static final int DEFAULT_CAPACITY = 10;

    /*
     * 空数组，如果传入的容量为0时使用（这种是通过new ArrayList(0)创建时用的是这个空数组）
     */
    private static final Object[] EMPTY_ELEMENTDATA = {};

    /*
     * 空数组，这种是通过new ArrayList()创建时用的是这个空数组
     * 与EMPTY_ELEMENTDATA的区别是在添加第一个元素时使用这个空数组的会初始化为DEFAULT_CAPACITY(10)个元素。
     */
    private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};

    /*
     * 存储元素的数组
     * 真正存放元素的地方，使用transient是为了不序列化这个字段。
     * 至于没有使用private修饰，后面注释是写的“为了简化嵌套类的访问”，但是楼主实测加了private 嵌套类一样可以访问。
     * private表示是类私有的属性，只要是在这个类内部都可以访问，嵌套类或者内部类也是在类的内部，所以也可以访问类的私有成员。
     */
    transient Object[] elementData; // non-private to simplify nested class access

    /*
     * 集合中真正元素的个数（并不是集合大小）
     */
    private int size;

	// 最长数组大小 INF - 8
    private static final int MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8;

构造方法

// ----------------------------传入初始容量构造器-------------------------------
	/*
   	 * 传入初始容量
   	 * 1.initialCapacity > 0 构造一个数组初始容量为initialCapacity
   	 * 2.initialCapacity = 0 则使用空数组EMPTY_ELEMENTDATA
   	 * 3.initialCapacity < 0 抛出异常
   	 */
	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() {
        // 如果没有传入初始容量，则使用空数组DEFAULTCAPACITY_EMPTY_ELEMENTDATA
    	// 使用这个数组是在添加第一个元素的时候会扩容到默认大小10
        this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;
    }

// ---------------------------传入一个Collection构造器-------------------------
    /**
    * 把传入集合的元素初始化到ArrayList中
    */
    public ArrayList(Collection<? extends E> c) {
        // 集合转数组
        elementData = c.toArray();
        if ((size = elementData.length) != 0) {
            // 检查c.toArray()返回的是不是Object[]类型，如果不是，重新拷贝成Object[].class类型
            if (elementData.getClass() != Object[].class)
                /*
                 * Arrays.copyOf(原数组，新数组长度，新数组类型)
                 * 返回一个新数组。
                 */
                elementData = Arrays.copyOf(elementData, size, Object[].class);
        } else {
            // 如果c是空集合，则初始化为空数组EMPTY_ELEMENTDATA
            this.elementData = EMPTY_ELEMENTDATA;
        }
    }

为什么 c.toArray(); 返回的有可能不是 Object[] 类型呢？请看下面的代码：

public class ArrayTest {
    public static void main(String[] args) {
        Father[] fathers = new Son[]{};
        // 打印结果为class [Lcom.coolcoding.code.Son;
        System.out.println(fathers.getClass());

        List<String> strList = new MyList();
        // 打印结果为class [Ljava.lang.String;
        System.out.println(strList.toArray().getClass());
    }
}

class Father {}

class Son extends Father {}

class MyList extends ArrayList<String> {
    /**
     * 子类重写父类的方法，返回值可以不一样
     * 但这里只能用数组类型，换成Object就不行
     * 应该算是java本身的bug
     */
    @Override
    public String[] toArray() {
        // 为了方便举例直接写死
        return new String[]{"1", "2", "3"};
    }
}

add(E e)

• 添加元素到末尾，平均时间复杂度为 $O(1)$。

    public boolean add(E e) {
        // 检查是否需要扩容
        ensureCapacityInternal(size + 1);
        // 把元素插入到最后一位
        elementData[size++] = e;
        return true;
    }

    private void ensureCapacityInternal(int minCapacity) {
        ensureExplicitCapacity(calculateCapacity(elementData, minCapacity));
    }

	/*
	 * 此方法主要就是为了处理elementData懒加载 第一次add()时返回初始容量10，
	 * 然后会初始化一个长度为10的数组。
	 */
    private static int calculateCapacity(Object[] elementData, int minCapacity) {
        // 如果是空数组DEFAULTCAPACITY_EMPTY_ELEMENTDATA，就初始化为默认大小10
        if (elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA) {
            // 这里一般都会返回DEFAULT_CAPACITY = 10
            return Math.max(DEFAULT_CAPACITY, minCapacity);
        }
        // (除了第一次add时elementData未初始化)这里都会返回size + 1
        return minCapacity;
    }

	/*
	 * @param minCapacity
	 *        1.可能等于10（当前elementData还未初始化，经过计算后赋值为10(初始容量)）
	 *        2.size + 1（调用add()）
	 *        3.size + c.length（调用addAll()）
	 */
    private void ensureExplicitCapacity(int minCapacity) {
        // modCount++ 此属性为了判断并发下的add()异常
        modCount++;

        // 判断size + 1 > 数组的长度，说明需要进行扩容(或者是一次初始化操作)
        if (minCapacity - elementData.length > 0)
            // 扩容
            grow(minCapacity);
    }

    private void grow(int minCapacity) {
        // 当前数组长度
        int oldCapacity = elementData.length;
        // 新容量为旧容量的1.5倍
        int newCapacity = oldCapacity + (oldCapacity >> 1);
        // 如果新容量发现比需要的容量还小，则以需要的容量为准
        // 这个条件成立一般是调用了addAll()方法
        if (newCapacity - minCapacity < 0)
            newCapacity = minCapacity;
        // 如果新容量已经超过最大容量了，则使用最大容量
        if (newCapacity - MAX_ARRAY_SIZE > 0)
            newCapacity = hugeCapacity(minCapacity);
        // 以新容量拷贝出来一个新数组
        elementData = Arrays.copyOf(elementData, newCapacity);
    }

	private static int hugeCapacity(int minCapacity) {
        // 溢出(超出了int最大值)，抛异常
        if (minCapacity < 0) // overflow
            throw new OutOfMemoryError();
        // 大于INF - 8 那么直接赋INF，否则赋 INF - 8;
        return (minCapacity > MAX_ARRAY_SIZE) ?
            Integer.MAX_VALUE :
            MAX_ARRAY_SIZE;
    }

总结

• 使用默认的无参构造器时，不会初始化底层的数组 (elementData)，当第一次添加数据时才会创建初始化数组，默认的初始容量为10。

（1）检查是否需要扩容；

（2）如果 elementData 等于 DEFAULTCAPACITY_EMPTY_ELEMENTDATA 则初始化容量大小为 DEFAULT_CAPACITY；

（3）新容量是老容量的 1.5 倍（oldCapacity + (oldCapacity >> 1)），如果加了这么多容量发现比需要的容量还小，则以需要的容量为准；

（4）创建新容量的数组并把老数组拷贝到新数组；

add(int index, E element)

• 添加元素到指定位置，原位置及后面的元素后移，平均时间复杂度为 $O(n)$。

    public void add(int index, E element) {
        // 检查是否越界
        rangeCheckForAdd(index);
        // 检查是否需要扩容
        ensureCapacityInternal(size + 1);
        // 将index及其之后的元素往后挪一位，则index位置处就空出来了
        System.arraycopy(elementData, index, elementData, index + 1,
                         size - index);
        // 将元素插入到index的位置
        elementData[index] = element;
        // 大小增1
        size++;
    }

    private void rangeCheckForAdd(int index) {
        if (index > size || index < 0)
            throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
    }

（1）检查索引是否越界；

（2）检查是否需要扩容；

（3）把插入索引位置后的元素都往后挪一位；

（4）在插入索引位置放置插入的元素；

（5）大小加 1；

3分钟了解Java中System.arraycopy的用法

addAll(Collection<? extends E> c)

• 求两个集合的并集。

    /**
     * 将集合c中所有元素添加到当前ArrayList中
     */
    public boolean addAll(Collection<? extends E> c) {
        // 将集合c转为数组
        Object[] a = c.toArray();
        int numNew = a.length;
        // 检查是否需要扩容
        ensureCapacityInternal(size + numNew);
        // 将c中元素全部拷贝到数组的最后
        System.arraycopy(a, 0, elementData, size, numNew);
        // 大小增加c的大小
        size += numNew;
        // 如果c不为空就返回true，否则返回false
        return numNew != 0;
    }

（1）拷贝 c 中的元素到数组 a 中；

（2）检查是否需要扩容；

（3）把数组 a 中的元素拷贝到 elementData 的尾部；

set(int index, E element)

    public E set(int index, E element) {
        // 检查index是否合法
        rangeCheck(index);
		// 获取index位置的元素
        E oldValue = elementData(index);
        // 替换
        elementData[index] = element;
        // 将原值返回
        return oldValue;
    }

get(int index)

• 获取指定索引位置的元素，时间复杂度为 $O(1)$。

    public E get(int index) {
        // 检查是否越界
        rangeCheck(index);
        // 返回数组index位置的元素
        return elementData(index);
    }

    private void rangeCheck(int index) {
        if (index >= size)
            throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
    }

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

（1）检查索引是否越界，这里只检查是否越上界，如果越上界抛出 IndexOutOfBoundsException 异常，如果越下界抛出的是 ArrayIndexOutOfBoundsException 异常。

（2）返回索引位置处的元素；

remove(int index)

• 删除指定索引位置的元素，时间复杂度为 $O(n)$。

    public E remove(int index) {
        // 检查是否越界
        rangeCheck(index);

        modCount++;
        // 获取index位置的元素
        E oldValue = elementData(index);

        // 如果index不是最后一位，则将index之后的元素往前挪一位
        int numMoved = size - index - 1;
        if (numMoved > 0)
            /*
             * 复制从index + 1位置的元素numMoved个，到从index位置开始的后面，即将index位置的元素干掉。
             * (将index + 1位置的元素往前移动一位)
             */
            System.arraycopy(elementData, index+1, elementData, index, numMoved);

        // 经过上面的操作，最后一个位置的元素已经没用了，将最后一个元素删除 help GC
        elementData[--size] = null; // clear to let GC do its work

        // 返回旧值
        return oldValue;
    }

（1）检查索引是否越界；

（2）获取指定索引位置的元素；

（3）如果删除的不是最后一位，则其它元素往前移一位；

（4）将最后一位置为 null，方便 GC 回收；

（5）返回删除的元素。

可以看到，ArrayList 删除元素的时候并没有缩容。

remove(Object o)

• 删除指定元素值的元素，时间复杂度为 $O(n)$。

    public boolean remove(Object o) {
        if (o == null) {
            // 遍历整个数组，找到元素第一次出现的位置，并将其快速删除
            for (int index = 0; index < size; index++)
                // 如果要删除的元素为null，则以null进行比较，使用==
                if (elementData[index] == null) {
                    fastRemove(index);
                    return true;
                }
        } else {
            // 遍历整个数组，找到元素第一次出现的位置，并将其快速删除
            for (int index = 0; index < size; index++)
                // 如果要删除的元素不为null，则进行比较，使用equals()方法
                if (o.equals(elementData[index])) {
                    fastRemove(index);
                    return true;
                }
        }
        return false;
    }

    private void fastRemove(int index) {
        // 少了一个越界的检查
        modCount++;
        // 如果index不是最后一位，则将index之后的元素往前挪一位
        int numMoved = size - index - 1;
        if (numMoved > 0)
            System.arraycopy(elementData, index+1, elementData, index, numMoved);
        // 将最后一个元素删除 help GC
        elementData[--size] = null; // clear to let GC do its work
    }

（1）找到第一个等于指定元素值的元素；

（2）快速删除；

fastRemove(int index) 相对于 remove(int index) 少了检查索引越界的操作，可见 jdk 将性能优化到极致。

retainAll(Collection<?> c)

• 求两个集合的交集。

    public boolean retainAll(Collection<?> c) {
        // 集合c不能为null 如果为null则抛出空指针异常
        Objects.requireNonNull(c);
        // 调用批量删除方法，这时complement传入true，表示删除不包含在c中的元素
        return batchRemove(c, true);
    }

    /**
    * 批量删除元素
    * complement为true表示删除c中不包含的元素
    * complement为false表示删除c中包含的元素
    */
    private boolean batchRemove(Collection<?> c, boolean complement) {
        final Object[] elementData = this.elementData;
        // 使用读写两个指针同时遍历数组
        // 读指针每次自增1，写指针放入元素的时候才加1
        // 这样不需要额外的空间，只需要在原有的数组上操作就可以了
        int r = 0, w = 0;
        boolean modified = false;
        try {
            // 遍历整个数组，如果c中包含该元素，则把该元素放到写指针的位置（以complement为准）
            for (; r < size; r++)
                if (c.contains(elementData[r]) == complement)
                    elementData[w++] = elementData[r];
        } finally {
            // 正常来说r最后是等于size的，除非c.contains()抛出了异常
            if (r != size) {
                // 如果c.contains()抛出了异常，则把未读的元素都拷贝到写指针之后
                System.arraycopy(elementData, r,
                                 elementData, w,
                                 size - r);
                w += size - r;
            }
            if (w != size) {
                // 将写指针之后的元素置为空 help GC
                for (int i = w; i < size; i++)
                    elementData[i] = null;
                modCount += size - w;
                // 新大小等于写指针的位置（因为每写一次写指针就加1，所以新大小正好等于写指针的位置）
                size = w;
                modified = true;
            }
        }
        // 有修改返回true
        return modified;
    }

（1）遍历 elementData 数组；

（2）如果元素在 c 中，则把这个元素添加到 elementData 数组的 w 位置并将 w 位置往后移一位；

（3）遍历完之后，w 之前的元素都是两者共有的，w 之后（包含）的元素不是两者共有的；

（4）将 w 之后（包含）的元素置为 null，方便 GC 回收；

removeAll(Collection<?> c)

• 求两个集合的单方向差集，只保留当前集合中不在 c 中的元素，不保留在 c 中不在当前集体中的元素。

    public boolean removeAll(Collection<?> c) {
        // 集合c不能为空 如果为null则抛出空指针异常
        Objects.requireNonNull(c);
        // 同样调用批量删除方法，这时complement传入false，表示删除包含在c中的元素
        return batchRemove(c, false);
    }

与 retainAll(Collection<?> c) 方法类似，只是这里保留的是不在 c 中的元素。

contains(Object o)

• 判断集合中是否包含某一元素。

    /*
     * 是否包含某一元素
     * true -> 包含 | false -> 不包含
     */
	public boolean contains(Object o) {
        return indexOf(o) >= 0;
    }

	/*
	 * 返回值 >= 0 表示查找成功，并且返回值表示的是查找成功元素的索引
	 *       = -1 表示查找失败。
	 */		
    public int indexOf(Object o) {
        if (o == null) {
            for (int i = 0; i < size; i++)
                if (elementData[i]==null)
                    return i;
        } else {
            // for循环遍历查找
            for (int i = 0; i < size; i++)
                if (o.equals(elementData[i]))
                    // 查找成功，返回索引
                    return i;
        }
        // 查找失败返回-1
        return -1;
    }

toArray(T[] a)

• 将集合转为指定类型的数组，这个指定类型只能是集合的泛型，否则会抛出异常。

    @SuppressWarnings("unchecked")
    public <T> T[] toArray(T[] a) {
        if (a.length < size)
            return (T[]) Arrays.copyOf(elementData, size, a.getClass());
        // a.length > size 将集合中的数据全部复制到数组中，从0开始
        System.arraycopy(elementData, 0, a, 0, size);
        if (a.length > size)
            a[size] = null;
        return a;
    }

使用示例

import java.util.ArrayList;

public class Test {
    public static void main(String[] args) {
        ArrayList<Integer> list = new ArrayList<>();
        for (int i = 1; i <= 5; i++) list.add(i);
        // 转成一个数组 注意类型必须是集合的泛型
        Integer[] array = list.toArray(new Integer[]{});
        for (int a : array) {
            System.out.println(a);
        }
    }
}

总结

（1）ArrayList 内部使用数组存储元素，当数组长度不够时进行扩容，每次加一半的空间，ArrayList 不会进行缩容；

（2）ArrayList 支持随机访问，通过索引访问元素极快，时间复杂度为 $O(1)$；

（3）ArrayList 添加元素到尾部极快，平均时间复杂度为 $O(1)$；

（4）ArrayList 添加元素到中间比较慢，因为要搬移元素，平均时间复杂度为 $O(n)$；

（5）ArrayList 从尾部删除元素极快，时间复杂度为 $O(1)$；

（6）ArrayList 从中间删除元素比较慢，因为要搬移元素，平均时间复杂度为 $O(n)$；

（7）ArrayList 支持求并集，调用 addAll(Collection<? extends E> c) 方法即可；

（8）ArrayList 支持求交集，调用 retainAll(Collection<? extends E> c) 方法即可；

（7）ArrayList 支持求单向差集，调用 removeAll(Collection<? extends E> c) 方法即可；

彩蛋

elementData 设置成了 transient，那 ArrayList 是怎么把元素序列化的呢？

    private void writeObject(java.io.ObjectOutputStream s)
            throws java.io.IOException{
        // 防止序列化期间有修改
        int expectedModCount = modCount;
        // 写出非transient非static属性（会写出size属性）
        s.defaultWriteObject();

        // 写出元素个数
        s.writeInt(size);

        // 依次写出元素
        for (int i=0; i<size; i++) {
            s.writeObject(elementData[i]);
        }

        // 如果有修改，抛出异常
        if (modCount != expectedModCount) {
            throw new ConcurrentModificationException();
        }
    }

    private void readObject(java.io.ObjectInputStream s)
            throws java.io.IOException, ClassNotFoundException {
        // 声明为空数组
        elementData = EMPTY_ELEMENTDATA;

        // 读入非transient非static属性（会读取size属性）
        s.defaultReadObject();

        // 读入元素个数，没什么用，只是因为写出的时候写了size属性，读的时候也要按顺序来读
        s.readInt();

        if (size > 0) {
            // 计算容量
            int capacity = calculateCapacity(elementData, size);
            SharedSecrets.getJavaOISAccess().checkArray(s, Object[].class, capacity);
            // 检查是否需要扩容
            ensureCapacityInternal(size);

            Object[] a = elementData;
            // 依次读取元素到数组中
            for (int i=0; i<size; i++) {
                a[i] = s.readObject();
            }
        }
    }

查看 writeObject() 方法可知，先调用 s.defaultWriteObject() 方法，再把 size 写入到流中，再把元素一个一个的写入到流中。

一般地，只要实现了 Serializable 接口即可自动序列化，writeObject() 和 readObject() 是为了自己控制序列化的方式，这两个方法必须声明为 private，在 java.io.ObjectStreamClass#getPrivateMethod() 方法中通过反射获取到 writeObject() 这个方法。

在 ArrayList 的 writeObject() 方法中先调用了 s.defaultWriteObject() 方法，这个方法是写入非 static 非 transient 的属性，在 ArrayList 中也就是 size 属性。同样地，在 readObject() 方法中先调用了 s.defaultReadObject() 方法解析出了 size 属性。

elementData 定义为 transient 的优势：自己根据 size 序列化真实的元素，而不是根据数组的长度序列化元素，减少了空间占用。

Fail-Fast 机制

ArrayList 也采用了快速失败的机制，通过记录 modCount 参数来实现。在面对并发的修改时，迭代器很快就会完全失败，而不是冒着在将来某个不确定时间发生任意不确定行为的风险。

---

参考文章

• 彤哥读源码_死磕 java集合之ArrayList源码分析
• shstart7_ArrayList源码解析
• Java 全栈知识体系_Collection - ArrayList 源码解析