探索ArrayList底层实现

背景

想进步,想学习了,反正面试都要问的,还不如早点看了好。探索ArrayList源代码是基于JDK1.8版本的,相比以前的版本不知道有没有优化,毕竟没看过之前版本的底层代码。一般看底层代码前我都习惯先阅读下该类的注释说明,也不知道在哪里养成的习惯。相信大家都写过应用代码,既然写过,那也深知注释对于一个使用者来说是多么的重要,决定了它是否能够正确的使用,所以这是一个好习惯。

阅读注释

看到这不知道你们有没有很惊讶,反正我倒是一惊,所以我说看注释很重要!!!如果是你写代码给别人看,除了看具体代码之外,看注释就是最好的理解方式了,一语道破很多原理,要求不高的我都觉得可以不用看代码实现了,所以接下来会继续阅读注释。

这就变相地在说,ArrayList中的get/set效率比LinkedList高,这不正好验证了我们常说的ArryList存取快,插入删除慢,我想它的时间复杂度说明了一切,虽然这里只是给出了结论。在这里顺便提供下有趣的时间复杂度的介绍文章,便于理解。

简单地说数组会自动扩容

在这里我将amount翻译成次数,这个单词本意是数量的意思。基于我对ArrayList的了解,当容量不足时,它是需要扩充容量的,就上面咱们提到的自动扩容,每次容量不足时都需要自动扩容,若一开始就设置好这个容量,那么就减少了自动扩容的次数,所以我将它翻译成次数。它的意思就是让你提前设置好容量大小,以便容量不足时需要消耗时间去自动扩容。

大致意思是ArrayList不是线程安全,所以在多线程环境下要在外部控制同步防止数据紊乱。

截图中应该讲的挺明白了!

Fail-Fast:快速失败,我也是第一次听说该术语,它仅仅用于检测BUG,说明不了什么问题。

数据结构

按照顺序先来看下ArrayList都具有哪些成员属性

    //支持序列化、可克隆、随机访问
    public class ArrayList<E> extends AbstractList<E> implements List<E>, RandomAccess, Cloneable, java.io.Serializable {

        //序列化标识
        private static final serialVersionUID = 8683452581122892189L;

        //默认初始值容量大小10
        private static final DEFAULT_CAPACITY = 10;

        //空数组实例,主要用来做赋值
        private static final Object[]  EMPTY_ELEMENTDATA = {};

        //空数组实例,当采用默认的空构造函数时采用该实例作为默认值
        //该实例与 EMPTY_ELEMENTDATA 被区分开来以便知道当第一个元素被添加时数组该扩充多大,简单来说该属性会参与到计算当中,而 EMPTY_ELEMENTDATA只是用作简单的赋值
        private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};

        //ArrayList中的元素被添加到该数组中
        //ArrayList的容量大小是该数组的长度大小
        //空构造函数的 elementData被赋值为 DEFAULTCAPACITY_EMPTY_ELEMENTDATA,当添加第一个元素时,elementData数组大小将会被扩充到默认容量大小10
        //该对象加上 transient 修饰符表示不对该属性进行序列化
        transient Object[] elementData;

        //ArrayList容量大小,意指它包含元素的个数
        private int size;

        //我们都知道定义一个数组的大小是 int 类型,那么也就意味着最大的数组大小应该是Integer.MAX_VALUE,但是这里为啥要减去8呢?
        //查阅资源发现大部分的人都在说8个字节是用来存储数组的大小,半信半疑
        //分配最大数组,某些VM会在数组中存储header word,按照上面的说法指的应该是数组的大小
        //若尝试去分配更大的数组可能会造成 OutOfMemoryError: 定义的数组大小超过VM上限
        //不同的操作系统对于不同的JDK可能分配的内存会有所差异,所以8这个数字可能是为了保险起见
        private static final int MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8;

        //ArrayList结构被修改的次数
        //该字段主要针对迭代器与子集使用,若该属性被出乎意料的改变了,调用迭代器的相关方法,如 next、 remove、previous、set、add则会抛出 ConcurrentModificationException异常,该//情况其实就是上面提到的fail-fast
        //严格上来说,该字段并不算是结构被修改的次数,在判断是否需要扩容时,它是首先进行增加在判断,不过这不影响,该字段仅用来判断是否与其他字段相等
        protected transient int modCount = 0;
    }

这些成员属性都很容易理解,加上提供了注释,所以这边就不做多的阐述!

构造函数

接下来介绍ArrayList提供的构造函数


    /**
     * 构造一个指定初始容量大小的空数组,相当于 new Object[initialCapacity]
     * 若入参initialCapacity大于0,则创建具有指定大小的空数组,并让elementData指向该数组
     * 若入参initialCapacity等于0,则elementData指向已经创建好的空数组
     * 若入参initialCapacity小于0,则抛出参数异常
     * @param 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);
        }
    }

    /**
     * 构造一个初始容量为10的空数组,并让elementData指向已经创建好的空数组
     * 初始容量并不是在这里设置,而是在添加第一个元素时进行初始化
     */
    public ArrayLlist() {
        this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;
    }

    /**
     * 构建一个包含指定collection集合的数组,ArrayList容量大小和该集合大小一致,指定集合中的元素按照迭代器的顺序排列
     * collection集合类型有Map、set、List等子类,所以入参可以是多种类型
     * collection集合转换成数组,elementData指向该数组,size成员属性被赋值为collection集合长度
     * 若该数组大小大于0,则判断数组类型是否是Ojbect[],若不是则创建一个新的数组,并拷贝elementData数组中的内容
     * 若该数组大小等于0,则elementData指向空数组
     * collection集合不可能创建长度为负数的集合
     * @param c 指定集合
     */
    public ArrayList(Collection<? extends E> c) {
        elementData = c.toArray();
        if ((size = elementData.length) != 0) {
            //c.toArray 可能不会返回正确的Object[]类型,这边可能会利用多态的性质,如 A a = new B()
            if (elementData.getClass() != Object[].class)
                elementData = Arrays.copyOf(elementData, size, Object[].class);
        } else {
            //空数组
            this.elementData = EMPTY_ELEMENTDATA;
        }
    }
  • 若已经提前知道数组容量,则建议使用new ArrayList(initialCapacity)

  • 若不知道数组容量的话,那就没办法了

  • ArrayList(Collection c)一般是在包含关系的情况下使用

方法说明

接下来按照类的声明顺序介绍方法,有必要的情况下结合例子进行说明。

缩小数组大小空间

    /**
     * 缩小ArrayList对象的容量到当前数组的大小,应用可以调用该方法来最小化ArrayList对象的存储空间,简单来说就是节约空间,去掉没有用到的剩余数组空间
     * modCount 是记录ArrayList修改结构的次数,节约数组空间就是减少了数组的大小
     * size 是数组填充了元素的个数,实实在在的大小,而 elementData.length 是数组的总容量大小,也就是说只有当填充/删除元素时size的大小才会变化
     * 而当进行扩容时 elementData.length 才会变化,毕竟数组的长度变大了
     * 若size小于elementData.length,则判断 size是否等于0
     * 若size等于0,则将 elementData 指向空数组
     * 若size不等于0,则创建一个大小为size的数组,并将elementData中原有的元素拷贝到新数组中,同时更新elementData指向新数组,从而完成节约数据空间的作用
     * size的长度是不可能大于elementData.length
     */
    public void trimToSize() {
        modCount++;
        if (size < elementData.length) {
            elementData = (size == 0) ? EMPTY_ELEMENTDATA
              : Arrays.copyOf(elementData, size);
        }
    }
