List接口下的集合源码分析——ArrayList

从本篇开始将对实现List接口的集合——ArrayList、LinkedList、Vector做一个源码分析。那么先从ArrayList开始吧。

一、ArrayList概述

在源码中对ArrayList是这么描述的：

• Arraylist是实现List接口的可调整大小的数组，拥有List接口的所有操作，可包含任何类型的元素，包括null值。这个类除了非同步的特性，大体上和Vector是相同的。
• 它的size、isEmpty、get、set方法运行时间为常数，而add方法运行开销为分摊的常数，添加n个元素的时间复杂度是O(n)。
• 每个ArrayList的实例都有自己的容量，这个容量即用于存储List元素的数组大小，它的大小要大于等于数组实际存储的元素数，当元素被添加到ArrayList时，它的容量会自动扩容。当需要添加大量的元素到ArrayList中，最好提前给ArrayList设置合适的初始容量，这样可以减少增量式的内存再分配次数。
• ArrayList的实现方式是非同步的(非线程安全的)，所以当多线程同时访问的时候，如果有线程从结构上做了修改(指任何添加或删除一个或多个元素的操作，或者显式调整底层数组的大小，仅仅设置元素的值不是结构上的修改)，需要在使用它的地方做同步控制。

二、ArrayList继承、实现关系

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

* 实现了RandomAccess接口，因此支持随机访问。
补充：RandomAccess接口，这是一个标记接口(Marker)，它没有任何方法，这个接口被List的实现类（子类）使用。RandomAccess接口的意义在于：在对列表进行随机或顺序访问的时候，访问算法能够选择性能最佳方式。
传送门：RandomAccess 接口使用
* 实现了Serializable接口。值得一提的是保存数组的元素是被transient修饰的，说明了声明数组默认不会被序列化，因为ArrayList具有动态扩容特性，每次在放满以后自动增长设定的长度值，如果数组自动增长长度设为100，而实际只放了一个元素，那就会序列化很多null元素。但是ArrayList中重写的writeObject()和readObject()来控制只序列化（反序列化）数组中元素填充的那部分内容。
传送门：ArrayList序列化技术细节详解

三、ArrayList属性声明及构造函数

private static final long serialVersionUID = 8683452581122892189L;
private static final int DEFAULT_CAPACITY = 10;
private static final Object[] EMPTY_ELEMENTDATA = {};
private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};
transient Object[] elementData; 
private int size;
protected transient int modCount = 0;

• DEFAULT_CAPACITY：默认初始容量为10。
• EMPTY_ELEMENTDATA：用于空实例的共享空数组。
• DEFAULTCAPACITY_EMPTY_ELEMENTDATA：用于默认大小的空实例的共享空数组实例。
  **区别：**DEFAULTCAPACITY_EMPTY_ELEMENTDATA与EMPTY_ELEMENTDATA一样都是用来初始化elementData的，不同的是，如果为无参构造函数，使用DEFAULTCAPACITY_EMPTY_ELEMENTDATA初始化空数组；如果为含参构造函数，使用EMPTY_ELEMENTDATA初始化空数组。
• elementData：存储ArrayList的元素的数组缓冲区。ArrayList的容量是该数组缓冲区的长度。当添加第一个元素时，任何具有elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA的空ArrayList都将扩展为DEFAULT_CAPACITY。
• size：ArrayList的大小(它包含的元素数量)。
• modCount：modCount从AbstractList继承而来，用于记录从结构上修改此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<? extends E> c) {
        elementData = c.toArray();//将集合c转化为数组
        if ((size = elementData.length) != 0) {
            // c.toArray might (incorrectly) not return Object[] (see 6260652)
            if (elementData.getClass() != Object[].class)//如果不是Object类型，使用Arrays类中的copyOf方法进行复制
                elementData = Arrays.copyOf(elementData, size, Object[].class);
        } else {
            // 如果c中没有元素，使用EMPTY_ELEMENTDATA初始化。
            this.elementData = EMPTY_ELEMENTDATA;
        }
    }
    }

特别提醒：
无参构造一个ArrayList的默认容量是DEFAULT_CAPACITY=10，但是，调用无参构造器初始化ArrayList时，数组elementData容量为0。只有当添加第一个元素时，数组elementData容量才会扩展为10。
还不明白的话，让我们看看ArrayList的public boolean add(E e)方法。

四、ArrayList的重点分析

—public boolean add(E e)

//将指定的元素追加到此列表的末尾
public boolean add(E e) {
        ensureCapacityInternal(size + 1);  // Increments modCount!!
        elementData[size++] = e;
        return true;
    }

