Java集合源码之ArrayList

便于增强自己对集合的理解和记忆，准备出一系列java集合源码的阅读以及解析，本系列基于JDK1.8。

集合框架是java中最基础也是最重要的一个学习模块之一，因为工作中每天都要用，如果对于集合总是一知半解，或者只知其然不知其所以然，这里我指的是需要“背的面试题”，只记得某个集合的特性，但不知其如何实现。

我认为阅读源码主要分三步：

阅读改类或接口的继承与实现关系，也就是看类图。
阅读构造方法，可以看到他具备哪些重要的构造参数。
阅读重要方法，分析实现原理。

一、ArrayList简介

想必大家对ArrayList并不陌生，甚至老生常谈的一个集合类。确实，他是我们在集合中最经常使用的一个类。它是一个能动态增长的动态数组，相比于普通数组，它具备自动扩容的功能（具体如何扩容后面会有讲解）。

先来看看它直接继承和实现了哪些类和接口：

image.png

ok，从源码我们得知它直接继承了抽象类AbstractList，实现了List【具备增删改查元素功能】，RandomAccess【随机访问功能，是java中用来被List实现，为List提供快速访问功能的。在ArrayList中，我们即可以通过元素的序号快速获取元素对象；这就是快速随机访问。反例就是 LinkedList, 链表结构使得它不支持随机访问，只能按序访问，因此在一些操作上性能略逊一筹。】, Cloneable【可克隆，覆盖了函数clone()，能被克隆。】, java.io.Serializable【可序列化】接口。

来看看它的继承关系：

image.png

可以看出最顶层的接口是Collection,关于Collection可以参考大佬文章，写的非常生动详细：
https://blog.csdn.net/u011240877/article/details/52773577

本文只列举重要api，我们从List开始翻，它是Collection的子接口之一。它定义的方法有：

int size();
返回List的长度。

boolean isEmpty();
判断是否为空。

Object[] toArray();
将List转为数组。

boolean add(E e);
向尾部添加元素。

boolean remove(Object o);
删除元素。

以上都是List继承自Collection的方法，下面是它自己扩展的方法：

int indexOf(Object o);
返回指定元素第一次出现的索引，如果该列表不包含该元素，则为-1。

ListIterator<E> listIterator();
返回一个ListIterator ，Iterator和ListIterator的区别会在其他文章讲解。

List<E> subList(int fromIndex, int toIndex);
截取该List的一部分并返回一个新的List。但是值得注意的是，对subList后返回的引用操作也会对原来的List造成影响。请看：

image.png

结果是：

image.png

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;
/**
*  可以分配的最大大小为 Integer.MAX_VALUE - 8
*/
    private static final int MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8;

    /**
     * 当前元素个数
     */
    private int size;

主要需要我们知道的就是它的初始值为10，然后采用的Object[ ]来存放数据。
还有一个参数叫modCount，根据源码注释得知他记录着List的结构被修改的次数！（这里的结构修改指add,remove操作，set不算）有的文章会说这个属性代表该List扩容过几次其实不然。

protected transient int modCount = 0;

ArrayList的构造方法：

image.png

1.这是个空构造函数，直接把默认的之前定义的空对象数组赋给该引用。

image.png

2.需要指定初始化容量的构造，如果初始值大于0就new一个初始值大小的对象数组。如果等于0使用空数组，小于0就会报异常了。

image.png

3.构造一个包含指定类或其子类的集合，参数为一个集合。
1）将参数集合转换为对象数组并将9引用赋予elementData。
2）更新size并判断是否为0，如果为0则赋为空数组，否则执行Array.copyOf方法。
3）将参数集合的元素内容进行深拷贝一份赋给elementData。因为在此之前elementData仅仅是指向了该参数集合。ps:有的同学可能不懂什么是深拷贝，浅拷贝，简单说明一下：浅拷贝就是将目标对象的引用拷贝一份，换句话说如果你修改了副本的一些引用字段那么原对象的引用字段也会被修改，反之深拷贝是将内容拷贝一份，副本无论怎么修改都不会影响原对象。（如果还是不明白请Google一下）

去除多余空间 trimToSize()

image.png

由于List在使用过程中会扩容，以至于有的空间会被浪费（因为数组是需要预先预定空间的），所以这个方法可以根据elementData重新copy出一份大小为当前elementData的size的对象数组并把元素也copy进去再赋值给elementData，达到节省空间的目的。这里可以看到modCount被自增了，所以应了我之前说的modCount不一定代表扩容了几次，而是list的结构被修改了几次。（增删都算）它可以用于在使用迭代器遍历集合的时候同时修改集合元素。详见大佬文章：https://www.cnblogs.com/zuochengsi-9/p/7050351.html
而且在使用迭代器遍历的时候，这个变量可以提醒我们是否线程安全。这个我会单独写一篇文章来说明。

添加元素 add(E e)

image.png

由此可知add先调用了ensureCapacityInternal（），然后调用了calculateCapacity（）方法。第一次看我也不知道为什要有calculateCapacity（）这个方法，直接判断不就好了吗？其实它在确保第一次添加的时候能有地方能存数据，因为如果我们可能会用空构造new一个ArrayList，会被赋值空数组。所以判断一下，如果是空数组需要在默认值与期望值之间选择大的一个，选择大的是因为扩容也需要消耗性能，所以一次扩大一点，省的可能还要多扩几次。否则返回size+1。

第三步，如果添加该元素后的元素个数大于了数组最大长度将会调用扩容。

look一下扩容方法grow():

image.png

由此看出，新的长度=旧长度（旧长度/2）。也就是原来的1.5倍！如果扩容后的长度还是小于期望长度则将期望长度赋给新长度。一般来说我们数组长度不会超过MAX_ARRAY_SIZE。最后拷贝一份给elementData。

总结：add主要的执行逻辑如下：
1）确保数组已使用长度加1之后足够存下下一个数据
2）修改次数modCount 标识自增1，如果当前数组已使用长度（size）加1后的大于当前的数组长度，则调用grow方法，增长数组，grow方法会将当前数组的长度变为原来容量的1.5倍。
3）将新元素添加到位于size的位置上。
4）返回添加成功布尔值。