自定义容量 + 扩容机制

自定义容量可以在创建ArrayList对象时设置,若后期发现容量不足总不能手动去改数值吧,故而提供了其他方法去自定义容量。


    /**
     * 增加ArrayList对象的容量,在必要情况下,入参minCapacity至少要确保能容纳元素的数量
     * 若 elementData 不等于空数组,则minExpand = 0,否则minExpand = DEFAULT_CAPACITY = 10
     *
     * 假设去掉设置minExpand的值的语句会造成的影响:
     * 若采用new ArrayList的方式创建对象,则表示在第一次添加元素时,自动将容量扩充到10,而若在此之前先手动扩充容量,如果该值小于10,则会扩容一次,而当容量不足时,
     * 又会扩容一次,总的来说会频繁的进行扩容,而为什么一开始要设置成10呢,微软工程师做过调研,认为该数字比较常用,实际上设置成其它值也是没问题的
     *
     * 扩容机制为了保证所有的元素都能被容纳,自定义容量与自动扩容的数值会进行比较,取较大值作为扩容的参数,故而有了minCapacity与minExpand的比较
     * 若minCapacity大于minExpand,则调用ensureExplicitCapacity方法
     *
     * @param  minCapacity 手动扩充的容量大小
     */
    public void ensureCapacity (int minCapacity) {
        int minExpand = (elementData != DEFAULTCAPACITY_EMPTY_ELEMENTDATA) ? 0 : DEFAULT_CAPACITY;
        if (minCapacity > minExpand) {
            ensureExplicitCapacity(minCapacity);
        }
    }

    /**
     * modCount指的是记录修改结构的次数,但若是minCapacity 小于 elementData.length,则结构并没有修改,在这点上不是很难理解
     * 判断完需要扩容的参数,接下来应该判断该参数是否大于预先定义好的总容量大小,还是取较大值
     * 若minCapacity大于elementData.length,则调用grow方法开始扩容
     *
     * @param  minCapacity 手动扩充的容量大小
     */
    private void ensureExplicitCapacity(int minCapacity) {
        modCount++;
        if (minCapacity - elementData.length > 0)
            grow(minCapacity);
    }

    /**
     * oldCapacity >> n:oldCapacity除以2的n次方
     *
     * 首先获取当前数组的容量大小,获取自动扩容时的容量大小为 oldCapacity + oldCapacity/2 = 1.5 * oldCapacity,也就是说两次扩容之间是1.5倍的关系
     * 判断手动扩充的容量是否大于自动扩充的容量
     * 若大于,则自动扩容的容量修改为手动扩充的容量,即 newCapacity = minCapacity,否则newCapacity不变,即采用自动扩充的容量
     * 为了防止内存溢出,扩容并不是无止境的扩充,当大于一个临界点MAX_ARRAY_SIZE时,就不允许在采用自动扩容的容量大小,而是取最大值或临界点
     *
     * 参考hugeCapacity方法:
     * 当程序执行到①时,我们可以知道 newCapacity >= minCapacity(指的是赋值之后的关系)
     * 若MAX_ARRAY_SIZE大于newCapacity,则就开始创建长度为newCapacity的新数组,三者的关系为 MAX_ARRAY_SIZE > newCapacity >= minCapacity
     * 若MAX_ARRAY_SIZE小于newCapacity,则进入到hugeCapacity方法,但此时我们不知道minCapacity 与 MAX_ARRAY_SIZE的大小关系
     * 若minCapacity大于MAX_ARRAY_SIZE,则采用最大值,不允许无限制的手动设置扩充容量,不过最大值有可能会出现内存溢出
     * 三者关系为:newCapacity >= minCapacity > MAX_ARRAY_SIZE
     * 若minCapacity小于MAX_ARRAY_SIZE,则采用临界值,该临界值是保证在不同的操作系统下不会发生内存溢出, 三者关系为:newCapacity > MAX_ARRAY_SIZE > minCapacity

     * 得出结论:
     * 添加元素时会先到底临界值,此时不会发生内存溢出,若在往上增长则达到最大值,最大值有可能发生内存溢出
     *
     * @param  minCapacity 手动扩充的容量大小
     */
    private void grow(int minCapacity) {
        int oldCapacity = elementData.length;
        int newCapacity = oldCapacity + (oldCapacity >> 1);
        if (newCapacity - minCapacity < 0)
            newCapacity = minCapacity;      --------------------> ① 手动添加
        if (newCapacity - MAX_ARRAY_SIZE > 0)
            newCapacity = hugeCapacity(minCapacity);
        elementData = Arrays.copyOf(elementData, newCapacity);
    }

    /**
     * 判断入参minCapacity 是否大于 MAX_ARRAY_SIZE
     * 若 minCapacity > MAX_ARRAY_SIZE,则返回值是最大值
     * 若 minCapacity <= MAX_ARRAY_SIZE,则返回值是临界值
     *
     * @param  minCapacity 手动扩充的容量大小
     * @return 容量大小结果值
     */
    private static int hugeCapacity(int minCapacity) {
        if (minCapacity < 0) // overflow
            throw new OutOfMemoryError();
        return (minCapacity > MAX_ARRAY_SIZE) ?
            Integer.MAX_VALUE :
            MAX_ARRAY_SIZE;
    }

    /**
     * 计算出要扩充的容量大小并扩容
     *
     * @param  minCapacity 手动扩充的容量大小
     */
    private void ensureCapacityInternal(int minCapacity) {
        ensureExplicitCapacity(calculateCapacity(elementData, minCapacity));
    }

    /**
     * 只有在采用new ArrayList()的方式创建对象后,elementData才会等于DEFAULTCAPACITY_EMPTY_ELEMENTDATA,而以其他方式创建对象后都具有一定的容量大小
     * 若 elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA,比较手动扩容与自动扩容的容量大小,取较大值
     * 若不相等,则采用手动扩容容量大小
     *
     * @param elementData 数组
     * @param minCapacity 手动扩充的容量大小
     * @return 容量大小结果值
     */
    private static int calculateCapacity(Object[] elementData, int minCapacity) {
        if (elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA) {
            return Math.max(DEFAULT_CAPACITY, minCapacity);
        }
        return minCapacity;
    }

什么情况下会扩容

  • 这个问题有点白问,当然了是数组不够用了才需要扩充容量了,不过它不是一个一个的扩充,而是采用一定的规则去扩充,回答的也有点傻!

自动扩容机制

  • 每次自动扩容都以1.5倍的关系进行增长,如果期间手动扩充容量,则会比较手动扩充的容量大小与1.5倍的容量大小,取较大值进行扩容。
  • 扩容是比较耗时的,应该尽力去避免,所以在初始化时就应该提供一个容量参数。

容量最大值

  • 最大值是Interger.MAX_VALUE,但容易造成内存溢出,保险起见在容量等于Integer.MAX_VALUE - 8 的时候就应该停止扩充容量。
获取元素

    /**
     * 获取数组中指定索引的元素
     * @param index 指定索引
     * @return 指定索引对应的元素
     */
    public E get(int index) {
        rangeCheck(index);

        return elementData(index);
    }

