Collectoions集合学习笔记(一)-ArrayList源码学习

一、ArrayList

1.1 ArrayList简介

ArrayList是可以动态增长和缩减的索引序列，其实现了List接口，List接口又继承了Collection接口。它的底层是由数组实现的，数组元素类型为Object类型，即可以存放所有类型数据。

我们对ArrayList类的实例的所有的操作底层都是基于数组的。

1.2 继承关系

1.3 几点小结

学习的本质是理解，本想写一个全面详细的文档，但一想那和字典有什么区别呢？方法不会可以直接去查，但是原理便需要去理解，于是这里记录一下自己阅读源码过程中遇到的一些有意思的小点，并结合源码和其他资料来回答自己的问题。

1.ArrayList类中有哪些成员变量和属性？

    /**
     * 默认初始容量为10
     */
    private static final int DEFAULT_CAPACITY = 10;
    /**
     * 一个空对象数组
     */
    private static final Object[] EMPTY_ELEMENTDATA = {};
    */默认的空对象数组
    private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};
     */元素数组
    transient Object[] elementData; // non-private to simplify nested class access
     */实际元素大小， 默认为0
    private int size;
     */最大数组容量
    private static final int MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8;

 看到这里，我有两个问题：

（1）这里的空对象数组和默认空对象数组有什么区别，为啥要搞两个空数组？

   答：通过阅读后面的构造方法源码，可以清晰的看出

　　 private static final Object[] EMPTY_ELEMENTDATA = {}; 

 　　空对象数组用于有参数的构造方法， 该方法构造一个具有指定初始容量的空数组，当输入的指定初始容量为0时，便返回一个这样的空对象数组

　　 private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {}; 

　　默认的空对象数组用于无参数的构造方法，调用这个方法，便返回一个初始容量为10的默认空对象数组

（2）最大数组容量为什么是 MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8; ？

　答：数组需要8 bytes去存储它自己的大小(2,147,483,648)（2^31），另外在源码注释里也写了

　　一些虚拟机会在数组中保留一些标题字。尝试分配较大的数组可能会导致OutOfMemory错误：即请求的数组大小超过了虚拟机限制

2.ArrayList是怎样创建的？

源码中共提供了三种构造方法：

 （1）无参构造方法：

    /**
     * Constructs an empty list with an initial capacity of ten.
     */
    public ArrayList() {
        this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;
    }

（2）指定容量的有参构造方法：

    /**
     * 构造一个具有指定初始容量的空列表
     *
     * @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);
        }
    }

（3）构造一个包含指定 collection 的元素的列表

    /**
     * Constructs a list containing the elements of the specified
     * collection, in the order they are returned by the collection's
     * iterator.
     *
     * @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;
        }
    }

 3.ArrayList是如何实现动态扩容的？

一句话来说，就是：

ArrayList在添加元素前，会进行比较，如果现在所需总容量（即加入元素后数组的新长度）比原来的最大容量要大，则会进行扩容，新容量=旧容量*1.5

下面从添加元素出发，一步步去看看ArrayList是在什么时候并且怎样去扩容的。

开始：在指定下标 index处，添加元素 element

    public void add(int index, E element) {
        rangeCheckForAdd(index);            //检查下标范围

        ensureCapacityInternal(size + 1);  // 确定所需增长的容量大小并进行扩容，这个过程中同时增加了modCount的值!!
        System.arraycopy(elementData, index, elementData, index + 1,
                         size - index);    //
        elementData[index] = element;
        size++;
    }

（1）下标范围检查

    /**
     * A version of rangeCheck used by add and addAll.
     */
    private void rangeCheckForAdd(int index) {
        if (index > size || index < 0)
            throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
    }

（2）确定所需增长的最小容量，传入参数值为：当前数组中的元素数量+1，此处记为新长度

  public void ensureCapacity(int minCapacity) {
        int minExpand = (elementData != DEFAULTCAPACITY_EMPTY_ELEMENTDATA)
            // any size if not default element table
            ? 0
            //  是空表的话便返回0
            // 不是空表便返回默认值10
            : DEFAULT_CAPACITY;

        if (minCapacity > minExpand) {
            ensureExplicitCapacity(minCapacity);
        }
    }

    private static int calculateCapacity(Object[] elementData, int minCapacity) {
　　　　　　//计算所需的最小容量，若原来数组为空，便返回所需的最小容量为默认值10
　　　　　　//若原来数组不为空，便返回传入的新长度（比原来数组元素数目大一个）
        if (elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA) {
            return Math.max(DEFAULT_CAPACITY, minCapacity);
        }
        return minCapacity;
    }

    private void ensureCapacityInternal(int minCapacity) {
        ensureExplicitCapacity(calculateCapacity(elementData, minCapacity));
    }

    private void ensureExplicitCapacity(int minCapacity) {
        modCount++;

        // 若新长度大于当前数组长度了，便使用groww()方法动态增长
        if (minCapacity - elementData.length > 0)
            grow(minCapacity);
    }

（3）根据传入的新长度值扩展原数组

 /**
     * Increases the capacity to ensure that it can hold at least the
     * number of elements specified by the minimum capacity argument.
     *
     * @param minCapacity the desired minimum capacity
     */
    private void grow(int minCapacity) {             //传入参数为新长度（原数组中元素数量+1）的值
        // overflow-conscious code
        int oldCapacity = elementData.length;
        int newCapacity = oldCapacity + (oldCapacity >> 1);        //新容量=旧容量*1.5
        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);
    }

    private static int hugeCapacity(int minCapacity) {
        if (minCapacity < 0) // 若原数组中元素数量已经为Integer.MAX_VALUE,则int类型的minCapacity再加一便会溢出为负数
            throw new OutOfMemoryError();
        return (minCapacity > MAX_ARRAY_SIZE) ?   //若新长度大于最大容量，则新容量就等于Integer.MAX_VALUE，否则等于最大容量
            Integer.MAX_VALUE :
            MAX_ARRAY_SIZE;
    }

（4）将原数组元素复制至变长的新数组中，将给定元素插入，数组中元素数量加一

4.源码中多次出现的modCount变量的作用是什么？

  查看源码可以发现在其父类AbstractList中定义了一个int型的属性：modCount，记录了ArrayList结构性变化的次数。

 protected transient int modCount = 0; 

在ArrayList的所有涉及结构变化的方法中都增加modCount的值，包括：add()、remove()、addAll()、removeRange()及clear()方法。这些方法每调用一次，modCount的值就加1

modCount主要在多线程环境下需要使用，防止一个线程正在迭代遍历，另一个线程修改了这个列表的结构（包括添加删除元素，排序等）。一旦列表在被迭代器遍历时修改则会抛出异常：ConcurrentModificationException

 ArrayList是非线程安全的，所以当大家遍历那些非线程安全的数据结构时，尽量使用迭代器