Java集合容器系列02-ArrayList

1、ArrayList介绍

    ArrayList是内部基于动态数组的List实现，他继承AbstractList抽象类，并实现了List，RandomAccess，Cloneable和java.io.Serializable。它实现了List接口定义的全部方法，容许插入null元素，支持元素的随机访问，支持克隆，支持序列化所以能在网络和本地文件系统之间经过字节流传输。它的功能有点相似Vector可是是非线程安全的。若是多个线程同时访问ArrayList而且有至少一个线程对列表作告终构性修改则有线程安全问题咱们必须在外部对它作同步处理。那么什么是结构性修改呢？注意添加、删除一个或者多个元素，对ArrayList容量也就是内部动态数组大小进行修改这些操做均属于结构性修改，修改ArrayList中一个指定位置的元素值不属于结构性修改。

    为了保证线程同步，咱们能够选择其余集合容器，例如Vector、CopyOnWriteArrayList，或者使用Collections.synchronizedList(List list)方法包装ArrayList为线程安全的类。

    为了提高使用ArrayList的性能，咱们应该在使用以前进行评估分配一个合理的容量，这样能够在插入超出初始容量数目的元素时减小没必要要的扩容次数，由于在扩容时须要进行数组全复制对性能损耗极大。

2、ArrayList的数据结构

1 - ArrayList的继承结构

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

Object

    |__AbstractColllection

            |__AbstractList

                    |__ArrayList        

2 - 内部数据结构

public class ArrayList<E> extends AbstractList<E>
        implements List<E>, RandomAccess, Cloneable, java.io.Serializable
{
    //序列版本号
    private static final long serialVersionUID = 8683452581122892189L;

    //ArrayList默认容量
    private static final int DEFAULT_CAPACITY = 10;

    //一个静态不可变的空对象数组，做为共享变量，主要用于当ArrayList初始容量为0时让内部动态数组指向它，这样可减小
    //空对象数组的分配
    private static final Object[] EMPTY_ELEMENTDATA = {};

    //静态不可变对象数组，做为共享的初始容量大小的空实例数组，与EMPTY_ELEMENTDATA分开使用用于观察第一个元素被添加进
    //来，ArrayList扩容大小
    private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};

    //数组用于保存ArrayList元素数据
    transient Object[] elementData;

    //ArrayList实际保存的元素数量
    private int size;

}

 

3、ArrayList的源码分析

1 - 构造函数

public class ArrayList<E> extends AbstractList<E>
        implements List<E>, RandomAccess, Cloneable, java.io.Serializable
{
    //包含初始容量大小的构造函数。基于传入的initialCapacity初始化内部动态数组或者抛出异常
    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);
        }
    }

    //默认构造函数。主要初始化了一个默认容量大小的内部动态对象数组elementData。
    public ArrayList() {
        this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;
    }

    //建立一个包含集合c全部元素的ArrayList。若是c是空集合不包含任何元素则为elementData分配一个容量为0的空对象数组
    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;
        }
    }
}

    构造方法逻辑较为简单，你们能够去研读源码自行理解。

2 - 其余成员方法

//ArrayList内部动态数组瘦身，若实际数据量小于内部动态数组长度，则从新为elementData分配一个大小等于实际数据量大
    //小的数组，并恰好填满它防止当前额外的空间浪费
    public void trimToSize() {
        modCount++;
        if (size < elementData.length) {
            elementData = (size == 0)
              ? EMPTY_ELEMENTDATA
              : Arrays.copyOf(elementData, size);
        }
    }

    //返回集合容量
    public int size() {
        return size;
    }

    //判断集合是否为空
    public boolean isEmpty() {
        return size == 0;
    }

    //返回ArrayList是否包含元素对象o
    public boolean contains(Object o) {
        return indexOf(o) >= 0;
    }

    //正向遍历，返回ArrayList中第一个等于对象o的元素数组索引下标，若是o为null那么返回第一个等于null的元素下标
    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;
    }

    //反向遍历返回第一个等于对象o元素数组下标
    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的一份浅拷贝，数组元素自己不调用拷贝函数clone，而且将ArrayList改变次数modCount清零
    public Object clone() {
        try {
            ArrayList<?> v = (ArrayList<?>) super.clone();
            v.elementData = Arrays.copyOf(elementData, size);
            v.modCount = 0;
            return v;
        } catch (CloneNotSupportedException e) {
            // this shouldn't happen, since we are Cloneable
            throw new InternalError(e);
        }
    }

    //返回一个包含全部元素数据的对象数组
    public Object[] toArray() {
        return Arrays.copyOf(elementData, size);
    }

    //返回一个包含list全部元素的对象数组
    //若是数组a长度小于list元素个数，那么新建一个指定数组a元素类型的对象数组填充list元素数据并返回
    //若是数组a长度大于或者等于list元素个数，那么将list元素数据复制到传入的数组a并返回
    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;
    }


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

    //获取list对应索引位置的元素
    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;
    }

}

    以上成员方法较为简单，不单独列出来进行分析，下面是咱们要重点分析的几个方法：