修改元素

    /**
     * 修改数组中指定索引的值
     * rangCheck检查角标是否越界
     * @param index 索引
     * @param element 新元素,替换索引对应的值
     * @return 旧元素,索引对应的值
     */
    public E set(int index, E element) {
        rangeCheck(index);

        E oldValue = elementData(index);
        elementData[index] = element;
        return oldValue;
    }

添加/插入元素

    /**
     * 添加元素到数组尾部,添加元素之前会先进行扩容判断
     * @param e 新元素
     * @return 是否添加成功
     */
    public boolean add(E e) {
        ensureCapacityInternal(size + 1);
        elementData[size++] = e;
        return true;
    }

    /**
     * 添加元素到数组中的指定位置,添加元素之前会先进行扩容和角标越界判断
     * 插入过程中将index索引位置及后续的所有元素都将向右移动一格,同时将当前索引位置的值修改成新值
     * 数组扩容跟size属性没有任何关系,size只负责数组中有多少个元素,插入元素后故而 + 1
     * @param index 索引
     * @param element  新元素
     */
    public void add(int index, E element) {
        rangeCheckForAdd(index);

        ensureCapacityInternal(size + 1);
        System.arraycopy(elementData, index, elementData, index + 1,
                         size - index);
        elementData[index] = element;
        size++;
    }

    /**
     * 添加数组到另外一个数组中,从尾部开始追加
     * 相当于合并两个数组
     * @param c 数组
     * @return 数组中的元素是否添加到另外一个数组中
     */
    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;
    }

    /**
     * 添加数组到另外一个数组中,从指定索引出开始添加
     * 插入过程中将index索引位置及后续的任何元素都将往右移动 numNew 格,相当于是批量插入
     * 相当于在插入前先将原有的元素都往右移动,预先留出空位来给后面要添加的元素
     * @param index 索引
     * @param c 数组
     * @return 数组中的元素是否添加到另外一个数组中
     */
    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;
    }

移除元素

    /**
     * 移除数组中指定索引的值,移除元素之前会先进行角标越界判断
     * 移除过程中将index索引位置后续的所有元素都将向左移动一格
     * 为了能让GC尽可能地回收资源,主动将尾部位置设置成null
     * @param index 索引
     * @return 移除的旧值
     */
    public E remove(int index) {
        rangeCheck(index);

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

    /**
     * 移除数组中第一次出现的指定值
     * @param o 指定元素
     * @return 是否删除成功
     */
    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;
    }

    /**
     * 移除从指定起始索引到指定结束索引之间的所有元素
     * 移除包含fromIndex索引对应的值,但不包括toIndex索引对应的值
     * 移除过程中将toIndex索引位置及其后续的所有元素往左移动 toIndex - fromIndex 格
     *
     * 看到这里的时候有些理解难题,在移除元素后索引位置上的元素主动设置成null,我明白这一点,不好理解的点在于算法
     * 假设如下:
     *             f           t
     * 1     2     3     4     5     6     7     8
     *
     * 移除3后的结果,注意4是不会被移除的:
     * 1     2     6     7     8     9     null  null
     *
     * 根据需求,我们知道要将8位置上的值设置成null,那么问题就在于我怎么才能知道7位置上的索引是多少呢?哦,是7,这个不算,算法应该怎么写呢?
     * 所以我很好奇怎么是这个答案:size - (toIndex-fromIndex),后面着重理解了一下:
     *
     *             f           t
     * 1     2     6     7     8     9     null  null
     * <=             size                         =>
     *                                     <= t-f =>
     * <=               ?                   =>
     * 求?的值,也就是在求null的索引是多少,看上面的图就应该比较好理解了(不知道看的懂不),size - (toIndex-fromIndex)就刚好是索引的值
     *
     * @param fromIndex 起始索引
     * @param toIndex 结束索引
     */
    protected void removeRange(int fromIndex, int toIndex) {
        modCount++;
        int numMoved = size - toIndex;
        System.arraycopy(elementData, toIndex, elementData, fromIndex,
                         numMoved);

        int newSize = size - (toIndex-fromIndex);
        for (int i = newSize; i < size; i++) {
            elementData[i] = null;
        }
        size = newSize;
    }

    /**
     * 批量移除数组中的指定数组的元素
     * @param c 指定移除的元素集合
     * @return 是否移除成功
     */
    public boolean removeAll(Collection<?> c) {
        Objects.requireNonNull(c);
        return batchRemove(c, false);
    }

