【Java集合类源码分析】ArrayList源码分析

一、ArrayList简介

    ArrayList是基于动态数组实现的，其容量能够动态增长。

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

    ArrayList继承了AbstarctList抽象类，实现了List接口。
    ArrayList实现了RandomAccess接口，支持快速随机访问(通过下标序号进行快速访问)；实现了Cloneable接口，支持克隆；实现了Serializable接口，支持序列化，能够通过序列化传输。
    ArrayList非线程安全，在单线程环境下使用。在多线程环境下可以考虑选择Vector或者Collections.synchronizedList(List list)返回一个线程安全的ArrayList类或者concurrent并发包下的CopyOnWriteArrayList类。

二、ArrayList源码分析（JDK1.8）

public class ArrayList<E> extends AbstractList<E>        implements List<E>, RandomAccess, Cloneable, java.io.Serializable{    /**     * 默认初始容量     */    private static final int DEFAULT_CAPACITY = 10;    /**     * 用于空实例的共享空数组实例.     */    private static final Object[] EMPTY_ELEMENTDATA = {};    /**     * 用于默认大小的空实例的共享空数组实例。将其与EMPTY_ELEMENTDATA区分开来，以了解当添加第一个元素时会发生多少扩容。     */    private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};    /**     * ArrayList基于该数组实现，用该数组保存数据     * 当添加第一个元素时，任何具有elementData==DEFAULTCAPACITY_EMPTY_ELEMENTDATA的空ArrayList将被扩展为DEFAULT_CAPACITY     * 注意：transient关键字标记的成员变量不参与序列化过程。     * 因为该数组一般都是预留一些容量，等到容量不够时再进行扩容，那么就会出现冗余的情况，     * 如果这个时候进行序列化，整个数组都会被序列化，包括后面没有意义的空元素。     * ArrayList的writeObject方法会显式地为每个实际数组元素进行序列化，只序列化有用的元素。     */    transient Object[] elementData;      /**     * ArrayList中元素的数量     */    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);        }    }    /**     * 默认构造函数，构造一个初始容量为10的空列表     * 当添加第一个元素时，会扩容到10     */    public ArrayList() {        this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;    }    /**     * 构造一个包含指定元素集合的列表     */    public ArrayList(Collection<? extends E> c) {        elementData = c.toArray();        if ((size = elementData.length) != 0) {            if (elementData.getClass() != Object[].class)                elementData = Arrays.copyOf(elementData, size, Object[].class);        } else {            this.elementData = EMPTY_ELEMENTDATA;        }    }    /**     * 将当前容量值设为实际元素个数      * 由于elementData的长度会被拓展，size标记的是其中包含的元素的个数，所以会出现size很小但elementData.length很大的情况，     * 会出现空间的浪费。trimToSize将返回一个新的数组给elementData，元素内容保持不变，length和size相同，以节省空间。     */    public void trimToSize() {    //modCount用来实现fail-fast机制        modCount++;        if (size < elementData.length) {            elementData = (size == 0)              ? EMPTY_ELEMENTDATA              : Arrays.copyOf(elementData, size);        }    }    /**     * public方法，让用户手动设置ArrayList的容量     * 如果有必要，确保它至少可以容纳最小容量参数指定的元素数量     * @param   minCapacity 所需的最小容量     */    public void ensureCapacity(int minCapacity) {        int minExpand = (elementData != DEFAULTCAPACITY_EMPTY_ELEMENTDATA)            ? 0            : DEFAULT_CAPACITY;        if (minCapacity > minExpand) {            ensureExplicitCapacity(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++;        if (minCapacity - elementData.length > 0)            grow(minCapacity);    }    /**     * 数组可被分配的最大容量。当需要的数组尺寸超过VM的限制时，可能导致OutOfMemoryError     */    private static final int MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8;    /**     * 增加容量以确保它至少容纳最小容量参数指定的元素数量     * @param   minCapacity 所需的最小容量     */    private void grow(int minCapacity) {        int oldCapacity = elementData.length;        //新容量扩大到原容量的1.5倍（右移一位相关于原数值除以2）        int newCapacity = oldCapacity + (oldCapacity >> 1);        //新容量还是<所需容量，则新容量=所需容量        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) {        if (minCapacity < 0) // overflow            throw new OutOfMemoryError();        return (minCapacity > MAX_ARRAY_SIZE) ?            Integer.MAX_VALUE :            MAX_ARRAY_SIZE;    }    /**     * 返回此列表中的元素数量     */    public int size() {        return size;    }    /**     * 如果此列表不包含元素，则返回true     */    public boolean isEmpty() {        return size == 0;    }    /**     * 如果此列表包含指定的元素，则返回true     */    public boolean contains(Object o) {        return indexOf(o) >= 0;    }    /**     * 返回指定元素的第一次出现的索引     */    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;    }    /**     * 返回指定元素的最后一次出现的索引     */    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;    }    /**     * 返回此ArrayList实例的浅拷贝      */    public Object clone() {        try {            ArrayList<?> v = (ArrayList<?>) super.clone();            v.elementData = Arrays.copyOf(elementData, size);            v.modCount = 0;            return v;        } catch (CloneNotSupportedException e) {            throw new InternalError(e);        }    }    /**     * 返回一个包含此列表中所有元素的数组     */    public Object[] toArray() {        return Arrays.copyOf(elementData, size);    }    /**     * 返回一个包含此列表中所有元素的数组     * 若传入数组的长度小于size，返回一个新的数组，大小为size，类型与传入数组相同。     * 若传入数组长度与size相等，则将elementData复制到传入数组中并返回传入的数组。     * 若传入数组长度大于size，除了复制elementData外，还将把返回数组的第size个元素置为空。     */    @SuppressWarnings("unchecked")    public <T> T[] toArray(T[] a) {        if (a.length < size)            // Make a new array of a's runtime type, but my contents:            return (T[]) Arrays.copyOf(elementData, size, a.getClass());        System.arraycopy(elementData, 0, a, 0, size);        if (a.length > size)            a[size] = null;        return a;    }    /**     * 位置访问操作     */    @SuppressWarnings("unchecked")    E elementData(int index) {        return (E) elementData[index];    }    /**     * 返回此列表中指定位置的元素     */    public E get(int index) {        rangeCheck(index);        return elementData(index);    }    /**     * 用指定的元素替换此列表中指定位置的元素（并返回先前的元素）     */    public E set(int index, E element) {        rangeCheck(index);        E oldValue = elementData(index);        elementData[index] = element;        return oldValue;    }    /**     * 将指定的元素追加到此列表的末尾(需确保内部容量!)     */    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!!        //index开始的元素都向后移动一个位置        System.arraycopy(elementData, index, elementData, index + 1,                         size - index);        elementData[index] = element;        size++;    }    /**     * 删除该列表中指定位置的元素（并返回删除的元素）     */    public E remove(int index) {        rangeCheck(index);        modCount++;        E oldValue = elementData(index);        int numMoved = size - index - 1;        //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;    }    /**     * 从列表中删除第一个出现的指定元素（如果存在）      */    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;    }    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    }    /**     * 删除列表中所有元素，列表将会为空     * 把每个元素都置为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;    }    /**     * 将指定集合中的所有元素追加到此列表的末尾     */    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;    }    /**     * 从此列表中删除其索引在某范围之间的所有元素     */    protected void removeRange(int fromIndex, int toIndex) {        modCount++;        int numMoved = size - toIndex;        System.arraycopy(elementData, toIndex, elementData, fromIndex,                         numMoved);        // clear to let GC do its work        int newSize = size - (toIndex-fromIndex);        for (int i = newSize; i < size; i++) {            elementData[i] = null;        }        size = newSize;    }    /**     * 检查给定的索引是否在范围内      */    private void rangeCheck(int index) {        if (index >= size)            throw new IndexOutOfBoundsException(outOfBoundsMsg(index));    }    /**     * 由add和addAll使用的rangeCheck的版本     */    private void rangeCheckForAdd(int index) {        if (index > size || index < 0)            throw new IndexOutOfBoundsException(outOfBoundsMsg(index));    }    private String outOfBoundsMsg(int index) {        return "Index: "+index+", Size: "+size;    }    /**     * 从此列表中删除指定集合中包含的所有元素     */    public boolean removeAll(Collection<?> c) {        Objects.requireNonNull(c);        return batchRemove(c, false);    }    /**     * 仅保留此列表中包含在指定集合中的元素。     */    public boolean retainAll(Collection<?> c) {        Objects.requireNonNull(c);        return batchRemove(c, true);    }    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++)                if (c.contains(elementData[r]) == complement)                    elementData[w++] = elementData[r];        } finally {            // Preserve behavioral compatibility with AbstractCollection,            // even if c.contains() throws.            if (r != size) {                System.arraycopy(elementData, r,                                 elementData, w,                                 size - r);                w += size - r;            }            if (w != size) {                // clear to let GC do its work                for (int i = w; i < size; i++)                    elementData[i] = null;                modCount += size - w;                size = w;                modified = true;            }        }        return modified;    }    /**     * 将ArrayList实例的状态保存到流中（即序列化）     */    private void writeObject(java.io.ObjectOutputStream s)        throws java.io.IOException{        // Write out element count, and any hidden stuff        int expectedModCount = modCount;        s.defaultWriteObject();        // 写出ArrayList容量        s.writeInt(size);        // 按正确的顺序写出所有元素        for (int i=0; i<size; i++) {            s.writeObject(elementData[i]);        }        if (modCount != expectedModCount) {            throw new ConcurrentModificationException();        }    }    /**     * 从流中重构ArrayList实例（即反序列化）     */    private void readObject(java.io.ObjectInputStream s)        throws java.io.IOException, ClassNotFoundException {        elementData = EMPTY_ELEMENTDATA;        // Read in size, and any hidden stuff        s.defaultReadObject();        // 读取容量        s.readInt(); // ignored        if (size > 0) {            ensureCapacityInternal(size);            Object[] a = elementData;            // 按正确的顺序写出所有元素.            for (int i=0; i<size; i++) {                a[i] = s.readObject();            }        }    }}

三、ArrayList遍历方式

