Java集合之ArrayList

1. 简介

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

2. 继承体系

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

// 观察 RandomAccess 接口的代码，可以发现其接口内没有任何成员，其作用仅仅起到一个标识。
// 标识我们可以通过数组下标访问元素，而链表便没有这样的性质，只能通过遍历去访问指定元素
public interface RandomAccess {

}

3. 深入源码

3.1 属性

	// 序列化ID
	private static final long serialVersionUID = 8683452581122892189L;

    /**
     * 数组默认容量
     */
    private static final int DEFAULT_CAPACITY = 10;

    /**
     * 空数组
     * new ArrayList(0)时使用
     */
    private static final Object[] EMPTY_ELEMENTDATA = {};

    /**
     * 空数组，new ArrayList()时使用，添加第一个元素的时候会重新初始为默认容量大小
     */
    private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};

    /**
     * 保存要存储元素的数组
     */
    transient Object[] elementData; // non-private to simplify nested class access

    /**
     * 数组中存储的元素个数
     */
    private int size;

3.2 构造方法

3.2.1 ArrayList()

	public ArrayList() {
		// DEFAULTCAPACITY_EMPTY_ELEMENTDATA 
		// 数组是在添加第一个元素的时候会扩容到默认大小10
        this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;
	}

3.2.2 ArrayList(int initialCapacity)

    public ArrayList(int initialCapacity) {
    	 // 如果传入的初始容量大于0，就新建一个指定长度的数组存储元素
        if (initialCapacity > 0) {
            this.elementData = new Object[initialCapacity];
        } else if (initialCapacity == 0) {
        	// 如果传入的初始容量等于0，使用空数组EMPTY_ELEMENTDATA
            this.elementData = EMPTY_ELEMENTDATA;
        } else {
            throw new IllegalArgumentException("Illegal Capacity: "+
                                               initialCapacity);
        }
    }

       EMPTY_ELEMENTDATA 和 DEFAULTCAPACITY_EMPTY_ELEMENTDATA 都代表空数组，不同的是 DEFAULTCAPACITY_EMPTY_ELEMENTDATA 会在第一次添加元素时，将容量初始化为 10 。

3.2.3 ArrayList(Collection<? extends E> c)

    public ArrayList(Collection<? extends E> c) {
    	// 将 Collection 转为数组
        elementData = c.toArray();
        if ((size = elementData.length) != 0) {
            // 如果c.toArray()返回的是不是Object[]类型，重新拷贝成Object[].class类型
            if (elementData.getClass() != Object[].class)
                elementData = Arrays.copyOf(elementData, size, Object[].class);
        } else {
            // 如果c的空集合，则初始化为空数组EMPTY_ELEMENTDATA
            this.elementData = EMPTY_ELEMENTDATA;
        }
    }

3.3 添加元素

3.3.1 add(E e)

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

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

	private void ensureCapacityInternal(int minCapacity) {
    	// 如果是空数组DEFAULTCAPACITY_EMPTY_ELEMENTDATA,
    	// 则选择一个最大的值在默认值和minCapacity 保证当前数组可以装得下所有元素。
    	if (elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA) {
       	 minCapacity = Math.max(DEFAULT_CAPACITY, minCapacity);
    	}

    	ensureExplicitCapacity(minCapacity);
	}

	private void ensureExplicitCapacity(int minCapacity) {
		// 修改 modCount 的值，快速失败策略
        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);
   		 
    	// 如果新容量发现比需要的容量还小，则以需要的容量为准
   		if (newCapacity - minCapacity < 0)
      		  newCapacity = minCapacity;
      		  
    	// 如果新容量已经超过最大容量了，则使用最大容量
   		 if (newCapacity - MAX_ARRAY_SIZE > 0)
     		   newCapacity = hugeCapacity(minCapacity);
     		   
  		 //  将旧数组中的元素都拷贝到新数组中
   		 elementData = Arrays.copyOf(elementData, newCapacity);
	}

3.3.2 add(int index, E element)

    public void add(int index, E element) {
    	// 检查是否越界
        rangeCheckForAdd(index);

		// 检查是否需要扩容
        ensureCapacityInternal(size + 1);  // Increments modCount!!
        // 将 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));
    }

3.3.3 addAll(Collection<? extends E> c)

       将集合c中所有元素添加到当前ArrayList中

	public boolean addAll(Collection<? extends E> c) {
		// 将集合转为数组
        Object[] a = c.toArray();
        int numNew = a.length;
        // 检查是否需要扩容
        ensureCapacityInternal(size + numNew);  // Increments modCount
        // 将c中元素全部拷贝到数组的最后
        System.arraycopy(a, 0, elementData, size, numNew);
        size += numNew;
        return numNew != 0;
    }

3.4 获取元素

3.4.1 get(int index)

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

3.5 删除元素

3.5.1 remove(int index)

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

        modCount++;
        // 返回 index 位置元素
        E oldValue = elementData(index);

        int numMoved = size - index - 1;
        // 如果不是最后一个元素，则将 index 后面的元素向前移动一个位置
        if (numMoved > 0)
            System.arraycopy(elementData, index+1, elementData, index,
                             numMoved);
        // 置为 null，方便 GC                     
        elementData[--size] = null; // clear to let GC do its work

        return oldValue;
    }

3.5.2 remove(Object o)

    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;

		// 如果不是最后一个元素，则 index 后的元素向前移动一个位置
        if (numMoved > 0)
            System.arraycopy(elementData, index+1, elementData, index,
                             numMoved);
        elementData[--size] = null; // clear to let GC do its work
    }