—private void 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)

private void ensureExplicitCapacity(int minCapacity) {
        modCount++;
        // overflow-conscious code
        if (minCapacity - elementData.length > 0)//length是数组的长度，size是元素个数
            //扩容
            grow(minCapacity);
    }

—private void grow(int minCapacity)

//数组的最大大小。一些VM在数组中保留一些标题字。尝试分配较大的数组可能会导致OutOfMemoryError：请求的数组大小超过VM限制
private static final int MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8;

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

• 添加元素
  ——add方法调用ensureCapacityInternal(size+1)方法 ；
  ——判断elementData数组是否为空（使用无参构造器且没有元素）；
  ——若是，则所需最小容量minCapacity=10（此时ArrayList才初始为默认容量），若否，minCapacity=size+1（即在原有基础上+1）。
• 扩容
  第一步：真实容量和所需容量的比较，计算出ArrayList的最终容量
  ——ensureCapacityInternal(minCapacity)方法调用ensureExplicitCapacity(minCapacity)
  ——当所需最小容量大于当前elementData数组长度时，要进行扩容操作。
  第二步：扩容grow
  ——得到当前的ArrayList的容量(oldCapacity)；
  ——计算除扩容后的新容量(newCapacity)，其值(oldCapacity + (oldCapacity >> 1))约是oldCapacity 的1.5倍。（这里采用的是移位运算是出于效率考虑）；
  ——当newCapacity小于所需最小容量，那么将所需最小容量赋值给newCapacity；
  ——newCapacity大于ArrayList的所允许的最大容量，进行数据的复制，完成向ArrayList实例添加元素操作。

ArrayList其他方法概览

//返回此列表中的元素数
public int size() {
        return size;
    }
//如果此列表不包含元素,则返回true 
public boolean isEmpty() {
        return size == 0;
    }
//如果此列表包含指定的元素,则返回true 
public boolean contains(Object o) {
        return indexOf(o) >= 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 (int i = 0; i < size; i++)
                if (o.equals(elementData[i]))
                    return i;
        }
        return -1;
    }
    //返回此列表中指定元素的最后一次出现的索引,如果此列表不包含元素,则返回-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;
    }
//以正确的顺序返回包含此列表中所有元素的数组(从第一个元素到最后一个元素)
public Object[] toArray() {
        return Arrays.copyOf(elementData, size);
    }
//返回此列表中指定位置的元素
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 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++;
    }
    //删除此列表中指定位置的元素。将任何后续元素向左移(从它们的索引中减去一个)
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;
    }
    //从列表中删除指定元素的第一次出现(如果存在)。如果列表不包含元素,则不会更改
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;
    }
//从此列表中删除所有元素。此调用返回后,列表将为空
public void clear() {
        modCount++;
        // clear to let GC do its work
        for (int i = 0; i < size; i++)
            elementData[i] = null;
        size = 0;
    }

五、ArrayList三种遍历方式

• 使用RandomAccess方式
• 使用foreach
• 使用Iterator

Integer[] nums={2,1,3,6,0,4,5,8,7,9};
List<Integer> list=new ArrayList<>();  
list=Arrays.asList(nums); 
    //使用RandomAccess方式：
    for(int i=0;i<list.size();i++)  
    {  
        System.out.print((int)list.get(i));  
    }  
    //使用foreach：  
    for (Integer integer : list) {  
        System.out.print(integer);  
    }  
    //使用Iterator：  
    Iterator<Integer> it=list.iterator();  
    while(it.hasNext())  
    {  
        System.out.print((int)it.next());  
    }  

结果：
2136045879
2136045879
2136045879

六、小结

• ArrayList是实现了基于动态数组的数据结构。
• ArrayList在每次增加元素时，都要进行扩容判断，扩容时都要确保足够的容量。当容量不足以容纳当前的元素个数时，就设置新的容量为旧的容量的1.5倍，如果新容量还不够，则新容量设置为传入的参数，如果新容量还不够，则新容量为最大容量。从中可以看出，当容量不够时，都要将原来的元素拷贝到一个新的数组中，耗时而且还需要重新分配内存，因此建议在事先能确定元素数量的情况下，明确指明容量大小。
• ArrayList基于数组实现，可以通过下标索引直接查找到指定位置的元素，因此查找效率高，但每次插入或删除元素，就要大量地移动元素，效率低。

若有不足或不对之处，望诸位不吝指出。
参考：
源码阅读之ArrayList
揭秘｜java 中ArrayList的1.5倍扩容