简单方法

    /**
     * 获取数组中的元素个数
     * @return 数组中的元素个数
     */
    public int size() {
        return size;
    }

    /**
     * 判断是否是空元素数组
     * @return 数组是否为空
     */
    public boolean isEmpty() {
        return size == 0;
    }

    /**
     * 采用正向遍历的方式,获取数组中与指定元素相等的元素的索引
     * 若存在多个元素,取第一次与指定元素相等的元素的索引
     * 若找不到指定元素则返回 -1
     * 方法中通过equals判断两对象是否相等,若是调用Object#equals方法,是在判断两者的地址是否指向同一个
     * 若对象中已经覆写了Object#equals,则应该引起注意!
     * @param o 指定元素
     * @return 指定元素的索引
     */
    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;
    }

    /**
     * 采用反向遍历的方式,获取数组中与指定元素相等的元素的索引
     * 若存在多个元素,取第一次与指定元素相等的元素的索引
     * 若找不到指定元素则返回 -1
     * 方法中通过equals判断两对象是否相等,若是调用Object#equals方法,是在判断两者的地址是否指向同一个
     * 若对象中已经覆写了Object#equals,则应该引起注意!
     * @param o 指定元素
     * @return 指定元素的索引
     */
    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;
    }

    /**
     * 调用该clone之前,该类要实现Cloneable,不然会抛出异常
     * 数组默认已经实现了Cloneable接口,直接调用方法即可,而且直接返回对应的类型,不需要向下转型,同时包含数组元素
     * 浅拷贝与深拷贝,举个例子吧
     * 比如A类中包含基本类型与B类,当调用A类clone方法后,两个A对象肯定是不一致,不然就不叫做拷贝了,不过这不是关键
     * 若A1对象中的B对象与A2对象中的B对象指向同一个对象,则认为它是浅拷贝,认为B没有被拷贝新的一份
     * 若两者指向不相等的话,则认为深拷贝,认为B重新拷贝了一份,不过这通常需要我们自定义代码,就像下面的方法一样
     * @return 克隆后的新对象
     */
    public Object clone() {
        try {
            ArrayList<?> v = (ArrayList<?>) super.clone();
            v.elementData = Arrays.copyOf(elementData, size);
            v.modCount = 0;
            return v;
        } catch (CloneNotSupportedException e) {
            throw new InternalError(e);
        }
    }

    /**
     * 返回一个包含所有列表元素的有序(按照添加顺序)数组
     * 此方法是创建一个新数组,方便使用者能够随便操作新数组
     * @return 新数组
     */
    public Object[] toArray() {
        return Arrays.copyOf(elementData, size);
    }

    /**
     * 将列表的所有元素放入到指定数组中并返回
     *
     * 注意:T类型要么是数组中数据的相同类型,要么是数组中数据的父类型,运用多态性质
     * 若传入的新数组容量 < 列表容量,则取它的类类型来创建一个包含列表元素的新数组,并返回
     * 若传入的新数组容量 > 列表容量,则将列表中的元素按照顺序拷贝到新数组中,同时将新数组中索引为size的值设置成null
     *
     * 一开始我也好奇为啥要在索引为size上设置个null呢?
     * 看了注释加上自我的理解,若传入的新数组是个空数组的话,那么除了拷贝列表元素后剩余的所有空间的值都为null,此时在给索引为size的值设置成null似乎没有多大
     * 意思;另外一种情况是若传入的新数组不是个空数组,那这个设置就有意义了,传入的新数组的某些元素会被列表元素覆盖,同时有个null,剩下的才是自己本身的数据,呈现这样子一种效果
     *
     * List<Integer> list = new ArrayList<>();
     * list.add(11);
     *
     * Integer[] str = new Integer[]{1,2,3,4,5,6,7,8,9,10};
     * Integer[] s1 = list.toArray(str);
     *
     * for (Integer s : s1) {
     *     System.out.println(s + ",");
     * }
     *
     * 输出结果:11,null,3,4,5,6,7,8,9,10,
     * 那么设置这个null的意义就在于能够确定列表中元素个数(长度),但有个前提就是调用者知道链表中的所有节点信息不存在null才有意义,目前我只有想到这一种情况下有用!
     *
     * @param a 指定数组
     * @return 填充完列表元素的指定数组
     */
    public <T> T[] toArray(T[] a) {
        if (a.length < size)
            return (T[]) Arrays.copyOf(elementData, size, a.getClass());
        System.arraycopy(elementData, 0, a, 0, size);
        if (a.length > size)
            a[size] = null;
        return a;
    }

    /**
     * 获取数组中指定索引中的值
     * @param index 指定索引
     * @return 指定索引的元素
     */
    E elementData(int index) {
        return (E) elementData[index];
    }

    /**
     * 判断索引是否越界
     * @param index 指定索引
     */
    private void rangeCheck(int index) {
    if (index >= size)
        throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
    }

    /**
     * 判断角标是否越界,该方法专门针对add 和 addAll方法
     * @param index 指定索引
     */
    private void rangeCheckForAdd(int index) {
        if (index > size || index < 0)
            throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
    }

    /**
     * 本质上该方法与移除元素没啥区别
     * @param index 索引
     */
    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
    }

    /**
     * 清空元素,主动将数组中的元素设置为null方便GC回收垃圾
     */
    public void clear() {
        modCount++;

        for (int i = 0; i < size; i++)
            elementData[i] = null;

        size = 0;
    }

    /**
     * 集合与数组取交集
     * 最终数组中只包含与集合共有的元素,相当于在修改数组
     * @param c 指定集合
     * @return 数组元素是否被修改成功
     */
    public boolean retainAll(Collection<?> c) {
        Objects.requireNonNull(c);
        return batchRemove(c, true);
    }

    /**
     * 批量删除元素
     * 若集合是否包含指定元素的结果与入参complement比较,
     * 若complement是false,移除数组与集合共有的元素
     * 若complement是true,保留数组与集合共有的元素,即交集
     * @param c 指定集合
     * @param complement 比较值
     * @return 数组元素是否被修改
     */
    private boolean batchRemove(Collection<?> c, boolean complement) {
        final Object[] elementData = this.elementData;
        int r = 0, w = 0;
        boolean modified = false;
        try {
            for (; r < size; r++)
                if (c.contains(elementData[r]) == complement)
                    elementData[w++] = elementData[r];
        } finally {
            // Preserve behavioral compatibility with AbstractCollection,
            // even if c.contains() throws.
            if (r != size) {
                System.arraycopy(elementData, r,
                                 elementData, w,
                                 size - r);
                w += size - r;
            }
            if (w != size) {
                for (int i = w; i < size; i++)
                    elementData[i] = null;
                modCount += size - w;
                size = w;
                modified = true;
            }
        }
        return modified;
    }

    /**
     * 自定义序列化
     * 若写入过程中数组结构被修改则会抛出异常
     * 如果采用默认的序列化机制,空余的空间会作为null写入本地文件或者在网络中传输,耗费了不必要的资源
     * 故而使用自定义序列化机制,仅写入索引为(0,size)的有效元素以节省资源
     * 默认的序列化机制会将非静态与非瞬时(非transient修饰)写入流中
     * @param s 输出流
     */
    private void writeObject(java.io.ObjectOutputStream s)
        throws java.io.IOException{
        int expectedModCount = modCount;
        //执行默认序列化过程
        s.defaultWriteObject();

        //写入元素个数
        s.writeInt(size);

        // 按顺序写入
        for (int i=0; i<size; i++) {
            s.writeObject(elementData[i]);
        }

        if (modCount != expectedModCount) {
            throw new ConcurrentModificationException();
        }
    }

    /**
     * 自定义反序列化
     * @param s 输入流
     */
    private void readObject(java.io.ObjectInputStream s)
        throws java.io.IOException, ClassNotFoundException {
        elementData = EMPTY_ELEMENTDATA;

        //执行默认的反序列化过程
        s.defaultReadObject();

        //要写读一个字节,因为是按顺序写入
        //因为已经执行了默认的反序列化过程,已经为size赋值了,故不用再次赋值
        s.readInt(); // ignored

        if (size > 0) {
            int capacity = calculateCapacity(elementData, size);
            SharedSecrets.getJavaOISAccess().checkArray(s, Object[].class, capacity);
            ensureCapacityInternal(size);

            //将流中的元素写入到数组中
            Object[] a = elementData;
            for (int i=0; i<size; i++) {
                a[i] = s.readObject();
            }
        }
    }

    /**
     * 遍历数组,并对数组中的元素进行指定处理
     * 在遍历过程中不允许修改结构,否则会抛出错误
     * @param action 函数式接口,对数组中的元素指定处理
     */
    public void forEach(Consumer<? super E> action) {
        Objects.requireNonNull(action);
        final int expectedModCount = modCount;
        @SuppressWarnings("unchecked")
        final E[] elementData = (E[]) this.elementData;
        final int size = this.size;
        for (int i=0; modCount == expectedModCount && i < size; i++) {
            action.accept(elementData[i]);
        }
        if (modCount != expectedModCount) {
            throw new ConcurrentModificationException();
        }
    }

    /**
     * 根据指定条件移除元素
     * 笔者对BitSet也是第一次接触,针对本文章它显的不是很重要,故而大概了解了一下
     *
     * 该方法中将满足条件的元素索引存放到BitSet中,同时记录移除元素的个数removeCount
     * 紧接着BitSet调用 nextClearBit方法,该方法根据指定的索引获取没有在BitSet中存放的下一个索引,直接上个例子吧
     * BitSet removeSet = new BitSet();
     * removeSet.set(1)
     * removeSet.set(2)
     * System.out.println(removeSet.nextClearBit(1))  --> 3
     *
     * 一开始已经在BitSet中存放了要移除的元素的索引,当调用nextClearBit方法循环遍历获取到的索引就是要保留的元素的索引
     * 故而直接获取元素的值将其存放到数组中,最后的数组是按照保留元素的顺序进行存放的
     *
     * 函数式接口中不能调用修改结构的方法
     * @param filter 使用指定条件来过滤元素
     * @return 是否移除成功
     */
    public boolean removeIf(Predicate<? super E> filter) {
        Objects.requireNonNull(filter);

        int removeCount = 0;
        final BitSet removeSet = new BitSet(size);
        final int expectedModCount = modCount;
        final int size = this.size;
        for (int i=0; modCount == expectedModCount && i < size; i++) {
            @SuppressWarnings("unchecked")
            final E element = (E) elementData[i];
            if (filter.test(element)) {
                removeSet.set(i);
                removeCount++;
            }
        }
        if (modCount != expectedModCount) {
            throw new ConcurrentModificationException();
        }

        // shift surviving elements left over the spaces left by removed elements
        final boolean anyToRemove = removeCount > 0;
        if (anyToRemove) {
            final int newSize = size - removeCount;
            for (int i=0, j=0; (i < size) && (j < newSize); i++, j++) {
                i = removeSet.nextClearBit(i);
                elementData[j] = elementData[i];
            }
            for (int k=newSize; k < size; k++) {
                elementData[k] = null;  // Let gc do its work
            }
            this.size = newSize;
            if (modCount != expectedModCount) {
                throw new ConcurrentModificationException();
            }
            modCount++;
        }

        return anyToRemove;
    }

    /**
     * 根据指定规则替换所有旧元素
     * operator.apply方法:旧元素作为入参传入,根据规则返回新元素,然后进行替换
     * operator.apply方法中不能调用修改结构的方法
     * @param operator 指定规则,函数式接口
     */
    public void replaceAll(UnaryOperator<E> operator) {
        Objects.requireNonNull(operator);
        final int expectedModCount = modCount;
        final int size = this.size;
        for (int i=0; modCount == expectedModCount && i < size; i++) {
            elementData[i] = operator.apply((E) elementData[i]);
        }
        if (modCount != expectedModCount) {
            throw new ConcurrentModificationException();
        }
        modCount++;
    }

    /**
     * 根据指定规则对数组中的元素进行排序
     * 若没有指定规则则使用默认的升序进行排序
     * 指定规则后会调用自定义比较器中的compare方法进行比较排序
     * @param c 自定义比较器,覆写compare方法
     */
    public void sort(Comparator<? super E> c) {
        final int expectedModCount = modCount;
        Arrays.sort((E[]) elementData, 0, size, c);
        if (modCount != expectedModCount) {
            throw new ConcurrentModificationException();
        }
        modCount++;
    }

    /**
     * 判断数组中是否包含指定集合中的所有元素
     * 但凡集合中有一个元素不存在数组中则返回false
     * @param c 指定集合
     * @return 数组中是否包含指定集合中的所有元素
     */
    public boolean containsAll(Collection<?> c) {
        for (Object e : c)
            if (!contains(e))
                return false;
        return true;
    }

    /**
     * 先判断当前对象与指定对象是否指向同一个对象,就是在判断地址
     * 紧接着判断指定对象属于List的子类
     * 紧接着获取两个对象的迭代器
     * 若两个迭代器的元素个数不相等,则返回false
     * 若两个迭代器的元素个数相等,则将两个迭代器的元素进行对应的比较,但凡出现对应的元素不相等则返回false
     * @param o 指定对象
     * @return 当前对象与指定对象是否相等
     */
    public boolean equals(Object o) {
        if (o == this)
            return true;
        if (!(o instanceof List))
            return false;

        ListIterator<E> e1 = listIterator();
        ListIterator<?> e2 = ((List<?>) o).listIterator();
        while (e1.hasNext() && e2.hasNext()) {
            E o1 = e1.next();
            Object o2 = e2.next();
            if (!(o1==null ? o2==null : o1.equals(o2)))
                return false;
        }
        return !(e1.hasNext() || e2.hasNext());
    }

    /**
     * 获取哈希值
     * @return 哈希值
     */
    public synchronized int hashCode() {
        return super.hashCode();
    }

    /**
     * 获取数组元素的字符串
     * @return 数组元素的字符串
     */
    public synchronized String toString() {
        return super.toString();
    }

    /**
     * 获取分割迭代器
     * 由于该方法涉及到另外一个接口,会另外新起一篇文章来讲解该内容,这里就不做阐述
     * 附上文章地址:http://zlia.tech/2019/08/28/explain-arraylist-spliterator-sourcecode
     * @return
     */
    public Spliterator<E> spliterator() {
        return new ArrayListSpliterator<>(this, 0, -1, 0);
    }

    default Stream<E> stream() {
        return StreamSupport.stream(spliterator(), false);
    }

    default Stream<E> parallelStream() {
        return StreamSupport.stream(spliterator(), true);
    }

