集合框架学习之ArrayList源码分析

ArrayList是我们经常使用到的一个集合类，通过查看其底层源码实现，有利于我们更好的掌握与使用。ArrayList不算多，但是也不算少，挨个看下去也挺费时费力的。所以呢，我打算循序渐进着来，比如这一篇就先看看ArrayList的属性，以及一些常用的方法，例如增、删、改、查。一口吃不成胖子，任重而道远~

1、ArrayList的结构

下面是在IDEA里查看到的ArrayList的UML图：

从图中我们可以看到：

• 总的来看，ArrayList 继承了AbstractList，实现了List, RandomAccess, Cloneable, java.io.Serializable这些接口；
• ArrayList 实现了RandmoAccess接口，即提供了随机访问功能。RandmoAccess是java中用来被List实现，为List提供快速访问功能的。这表明在ArrayList中，我们即可以通过元素的序号快速获取元素对象（因为底层实现是数组），这就是快速随机访问；
• ArrayList 实现了Cloneable接口，即覆盖了函数clone()，能被克隆；
• ArrayList 实现java.io.Serializable接口，这意味着ArrayList支持序列化，能通过序列化去传输。

整体架构还是非常清晰的，那么开始进入ArrayList的源码开始探索内部原理。

2 、ArrayList的属性分析

通过IDEA查看ArrayList的结构信息，图中框出来的部分是它的属性：

庖丁解牛，挑出重要的来一个个分析：

• private static final int DEFAULT_CAPACITY = 10：定义了ArrayList对象的默认容量为10；
• private static final Object[] EMPTY_ELEMENTDATA = {} ：定义了一个空的数组，在new ArrayList对象时如果参数为0，那么得到的这个空的数组；
• private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {}：同样是定义了一个空的数组，不过和上边的同，在new ArrayList对象时不传参，那么得到的这个空的数组；
• transient Object[] elementData：ArrayList中真正存储元素的数组；
• private int size：用来表示数组中元素的个数。

这些字段单独看来没什么意义，在使用过程中再细细体会其意义所在。

3、ArrayList的构造方法

通过IDEA查看类的结构信息，找出其中的构造方法：

可以看到ArrayList的构造方法共有三个重载，分别是：定义初始容量、默认无参构造和传入一个Collection集合三种构造方法。

那么接下来对这三个构造方法进行分析：

3.1 定义初始容量的构造方法

这种创建对象的方式很简单，就是在new对象时给定一个初始值：

    public static void main(String[] args) {

        List list = new ArrayList(50);   //初始容量为50

    }

那么它是如何操作创建对象的嗫？查看它的具体源代码：（具体的分析将在注释中写出）

   /**
     * Constructs an empty list with the specified initial capacity.
     * 构造具有指定初始容量的空列表。
     *
     * @param  initialCapacity  the initial capacity of the list
     * @throws IllegalArgumentException if the specified initial capacity
     *         is negative
     */
    public ArrayList(int initialCapacity) {
        if (initialCapacity > 0) {          
            //如果给的初始值>0,创建一个大小为initialCapacity的Object对象数组
            this.elementData = new Object[initialCapacity]; 
        } else if (initialCapacity == 0) {
            //如果给的初始值=0,则将EMPTY_ELEMENTDATA空数组赋给它
            this.elementData = EMPTY_ELEMENTDATA;
        } else {
            //如果给的初始值<0,则抛出异常信息
            throw new IllegalArgumentException("Illegal Capacity: "+
                                               initialCapacity);
        }
    }

3.2 默认的无参构造方法

这个方法就相对简单了，看源代码

    /**
     * Constructs an empty list with an initial capacity of ten.
     * 构造一个初始容量为10的空列表。
     */
    public ArrayList() {
        // 将默认的空的数组赋值给它
        this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;
    }

不是说构造一个初始容量为10的列表吗？10呢~？其实是当元素第一次被加入时，扩容至默认容量 10。先留个坑，后边再说。

3.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
     * 如果传入的集合为null，抛出空指针异常。
     */
    public ArrayList(Collection<? extends E> c) {
        
        // 先将传入的集合转化为数组，然后ArrayList底层数组elementData指向该数组
        elementData = c.toArray();  
        //将elementData中的元素个数赋值给sizes
        if ((size = elementData.length) != 0) {
            
            // c.toArray might (incorrectly) not return Object[] (see 6260652)
            //保姆级别翻译：c.toArray方法可能返回的不是一个Object数组，详见6260652号BUG 
             if (elementData.getClass() != Object[].class)
            //如果c.toArray() 返回的数组类型不是 Object[]，则使用Arrays.copyOf()来构             //造一个大小为 size的Object[]类型的数组给elementData数组
                elementData = Arrays.copyOf(elementData, size, Object[].class);
        } else {
            // replace with empty array.
            this.elementData = EMPTY_ELEMENTDATA;
        }
    }

有个点我们需要注意一下，我们经常会通过size()方法查看一个集合中元素的个数，但是注意size和elementData.length是不相同的。size是指当前集合中存在的元素个数，elementData.length是指当前集合指定的容量大小。例如，如果在new ArrayList()时，ArrayList只是给我们默认的elementData=DEFAULTCAPACITY_EMPTY_ELEMENTDATA,此时只是空数组，只有第一次调用add（）时，才将默认数组的大小设置为为DEFAULT_CAPACITY=10 ，此时elementData.length=10，list.size()=0。

小结一下：构造函数走完之后，会构建出数组elementData和数量size。

