ArrayList

一、ArrayList简介

ArrayList是可以动态增长和缩减的索引序列，它是基于数组实现的List类。

该类封装了一个动态再分配的Object[]数组，每一个类对象都有一个capacity属性，表示它们所封装的Object[]数组的长度，当向ArrayList中添加元素时，该属性值会自动增加。如果想ArrayList中添加大量元素，可使用ensureCapacity方法一次性增加capacity，可以减少增加重分配的次数提高性能。

ArrayList的用法和Vector向类似，但是Vector是一个较老的集合，具有很多缺点，不建议使用。另外，ArrayList和Vector的区别是：ArrayList是线程不安全的，当多条线程访问同一个ArrayList集合时，程序需要手动保证该集合的同步性，而Vector则是线程安全的。

二：源码分析

public class ArrayList<E> extends AbstractList<E>
        implements List<E>, RandomAccess, Cloneable, java.io.Serializable
{
  /**
    * Default initial capacity.默认初始容量
    */
private static final int DEFAULT_CAPACITY = 10;

/ **
  *  空数组
  */
private static final Object[] EMPTY_ELEMENTDATA = {};

/**
* 用于默认大小空实例的共享空数组实例。我们
* 将其与empty_elementdata区分开来，以了解在什么时候
* 第一个元素被添加。 
*/
private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};

/**
存储ArrayList元素的数组缓冲区。
ArrayList的容量是这个数组缓冲区的长度。
一个空的ArrayList当 elementData==DEFAULTCAPACITY_EMPTY_ELEMENTDATA第一个元素被添加时，容量将扩展为DEFAULT_CAPACITY。
*/
transient Object[] elementData;

 /**
  * The size of the ArrayList (the number of elements it contains).
  *ArrayList的大小（包含的元素个数）
  * @serial
  */
private int size;

 /**
     * 用指定的初始容量构造一个空列表。
     *
     * @param  initialCapacity 初始容量
     * @throws IllegalArgumentException 如果指定的初始容量是负的将抛出异常
     */
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。
     */
  public ArrayList() {
        this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;
  }

 /**
    构造一个包含指定元素的列表的列表集合，按照集合的顺序返回迭代器。
     * @param c the collection whose elements are to be placed into this list
     * @throws NullPointerException if the specified collection is null
     */
    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;
        }
    }

/**
将这个ArrayList实例的容量变成列表的当前大小。
应用程序可以使用这个操作来最小化存储一个ArrayList的实例。
**/
 public void trimToSize() {
        modCount++;
        if (size < elementData.length) {
            elementData = (size == 0)
              ? EMPTY_ELEMENTDATA
              : Arrays.copyOf(elementData, size);
        }
  }

/**
增加这个ArrayList实例的容量，确保它至少能容纳元素的数量
由最小容量参数指定。
 @param   minCapacity   期望的最小容量
*/
  public void ensureCapacity(int minCapacity) {
        int minExpand = (elementData != DEFAULTCAPACITY_EMPTY_ELEMENTDATA)
            // 任何大小，如果不是默认元素表则为零
            ? 0
           //如果是默认的数组则为 DEFAULT_CAPACITY
            : DEFAULT_CAPACITY;
        //如果期望的最小容量比 minExpand大 则扩容
        if (minCapacity > minExpand) {
            ensureExplicitCapacity(minCapacity);
        }
   }
 /**
   要分配的数组的最大大小。
    数组作为一个对象，需要一定的内存存储对象头信息，对象头信息最大占用内存不可超过8字节，所以这里最大长度为 -8
    试图分配更大的数组可能导致
     OutOfMemoryError:请求的数组大小超过VM限制
     */
  private static final int MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8;

 /**
       增加容量，以确保它至少可以容纳
      由最小容量参数指定的元素数量。
     *
     * @param minCapacity the desired minimum capacity
     */
    private void grow(int minCapacity) {
        // overflow-conscious code
        int oldCapacity = elementData.length;
        //新容量=old+old/2 ,即原来的1.5倍
        int newCapacity = oldCapacity + (oldCapacity >> 1);
        if (newCapacity - minCapacity < 0)
            newCapacity = minCapacity;
      //当容量超过MAX_ARRAY_SIZE，最大容量允许大于 MAX_ARRAY_SIZE
        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);
    }

  private static int hugeCapacity(int minCapacity) {
        if (minCapacity < 0) // overflow
            throw new OutOfMemoryError();
        return (minCapacity > MAX_ARRAY_SIZE) ?
            Integer.MAX_VALUE :
            MAX_ARRAY_SIZE;
    }
   
 /**
     * 如果该列表包含指定的元素返回true
     * @param o element whose presence in this list is to be tested
     * @return <tt>true</tt> if this list contains the specified element
     */
    public boolean contains(Object o) {
        return indexOf(o) >= 0;
    }

 /**
     *添加一个元素，ensureCapacityInternal（minCapacity）判断最小容量和数组实际大小，如果最小容量比数组大则进行扩容为原来的1.5倍
     *
     * @param e element to be appended to this list
     * @return <tt>true</tt> (as specified by {@link Collection#add})
     */
    public boolean add(E e) {
        ensureCapacityInternal(size + 1);  // Increments modCount!!
        elementData[size++] = e;
        return true;
    }


 /**
    移除下标的为index的元素
     *
     * @param index the index of the element to be removed
     * @return the element that was removed from the list
     * @throws IndexOutOfBoundsException {@inheritDoc}
     */
    public E remove(int index) {
        rangeCheck(index);

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

        int numMoved = size - index - 1;
        if (numMoved > 0)
            //注意这里，将数组index以后的都向前移动一位
            System.arraycopy(elementData, index+1, elementData, index,
                             numMoved);
        //将数组最后一位置为null
        elementData[--size] = null; // clear to let GC do its work
        return oldValue;
    }

 /**
   移除指定元素：如果传入的元素为空，则删除第一个出现的空元素，如果没有空元素则返回 false
   如果传入的不为空，则删除第一个出现的元素，不存在返回false
     *
     * @param o element to be removed from this list, if present
     * @return <tt>true</tt> if this list contained the specified element
     */
    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 remove method that skips bounds checking and does not
     * return the value removed.
     */
    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
    }

/**
     * 清空一个list
     * be empty after this call returns.
     */
    public void clear() {
        modCount++;
        // clear to let GC do its work
        for (int i = 0; i < size; i++)
            elementData[i] = null;
        size = 0;
    }

}