1）void ensureCapacity(int minCapacity)方法

//肯定ArrayList的容量大小
    public void ensureCapacity(int minCapacity) {
        int minExpand = (elementData != DEFAULTCAPACITY_EMPTY_ELEMENTDATA)
            //若是elementData不是默认分配的初始大小的动态对象空数组，则用户还未进行初始扩容，最小容量为0
            ? 0
            //用于已进行初始扩容，故最小容量为DEFAULT_CAPACITY
            : DEFAULT_CAPACITY;

        if (minCapacity > minExpand) {
            ensureExplicitCapacity(minCapacity);
        }
    }
    //做用与上述方法ensureCapacity(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) {
        modCount++;

        // overflow-conscious code
        if (minCapacity - elementData.length > 0)
            grow(minCapacity);
    }

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

    ensureCapacity用于肯定ArrayList的容量。首先他会比较方法传入的指定容量参数minCapacity和ArrayList的默认容量DEFAULT_CAPACITY取两个最大值。而后modCount(ArrayList修改计数器)加1，若是指定的扩容容量minCapacity小于等于当前内部动态对象数组elementData的大小说明当前数组空间未溢出不须要进行扩容，不然进行扩容，扩容规则以下：

首先定义一个初始扩容以后的容量newCapacity=ArrayList原来的容量*1.5，取用户指定容量minCapacity和扩容以后容量newCapacity的较小值并赋值给newCapacity，若是newCapacity大于数组的最大限制Integer.MAX_VALUE-8，那么进行极限扩容，newCapacity=Integer.MAX_VALUE。为elementData分配一个数组长度newCapacity的对象数组，并把原有数据填充进去。

2）boolean add(E e)与boolean addAll(Collection<? extends E> c) 方法

public boolean add(E e) {
        ensureCapacityInternal(size + 1);  // Increments modCount!!
        elementData[size++] = e;
        return true;
    }


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

    add(E e)用于在ArrayList中新增一个元素。它会先调用ensureCapacityInternal(size + 1)方法判断新增元素以后数组空间是否已满须要对内部存储元素数据的动态数组elementData进行扩容，若是须要则进行扩容。而后在数组elementData当前最近的空闲位置存储指定元素e

    addAll方法与add方法逻辑类似，区别只在于往ArrayList插入元素的时候，add方法在数组尾部位置设置元素，addAll方法是将传入的容器对象c中包含的全部元素一次性复制到ArrayList数组剩余空闲部分。

3）void add(int index, E element)与boolean addAll(int index, Collection<? extends E> c)方法

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

       add(int index, E element)方法用于往ArrayList指定位置index处插入元素element，插入元素以后须要将原ArrayList中index以及index后面的元素右移。方法的主要逻辑是：

一、调用rangeCheckForAdd(index)方法校验当前传入的索引位置index是否合法，不合法抛出数组越界异常IndexOutOfBoundException;

二、调用ensureCapacityInternal(size + 1)肯定新元素插入以后ArrayList的容量须要的时候进行扩容；

三、将原ArrayList指定位置index处空间让出来存放指定元素e，原index以及后面位置元素使用系统数组复制函数复制到index以后的数组部分也就是右移；

四、在指定索引位置设置元素e，元素个数计数器size+1。

    boolean addAll(int index, Collection<? extends E> c)方法逻辑与add(int index, E element)类似，不一样之处在于add是插入单个元素addAll是插入一个容器中的全部元素，所以addAll方法在肯定ArrayList的容量（基于原有元素数目加上新增集合元素数目，在必要时进行扩容）以后addAll方法右移的起始位置是扩容以后原ArrayList元素个数+插入的集合c的元素个数对应的数组下标，而在右移以后须要将集合c中的全部元素设置到扩容后elementData中间的空闲部分，这里是经过系统数组复制完成的而add只是设置单个元素。

 

4）E remove(int index)与void fastRemove(int index)方法

public E remove(int index) {
        //校验索引下标index的合法性（不能够超出当前元素数量size）
        rangeCheck(index);
        //修改计数器加1
        modCount++;
        //获取index对应的数组元素
        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;
    }

    private void fastRemove(int index) {
        //修改计数器加1
        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
    }