迭代器

    /**
     * 返回一个包含指定索引到结尾之间的元素的列表迭代器
     * 元素之间按照顺序排序
     * @param index 起始索引
     * @return 包含元素的列表迭代器
     */
    public ListIterator<E> listIterator(int index) {
        if (index < 0 || index > size)
            throw new IndexOutOfBoundsException("Index: "+index);
        return new ListItr(index);
    }

    /**
     * 返回一个包含所有元素的列表迭代器
     * @return 包含元素的列表迭代器
     */
    public ListIterator<E> listIterator() {
        return new ListItr(0);
    }

    /**
     * 获取迭代器
     * @return 迭代器
     */
    public Iterator<E> iterator() {
        return new Itr();
    }

    /**
     * 迭代器,正向迭代
     * 通过判断是否存在下一个元素,若有则获取,若没有则说明迭代结束
     * @param E 元素类型
     */
    private class Itr implements Iterator<E> {
        //下一个元素的索引
        int cursor;
        //当前元素的索引
        int lastRet = -1;
        int expectedModCount = modCount;

        /**
         * 初始化
         */
        Itr() {}

        /**
         * 判断是否存在下一个元素
         * @return 是否存在下一个元素
         */
        public boolean hasNext() {
            return cursor != size;
        }

        /**
         * 获取下一个元素的值
         * @return 下一个元素的值
         */
        @SuppressWarnings("unchecked")
        public E next() {
            checkForComodification();
            int i = cursor;
            if (i >= size)
                throw new NoSuchElementException();
            Object[] elementData = ArrayList.this.elementData;
            if (i >= elementData.length)
                throw new ConcurrentModificationException();
            cursor = i + 1;
            return (E) elementData[lastRet = i];
        }

        /**
         * 移除迭代过程中当前索引的元素
         * 初始化时当前索引为 -1
         */
        public void remove() {
            if (lastRet < 0)
                throw new IllegalStateException();
            checkForComodification();

            try {
                ArrayList.this.remove(lastRet);
                cursor = lastRet;
                lastRet = -1;
                expectedModCount = modCount;
            } catch (IndexOutOfBoundsException ex) {
                throw new ConcurrentModificationException();
            }
        }

        /**
         * 遍历元素,只能遍历一次
         * 在遍历过程中调用remove方法需要注意,可能会抛出IllegalStateException异常
         * 在移除过程中 lastRet 成员变量可能为是 -1,故而会抛出异常
         * 与forEach的区别在于:可以遍历多次
         * @param consumer 函数式接口,声明如何处理元素的函数
         *
         * List<String> list = new ArrayList<>();
         * list.add("1");
         * list.add("2");
         * list.iterator().forEachRemaining(str -> {
         *   System.out.println("str:" + str);
         * });
         *
         * List<String> list = new ArrayList<>();
         * list.add("1");
         * list.add("2");
         * list.add("3");
         * list.add("4");
         * list.add("5");
         * Iterator<String> iterator = list.iterator();
         * while (iterator.hasNext()) {
         *  String nextValue = iterator.next();
         *  if (nextValue.equals("3")) {
         *      iterator.forEachRemaining(str -> {
         *          System.out.println("内层:" + str);
         *      });
         *  }
         *  System.out.println("外层:" + nextValue);
         * }
         *
         */
        @Override
        @SuppressWarnings("unchecked")
        public void forEachRemaining(Consumer<? super E> consumer) {
            Objects.requireNonNull(consumer);
            final int size = ArrayList.this.size;
            int i = cursor;
            if (i >= size) {
                return;
            }
            final Object[] elementData = ArrayList.this.elementData;
            if (i >= elementData.length) {
                throw new ConcurrentModificationException();
            }
            while (i != size && modCount == expectedModCount) {
                consumer.accept((E) elementData[i++]); //迭代过程中依次传入元素
            }
            cursor = i;
            lastRet = i - 1;
            checkForComodification();
        }

        /**
         * 初始化时 modCount 与 expectedModCount 是相等的
         * 但如果在遍历的过程修改数组结构的话,此时 modCount 会有所变化,导致两者不相等,故而抛出异常,也就是我们上面提到的fast-failed异常
         */
        final void checkForComodification() {
            if (modCount != expectedModCount)
                throw new ConcurrentModificationException();
        }
    }

    /**
     * 列表迭代器,正向迭代
     * 可获取上一个元素、下一个元素及索引
     */
    private class ListItr extends Itr implements ListIterator<E> {

        /**
         * 初始化参数
         */
        ListItr(int index) {
            super();
            cursor = index;
        }

        /**
         * 判断是否有前一个元素
         * @return 是否有前一个元素
         */
        public boolean hasPrevious() {
            return cursor != 0;
        }

        /**
         * 获取下一个元素的索引
         * @return 下一个元素的索引
         */
        public int nextIndex() {
            return cursor;
        }

        /**
         * 获取上一个元素的索引
         * @return 上一个元素的索引
         */
        public int previousIndex() {
            return cursor - 1;
        }

        /**
         * 获取上一个元素
         * 在获取过程中会判断该数组结构是否被修改
         * @return 上一个元素
         */
        @SuppressWarnings("unchecked")
        public E previous() {
            checkForComodification();
            int i = cursor - 1;
            if (i < 0)
                throw new NoSuchElementException();
            Object[] elementData = ArrayList.this.elementData;
            if (i >= elementData.length)
                throw new ConcurrentModificationException();
            cursor = i;
            return (E) elementData[lastRet = i];
        }

        /**
         * 随着遍历,索引是会向前移动,用指定元素替换索引处的元素
         * @param e 指定元素
         */
        public void set(E e) {
            if (lastRet < 0)
                throw new IllegalStateException();
            checkForComodification();

            try {
                ArrayList.this.set(lastRet, e);
            } catch (IndexOutOfBoundsException ex) {
                throw new ConcurrentModificationException();
            }
        }

        /**
         * 随着遍历,索引是会向前移动,将指定元素添加到下一个索引位置上
         * @param e 指定元素
         */
        public void add(E e) {
            checkForComodification();

            try {
                int i = cursor;
                ArrayList.this.add(i, e);
                cursor = i + 1;
                lastRet = -1;
                expectedModCount = modCount;
            } catch (IndexOutOfBoundsException ex) {
                throw new ConcurrentModificationException();
            }
        }
    }