    1、通过迭代器Iterator遍历

Iterator iter = list.iterator();while (iter.hasNext()) {    System.out.println(iter.next());}

    2、通过迭代器ListIterator遍历

ListIterator lIter = list.listIterator();//顺向遍历while (lIter.hasNext()) {    System.out.println(lIter.next());}//逆向遍历while (lIter.hasPrevious()) {    System.out.println(lIter.previous());}

    3、随机访问，通过索引值遍历（由于实现了RandomAccess接口）

for (int i = 0; i < list.size; i++) {    System.out.println(list.get(i));  }

    4、foreach循环遍历

for (String str : list) {    System.out.println(str);  }

四、总结

    1、扩容机制：从add()与addAll()方法中可以看出，每当向数组中添加元素时，都要去检查添加元素后的数量是否会超出当前数组的长度，如果超出，数组将会进行扩容，以满足添加数据的需求。数组扩容实质上是通过私有的方法ensureCapacityInternal(int minCapacity) -> ensureExplicitCapacity(int minCapacity) -> grow(int minCapacity)来实现。当容量不足以容纳当前的元素个数时，就设置新容量为旧容量的1.5倍，如果设置后的新容量还不够，则直接将新容量设置为传入的参数(即所需容量)，而后使用Arrays.copyOf()方法将元素拷贝到新的数组中，这个过程在数据量大时比较耗时，所以建议初始化的时候指定容量的大小，以提高效率。
    2、ArrayList基于数组实现，可以通过下标索引直接查找到指定位置的元素，因此查找元素的效率高。但每次插入或删除元素，就要大量地移动元素，插入删除元素的效率低。
    3、在查找给定元素索引值、删除指定元素等方法中，源码都将该元素的值分为null和不为null两种情况处理，ArrayList中允许元素为null。
    4、Fail-Fast机制：ArrayList采用了快速失败的机制，通过记录modCount参数来实现。当多个线程对同一个集合的内容进行操作时，就可能会产生fail-fast事件。例如：当某一个线程A通过iterator去遍历某集合的过程中，若该集合的内容被其他线程所改变了；那么线程A访问集合时，就会抛出ConcurrentModificationException异常，产生fail-fast事件。
    5、Arrays.copyof()和System.arraycopy()：
首先看Arrays.copyof()方法：

/** * @param original 要拷贝的数组 * @param newLength 返回的副本数组的长度 */public static <T> T[] copyOf(T[] original, int newLength) {    return (T[]) copyOf(original,newLength,original.getClass());}public static <T,U> T[] copyOf(U[] original, int newLength, Class<? extends T[]> newType) {    T[] copy = ((Object)newType == (Object)Object[].class)        ? (T[]) new Object[newLength]        : (T[]) Array.newInstance(newType.getComponentType(), newLength);    System.arraycopy(original, 0, copy, 0,                     Math.min(original.length, newLength));    return copy;}

从源码中可以看出，该方法实际上在其内部又创建了一个长度为newLength的数组，并调用System.arraycopy()方法，将原数组中的元素拷贝到了新数组中。
接着看Arrays.copyof()方法：

public static native void arraycopy(Object src, int  srcPos, Object dest, int destPos, int length);

该方法被标记了native，调用了系统的C/C++代码。该函数实际上最终调用了C语言的memmove()函数，因此它可以保证同一个数组内元素的正确复制和移动，比一般的复制方法的实现效率要高很多，很适合用来批量处理数组。Java强烈推荐在复制大量数组元素时用该方法，以取得更高的效率。
    6、ArrayList是如何构造一个默认初始容量为10的空列表的：

/** * 构造一个默认初始容量为10的空列表(JDK1.8) * 1、初始情况：elementData=DEFAULTCAPACITY_EMPTY_ELEME={}；size=0 * 2、当向数组中添加第一个元素时，通过add(E e)方法中调用的ensureCapacityInternal(size + 1)方法，即ensureCapacityInternal(1) * 3、在ensureCapacityInternal(int minCapacity)方法中，可得到minCapacity=DEFAULT_CAPACITY=10， * 然后再调用ensureExplicitCapacity(minCapacity)方法，即ensureExplicitCapacity(10) * 4、在ensureExplicitCapacity(minCapacity)方法中调用grow(minCapacity)方法，即grow(10)， * 通过elementData = Arrays.copyOf(elementData, 10)具体实现了elementData数组初始容量为10的构造 */private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};public ArrayList() {    this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;}/** * 构造一个默认初始容量为10的空列表(JDK1.6) */public ArrayList(int initialCapacity) {    this.elementData = new Object[initialCapacity];}public ArrayList() {    //直接新建一个容量为10的数组    this(10);}