补充一点：关于方法Arrays.copyOf(elementData, size, Object[].class)，就是根据class的类型来决定是new 还是反射去构造一个泛型数组，同时利用native函数，批量复制元素至新数组中。源代码如下：

public static <T,U> T[] copyOf(U[] original, int newLength, Class<? extends T[]> newType) {
        @SuppressWarnings("unchecked")
        //根据class的类型来决定是new 还是反射去构造一个泛型数组
        T[] copy = ((Object)newType == (Object)Object[].class)
            ? (T[]) new Object[newLength]
            : (T[]) Array.newInstance(newType.getComponentType(), newLength);
         //利用native函数，批量赋值元素至新数组中。
        System.arraycopy(original, 0, copy, 0,
                         Math.min(original.length, newLength));
        return copy;
    }

4、add()方法源码分析

构造完成ArrayList对象之后尝试往集合里加入元素，那么新创建的对象添加元素是什么流程呢？在add()方法处添加断点，Debug走一下流程：

• 进入断点内部，看它调用的方法：

    /**
     * Appends the specified element to the end of this list.
     * 向列表末尾添加元素
     * @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  *此时size = 0
        //断住，进去看代码。
        ensureCapacityInternal(size + 1);  // Increments modCount!!
        elementData[size++] = e;
        return true;
    }

• 方法内部调用了ensureCapacityInternal方法，传的参数是数组和容量：

    private void ensureCapacityInternal(int minCapacity) {  //此时minCapacity=1
        //方法内部调用了calculateCapacity
        ensureExplicitCapacity(calculateCapacity(elementData, minCapacity));
    }

• 断点进入calculateCapacity方法调用，继续断点进去看，这个就比较清晰了：

private static int calculateCapacity(Object[] elementData, int minCapacity) {
        
        //利用判断ArrayList对象是否是用默认构造函数初始化的
        if (elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA) {
            //DEFAULT_CAPACITY = 10，minCapacity = 1，所以返回10
            return Math.max(DEFAULT_CAPACITY, minCapacity);
        }
        return minCapacity;
    }

• 该方法执行结束之后回到ensureCapacityInternal方法，继续调用ensureExplicitCapacity方法：

    private void ensureCapacityInternal(int minCapacity) {
        //继而调用ensureExplicitCapacity方法，传入的参数是 10
        ensureExplicitCapacity(calculateCapacity(elementData, minCapacity));
    }

• 断点进入ensureExplicitCapacity方法内部：（注意传入的参数是10）

    private void ensureExplicitCapacity(int minCapacity) {
        //如果确定要扩容，会修改modCount 
        modCount++;

        // overflow-conscious code
        if (minCapacity - elementData.length > 0) //minCapacity = 10 length =0
            grow(minCapacity);  //调用grow方法
    }

• 经过if判断成立，继续调用了grow(minCapacity)方法，传的参数是 10，断点进入：

    /**
     * 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) {
        
        //oldCapacity：旧的容器容量(0)
        int oldCapacity = elementData.length;
        
        //默认扩容一半：新的容器容量 = 旧容器的容量+旧容器的容量*0.5
        int newCapacity = oldCapacity + (oldCapacity >> 1);
        
        //如果新容量小于minCapacity的话，就把minCapacity赋值给newCapacity
        if (newCapacity - minCapacity < 0)
            newCapacity = minCapacity;
        
        //newCapacity 会与MAX_ARRAY_SIZE进行比较，不能超过Integer的最大值减8
        if (newCapacity - MAX_ARRAY_SIZE > 0)
            newCapacity = hugeCapacity(minCapacity);
        
        //将elementData指向一个新分配的数组，容量为10
        elementData = Arrays.copyOf(elementData, newCapacity);
    }

可以看到这里完成了容器（数组）的扩容操作，这段代码执行完之后，会返回到：

这里就将元素添加到了数组的0号位置，返回true，表示添加成功，至此，add()方法执行结束。

5、add(int index, E element) 方法源码分析

此方法表示向list的指定位置添加元素，上代码~：

public void add(int index, E element) {  //传入的参数分别是指定的位置，要添加的元素
    
    rangeCheckForAdd(index);            //越界判断 如果越界抛异常

    ensureCapacityInternal(size + 1);  // Increments modCount!!
    System.arraycopy(elementData, index, elementData, index + 1,
                     size - index);    //将index开始的数据 向后移动一位
    elementData[index] = element;      //加入新数据
    size++;                            //元素个数+1
}

6、addAll(Collection<? extends E> c)方法源码分析

此方法用于将一个集合里的元素全部加入到当前集合中，代码还算简单：

public boolean addAll(Collection<? extends E> c) {
    Object[] a = c.toArray();     //将结合转换为数组
    int numNew = a.length;        //获得数组长度
    ensureCapacityInternal(size + numNew); //判断是否需要扩容
    System.arraycopy(a, 0, elementData, size, numNew);//复制数组至elementData中
    size += numNew;              //计算当前容器中的元素个数
    return numNew != 0;
}

7、addAll(int index, Collection<? extends E> c)方法源码分析

此方法用于在指定位置插入整个集合：

public boolean addAll(int index, Collection<? extends E> c) {
    rangeCheckForAdd(index);      //越界判断 如果越界抛异常
    Object[] a = c.toArray();     //将结合转换为数组
    int numNew = a.length;        //获得数组长度
    ensureCapacityInternal(size + numNew); //判断是否需要扩容

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