要理解迭代器,很关键的一个点就是cursor,它的位置决定了你调用方法的结果!

子集

    /**
     * 获取指定起始索引到指定结束索引之间的元素,简称获取指定子集
     * 指定区间中的元素包括起始索引,不包括结束索引
     * 若起始索引与结束索引相等,则返回空元素
     * 对子集的操作,即调用set、add、remove等方法将会影响到整个数组
     * 但在先获取子集后,又对整个数组的结构进行修改,这时在遍历子集则会导致报错,而对于整体的非结构性修改则不会报错,不过依然会影响到子集
     * 所以在获取子集后最好不要修改数组的结构
     * @param fromIndex 起始索引
     * @param toIndex 结束索引
     * @return 指定区间中的所有元素,称为子集
     */
    public List<E> subList(int fromIndex, int toIndex) {
        subListRangeCheck(fromIndex, toIndex, size);
        return new SubList(this, 0, fromIndex, toIndex);
    }

    /**
     * 判断起始索引与结束索引
     * 该判断在子集中又获取子集时显得较为重要
     * @param fromIndex 起始索引
     * @param toIndex 结束索引
     * @param size 数组大小
     */
    static void subListRangeCheck(int fromIndex, int toIndex, int size) {
        if (fromIndex < 0)
            throw new IndexOutOfBoundsException("fromIndex = " + fromIndex);
        if (toIndex > size)
            throw new IndexOutOfBoundsException("toIndex = " + toIndex);
        if (fromIndex > toIndex)
            throw new IllegalArgumentException("fromIndex(" + fromIndex +
                                               ") > toIndex(" + toIndex + ")");
    }

    /**
     * 子集对象,支持随机访问
     *
     *  List<String> list = new ArrayList<>();
     *  list.add("1"); //0
     *  list.add("2"); //1
     *  list.add("3"); //2
     *  list.add("4"); //3
     *  list.add("5"); //4
     *  list.add("6"); //5
     *  list.add("7"); //6
     *  list.add("8"); //7
     *  list.add("9"); //8
     *  list.add("10"); //9
     *
     *  List<String> sub = list.subList(1,9);
     *  0,1,2,3,4,5,6,7
     *  2,3,4,5,6,7,8,9
     *
     *  sub.subList(2,8);
     *  0,1,2,3,4,5
     *  4,5,6,7,8,9
     *
     * 以上提供的方法只要是帮助大家去理解子集又获取子集的例子,其中加入了索引(上)及索引对应的元素(下)
     *
     */
    private class SubList extends AbstractList<E> implements RandomAccess {

        /**
         * 指向调用者的引用,该变量特别是在子集中又子集时很关键,决定了是否理解该功能的重要因素
         * ArrayList -> subList -> subList
         * 当第一次调用subList获取子集时,为了方便理解,称为子集1,这个时候子集1中的parent指向了ArrayList,这点比较好理解
         * 当子集1又获取子集时,称为子集2,这个时候子集2中的parent指向了子集1,依次类推
         * 如果你仔细看了下面的方法后,你会知道它是如何调用的?例如子集2中调用add方法
         * 子集2#add -> parent#add = 子集1#add -> parent#add = ArrayList#add,最终都会调用到最上层类
         *
         * 那么为什么要这么设计呢?何不子集2#add -> ArrayList#add 这样子的调用呢?
         * 理由在于modCount,它是指数组结构被修改的次数,这边就不再阐述何为结构被修改,假设下若按照 子集2#add -> ArrayList#add这样子的顺序调用的话
         * ArrayList#modCount会正常变化,子集2#modCount也会正常变化,可参考add方法中的 this.modCount = parent.modCount 代码片段,
         * 按照上面的假设,此时只有ArrayList与子集2的modCount正常变化,但是子集1却没有变化,那当你在遍历子集1时,它会首先判断子集1的modCount是否与ArrayList的modCount相等
         * 若不相等,则抛出异常,具体可看 checkForComodification 方法,所以子集2#add时,也必须同时修改子集1的modCount,故而如此设计
         *
         * 有一个点关键,我们说是因为modCount,而只有结构修改了modCount才会变化,才需要如此调用,那么如果modCount没有被修改呢?
         * 那就不需要那么麻烦了,调用流程就是我们所假设的如此了 子集2#add -> ArrayList#add
         *
         * 所以两种设计就用到了两个变量:parentOffset、offset
         * 两个变量分别针对两种方式去调用
         */
        private final AbstractList<E> parent;

        /**
         * 当前子集索引与父子集索引的偏移量,简单地说就是子集2与子集1的索引偏移量,有一个等式
         * index2:子集2的索引  parentOffset2:子集2的属性
         * index1:子集1的索引  parentOffset1:子集1的属性
         * index3:ArrayList的索引
         * parentOffset2 + index2 = index1 + parentOffset1 = index3
         * 做了那么多,无非就是把子集1与子集2与ArrayList三者关联起来
         */
        private final int parentOffset;

        /**
         * 当前子集索引与ArrayList索引的偏移量,简单地说就是子集2与ArrayList的索引偏移量
         * 在创建子集2时,会把子集1与ArrayList的索引偏移量传给子集2,接着在加上子集2与子集1的索引偏移量就可以得到子集2与ArrayList的索引偏移量
         *
         * offset2:子集2与子集1的索引偏移量(fromIndex)
         * offset1:子集1与ArrayList的索引偏移量(offset)
         * offset:当前子集,也就是子集2与ArrayList的索引偏移量
         * offset2 + offset1 = offset
         */
        private final int offset;

        /**
         * 子集的元素个数
         */
        int size;

        /**
         * 初始化参数
         * @param parent 调用者
         * @param offset 当前子集与ArrayList的索引偏移量
         * @param fromIndex 子集的起始索引
         * @param toIndex 子集的结束索引
         */
        SubList(AbstractList<E> parent,
                int offset, int fromIndex, int toIndex) {
            this.parent = parent;
            this.parentOffset = fromIndex;
            this.offset = offset + fromIndex;
            this.size = toIndex - fromIndex;
            this.modCount = ArrayList.this.modCount;
        }

        /**
         * 将指定元素替换子集中的指定索引
         * 指定索引的大小是相对于子集,故而加上offset
         * 由于该方法并没有修改结构,故而直接调用ArrayList的对应方法
         * @param index 相对于子集的索引
         * @param e 指定元素
         * @return 旧元素
         */
        public E set(int index, E e) {
            rangeCheck(index);
            checkForComodification();
            E oldValue = ArrayList.this.elementData(offset + index);
            ArrayList.this.elementData[offset + index] = e;
            return oldValue;
        }

        /**
         * 获取子集中指定索引对应的元素
         * 指定索引的大小是相对于子集,故而加上offset
         * 由于该方法并没有修改结构,故而直接调用ArrayList的对应方法
         * @param index 相对于子集的索引
         * @return 指定索引对应的元素
         */
        public E get(int index) {
            rangeCheck(index);
            checkForComodification();
            return ArrayList.this.elementData(offset + index);
        }

        /**
         * 获取子集的元素个数
         */
        public int size() {
            checkForComodification();
            return this.size;
        }

        /**
         * 子集中指定索引上添加元素
         * 由于该方法修改了数组结构,故而先调用上层子集的add方法,若没有子集则直接是ArrayList
         * @param index 相对于子集的索引
         * @param e 添加的元素
         */
        public void add(int index, E e) {
            rangeCheckForAdd(index);
            checkForComodification();
            parent.add(parentOffset + index, e);
            this.modCount = parent.modCount;
            this.size++;
        }

        /**
         * 移除子集中指定索引位置的元素
         * 由于该方法修改了数组结构,故而先调用上层子集的remove方法,若没有子集则直接是ArrayList
         * @param index 相对于子集的索引
         * @return 移除的元素
         */
        public E remove(int index) {
            rangeCheck(index);
            checkForComodification();
            E result = parent.remove(parentOffset + index);
            this.modCount = parent.modCount;
            this.size--;
            return result;
        }

        /**
         * 移除子集中指定索引范围的所有元素
         * 由于该方法修改了数组结构,故而先调用上层子集的removeRange方法,若没有子集则直接是ArrayList
         * @param fromIndex 相对于子集的起始索引
         * @param toIndex 相对于子集的结束索引
         */
        protected void removeRange(int fromIndex, int toIndex) {
            checkForComodification();
            parent.removeRange(parentOffset + fromIndex,
                               parentOffset + toIndex);
            this.modCount = parent.modCount;
            this.size -= toIndex - fromIndex;
        }

        /**
         * 子集末尾上追加集合
         * @param c 集合
         * @return 是否添加成功
         */
        public boolean addAll(Collection<? extends E> c) {
            return addAll(this.size, c);
        }

        /**
         * 子集中指定索引上添加集合
         * @param index 相对于子集的索引
         * @param c 集合
         * @return 是否添加成功
         */
        public boolean addAll(int index, Collection<? extends E> c) {
            rangeCheckForAdd(index);
            int cSize = c.size();
            if (cSize==0)
                return false;

            checkForComodification();
            parent.addAll(parentOffset + index, c);
            this.modCount = parent.modCount;
            this.size += cSize;
            return true;
        }

        /**
         * 获取子集迭代器
         * @return 子集迭代器
         */
        public Iterator<E> iterator() {
            return listIterator();
        }

        /**
         * 获取子集列表迭代器
         * 列表迭代器中的元素是从指定索引开始到结束索引
         * 这里就不对子集列表迭代器中的方法做再次解释了,毕竟它跟ArrayList是类似的
         * @param index 相对于子集的索引
         * @return 列表迭代器
         */
        public ListIterator<E> listIterator(final int index) {
            checkForComodification();
            rangeCheckForAdd(index);
            final int offset = this.offset;

            return new ListIterator<E>() {
                int cursor = index;
                int lastRet = -1;
                int expectedModCount = ArrayList.this.modCount;

                public boolean hasNext() {
                    return cursor != SubList.this.size;
                }

                @SuppressWarnings("unchecked")
                public E next() {
                    checkForComodification();
                    int i = cursor;
                    if (i >= SubList.this.size)
                        throw new NoSuchElementException();
                    Object[] elementData = ArrayList.this.elementData;
                    if (offset + i >= elementData.length)
                        throw new ConcurrentModificationException();
                    cursor = i + 1;
                    return (E) elementData[offset + (lastRet = i)];
                }

                public boolean hasPrevious() {
                    return cursor != 0;
                }

                @SuppressWarnings("unchecked")
                public E previous() {
                    checkForComodification();
                    int i = cursor - 1;
                    if (i < 0)
                        throw new NoSuchElementException();
                    Object[] elementData = ArrayList.this.elementData;
                    if (offset + i >= elementData.length)
                        throw new ConcurrentModificationException();
                    cursor = i;
                    return (E) elementData[offset + (lastRet = i)];
                }

                @SuppressWarnings("unchecked")
                public void forEachRemaining(Consumer<? super E> consumer) {
                    Objects.requireNonNull(consumer);
                    final int size = SubList.this.size;
                    int i = cursor;
                    if (i >= size) {
                        return;
                    }
                    final Object[] elementData = ArrayList.this.elementData;
                    if (offset + i >= elementData.length) {
                        throw new ConcurrentModificationException();
                    }
                    while (i != size && modCount == expectedModCount) {
                        consumer.accept((E) elementData[offset + (i++)]);
                    }
                    // update once at end of iteration to reduce heap write traffic
                    lastRet = cursor = i;
                    checkForComodification();
                }

                public int nextIndex() {
                    return cursor;
                }

                public int previousIndex() {
                    return cursor - 1;
                }

                public void remove() {
                    if (lastRet < 0)
                        throw new IllegalStateException();
                    checkForComodification();

                    try {
                        SubList.this.remove(lastRet);
                        cursor = lastRet;
                        lastRet = -1;
                        expectedModCount = ArrayList.this.modCount;
                    } catch (IndexOutOfBoundsException ex) {
                        throw new ConcurrentModificationException();
                    }
                }

                public void set(E e) {
                    if (lastRet < 0)
                        throw new IllegalStateException();
                    checkForComodification();

                    try {
                        ArrayList.this.set(offset + lastRet, e);
                    } catch (IndexOutOfBoundsException ex) {
                        throw new ConcurrentModificationException();
                    }
                }

                public void add(E e) {
                    checkForComodification();

                    try {
                        int i = cursor;
                        SubList.this.add(i, e);
                        cursor = i + 1;
                        lastRet = -1;
                        expectedModCount = ArrayList.this.modCount;
                    } catch (IndexOutOfBoundsException ex) {
                        throw new ConcurrentModificationException();
                    }
                }

                final void checkForComodification() {
                    if (expectedModCount != ArrayList.this.modCount)
                        throw new ConcurrentModificationException();
                }
            };
        }

        /**
         * 获取子集
         * 子集中又获取子集
         * @param fromIndex 相对于子集的起始索引
         * @param toIndex 相对于子集的结束索引
         * @return 子集
         */
        public List<E> subList(int fromIndex, int toIndex) {
            subListRangeCheck(fromIndex, toIndex, size);
            return new SubList(this, offset, fromIndex, toIndex);
        }

        /**
         * 校验索引是否超出范围
         * @param index 相对于子集的索引
         */
        private void rangeCheck(int index) {
            if (index < 0 || index >= this.size)
                throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
        }

        /**
         * 校验索引是否超出范围
         * @param index 相对于子集的索引
         */
        private void rangeCheckForAdd(int index) {
            if (index < 0 || index > this.size)
                throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
        }

        /**
         * 索引超出范围的错误信息
         * @param index 相对于子集的索引
         * @return 错误信息
         */
        private String outOfBoundsMsg(int index) {
            return "Index: "+index+", Size: "+this.size;
        }

        /**
         * 校验子集的结构修改次数是否与ArrayList一致
         * 若先获取子集后,接着在ArrayList上修改了结构,则会报错
         * 因为子集的modCount并没有随着ArrayList结构的修改而变化,导致了两个变量不一致
         */
        private void checkForComodification() {
            if (ArrayList.this.modCount != this.modCount)
                throw new ConcurrentModificationException();
        }

        /**
         * 由于该方法涉及到另外一个接口,会另外新起一篇文章来讲解该内容,这里就不做阐述
         * 附上文章地址:http://zlia.tech/2019/07/19/explain-arraylist-spliterator-sourcecode/
         */
        public Spliterator<E> spliterator() {
            checkForComodification();
            return new ArrayListSpliterator<E>(ArrayList.this, offset,
                                               offset + this.size, this.modCount);
        }
    }

其他方法

    public class Arrays {

        /**
         * 拷贝指定数组到新数组中,根据指定的长度缩短或使用null扩充新数组
         * 新数组与原始数组的数据类型是完全一样的
         */
        public static <T> T[] copyOf(T[] original, int newLength) {
            return (T[]) copyOf(original, newLength, original.getClass());
        }

        /**
         * 拷贝指定数组到新数组中,根据指定的长度缩短或使用null扩充新数组
         * 新数组的数据类型由入参newType决定
         * 判断入参newType是否是Ojbect[]类型
         * 若newType是Object[]类型,则创建一个长度为newLength的新数组,并向下转型为T[]类型
         * 若newType不是Object[]类型,则创建一个长度为newLength的新数组,但由于Array.newInstance返回值是Object,故而向下转型为T[]类型
         * Array.newInstance与System.arraycopy属于C底层代码,故而查看不了具体实现
         * System.arraycopye(param1, param2, param3, param4, param5)
         * param1:原始数组; param2:原始数组复制元素的起始角标; param3:新数组; param4:复制元素到新数组的起始角标处;param5:原始数组要从起始角标开始拷贝多少个元素到新数组
         * 从原始数组param1的角标为param2开始复制param5个元素,到新数组param3的角标为param4作为复制元素的起始点
         * 返回新数组,此时已经填充好数据
         *
         * System.arraycopy性能趋势:当数组大小在百万到千万级别之间时所花费的时间差别不大,但是当达到亿级别后,所花费的时间就会差很多
         * 所以这也就导致了当数组容量达到亿级别后,手动调用ensureCapacity来预先设置容量大小所带来的效率比自动扩容的销量要低很多
         */
        public static <T,U> T[] copyOf(U[] original, int newLength, Class<? extends T[]> newType) {
            @SuppressWarnings("unchecked")
            T[] copy = ((Object)newType == (Object)Object[].class) ? (T[]) new Object[newLength] : (T[]) Array.newInstance(newType.getComponentType(), newLength);
            System.arraycopy(original, 0, copy, 0, Math.min(original.length, newLength));
            return copy;
        }
    }

总结

写的内容有点过多,这里总结一下,方便获取直接获取结果

  • ArrayList允许存放Null。

  • ArrayList内部通过数组实现,大体上和Vector类似,除了是非线程安全。

  • ArrayList中的size、isEmpty、get、set、iterator、listIterator的时间复杂度是O(1),而add操作的时间复杂度是O(n)。

  • 由于ArrayList是非线程安全,所以多线程情况下要在外部控制线程安全或使用Collections.synchronizedList也行。

  • 创建空参数的ArrayList对象时,默认的初始容量是10,当容量不足时,以1.5倍速度增长。

  • 在构建ArrayList对象时,最好能预先设置容量大小,以免减少后期扩容花费的时间。

  • ArrayList容量的临界值是最大值 - 8,这个数字8是因为在数组中除了存储元素之外还会存储数组的长度,而这些数据都在内存中,不同操作系统对内存的分配可能有所差异,减去8更多的是为了防止内存溢出。

  • ArrayList的Iterator迭代器中的forEachRemaining方法只能调用一次,且在该方法中不能调用remove方法。

  • ArrayList的ListIterator迭代器可反向遍历列表。

  • 在获取ArrayList的子集后不能在做结构上的修改。

  • 获取迭代器后,不允许进行结构修改操作,因为会 expectedModCount 与 modCount 是否相等。

  • 在遍历过程中不允许修改结构,否则会抛出错误。

重点关注

默认每次自动扩容的关系是1.5倍 非线程安全 默认初始扩容值10 get/set时间复杂度O(1),add时间复杂度O(n) 底层是通过数组存储元素,故是有序可重复集合

(0)

相关推荐