源码解读：ArrayList源码解析（JDK8）

Posted 2021-03-07 le-le

ArrayList源码解析（JDK8）

更详细的讲解可以参考这篇博文，本文只讲解在阅读源码中个人遇到的问题。

面试必备：ArrayList源码解析（JDK8）

构造函数

    /**
     * ArrayList容器默认初始容量
     */
    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

    /**
     * 存储的元素数量
     * @serial
     */
    private int size;

    //无参构造
    public ArrayList() {
        //将空数组赋值给elementData
        this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;
    }

    //指定初始化容量的构造
    public ArrayList(int initialCapacity) {
        //如果初始容量大于0，则新建一个长度为initialCapacity的Object数组.
        if (initialCapacity > 0) {
            this.elementData = new Object[initialCapacity];
        } else if (initialCapacity == 0) {
            //如果容量为0，直接将EMPTY_ELEMENTDATA赋值给elementData
            this.elementData = EMPTY_ELEMENTDATA;
        } else {
            //容量小于0，直接抛出异常
            throw new IllegalArgumentException("Illegal Capacity: "+
                                               initialCapacity);
        }
    }

    //利用别的集合类来构建ArrayList的构造函数
    public ArrayList(Collection<? extends E> c) {
        //直接利用Collection.toArray()方法得到一个对象数组，并赋值给elementData
        elementData = c.toArray();
        //因为size代表的是集合元素的数量，所以通过别的集合来构造ArrayList时，要给size赋值
        if ((size = elementData.length) != 0) {
            // 因爲不同的类型使用toArray方法返回的不一定是Object类型
            // c.toArray might (incorrectly) not return Object[] (see 6260652)
            // 这里是当c.toArray出错，没有返回Object[]时，
            if (elementData.getClass() != Object[].class)
                //利用Arrays.copyOf把集合c中的元素复制到elementData数组中
                elementData = Arrays.copyOf(elementData, size, Object[].class);
        } else {
            // replace with empty array.
            // 如果集合c元素数量为0，则将空数组EMPTY_ELEMENTDATA赋值给elementData
            this.elementData = EMPTY_ELEMENTDATA;
        }
    }

第三个构造函数有一行判断if (elementData.getClass() != Object[].class)，当toArray（）没有返回Object类型的数组时，数组elementData中的元素类型转换为Object类型。但是看ArrayList源码中的toArray（），明确表示返回Object类型数组，为什么会出错呢？

    /*
    集合转数组，Arrays.copyOf()
     */
    public Object[] toArray() {
        return Arrays.copyOf(elementData, size);
    }

因为由于继承的原因，我们父类实例的具体类型，实际上是取决于在 new 时，我们所使用的子类类型。也就是说假如我们有 1 个Object[]数组，并不代表着我们可以将Object对象存进去，这取决于数组中元素实际的类型。

具体可以参考这篇博文 Java笔记---c.toArray might (incorrectly) not return Object[] (see 6260652)官方Bug

常用API

增

    public boolean add(E e) {
        //因为要添加元素，所以添加之后可能导致容量不够，所以需要在添加之前进行判断（扩容）
        //其作用为保证数组的容量始终够用，其中size是elementData数组中元素的个数，第一次添加为0。
        ensureCapacityInternal(size + 1);  // Increments modCount!!
        elementData[size++] = e; //在数组末尾追加一个元素，并修改size
        return true;
    }

    /*
    * 扩容判断
    */
    private void ensureCapacityInternal(int minCapacity) {
        ensureExplicitCapacity(calculateCapacity(elementData, minCapacity));
    }
    /*
    * 计算最小所需容量
    */
    private static int calculateCapacity(Object[] elementData, int minCapacity) {
            //无参构造第一次添加返回10
            //那么比较size+1（集合元素的总数+1）和DEFAULT_CAPACITY(10)，返回大的值
            if (elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA) {
                return Math.max(DEFAULT_CAPACITY, minCapacity);
            }
            //但当add()第2个元素时，数组非空，直接返回size+1，此时minCapacity为2。
            return minCapacity;
    }

这里的elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA判断用于无参构造，返回最小容量10

有参构造使用的空数组与构造使用的空数组不是一个对象，所以第一次添加直接返回minCapacity = 1

    /**
     * 判断需不需要扩容
     * @param minCapacity
     */
    private void ensureExplicitCapacity(int minCapacity) {
            modCount++ ;//用于存储修改次数

        // overflow-conscious code
        //如果数组的长度(elementData.length)小于需要的最小容量(minCapacity)，就扩容
        if (minCapacity - elementData.length > 0)
            grow(minCapacity);
    }

扩容函数（重点！！！！）

    private void grow(int minCapacity) {
        // overflow-conscious code
        int oldCapacity = elementData.length;
        //右移一位相当于原数除以2，位运算的计算方式更快
        //所以新容量扩大为原容量的1.5倍
        int newCapacity = oldCapacity + (oldCapacity >> 1);
        //从minCapacity和这个newCapacity中取较大值作为扩容后的新数组长度（新容量）。
        //这主要是针对添加第1个元素。1.5倍oldCapacity为0，所以newCapacity为最小容量10
        //扩容后还不够，那么就用 能容纳的最小的数量。（add后的容量）
        if (newCapacity - minCapacity < 0)
            newCapacity = minCapacity;
        //如果新的数组容量大于数组的最大size（Integer.MAX_VALUE - 8），进入hugeCapacity方法
        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) {
        //对最小所需容量和MAX_ARRAY_SIZE进行比较
        //若minCapacity大，将Integer.MAX_VALUE作为新数组的大小
        //若MAX_ARRAY_SIZE大，将MAX_ARRAY_SIZE作为新数组的大小
        if (minCapacity < 0) // overflow
            throw new OutOfMemoryError(); //minCapacity < 0 ,抛异常内存溢出
        return (minCapacity > MAX_ARRAY_SIZE) ?
            Integer.MAX_VALUE :
            MAX_ARRAY_SIZE;
    }

扩容函数就是确认新数组的容量，先将容量定为旧数组的1.5倍。不够的话就采用最小所需容量，超过允许的最大容量的话进入hugeCapacity（）。这里最大允许容量为什么是（Integer.MAX_VALUE - 8）呢？源码中这样解释

/**
 * The maximum size of array to allocate.
 * Some VMs reserve some header words in an array.
 * Attempts to allocate larger arrays may result in
 * OutOfMemoryError: Requested array size exceeds VM limit
 * 有些虚拟机在数组中保留了一些头信息。防止内存溢出
 */

所以说，只有当需要的容量大于MAX_ARRAY_SIZE才会将新数组容量设为Integer.MAX_VALUE - 8

删除

    /*
    根据索引删除
     */
    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);
        //尾部数据置空，size-1，可以GC掉
        elementData[--size] = null; // clear to let GC do its work
        //返回删除掉的值
        return oldValue;
    }

删除就是直接将index的后序元素向前移动一个位置，最后再将尾部元素置空并且返回旧值

    /*
    根据传入的对象删除
    对象是否为空都使用fastRemove
     */
    public boolean remove(Object o) {
        //o == null
        if (o == null) {
            for (int index = 0; index < size; index++)
                if (elementData[index] == null) {
                    fastRemove(index);//根据index删除元素
                    return true;
                }
        } else {
            //o ！= null
            for (int index = 0; index < size; index++)
                if (o.equals(elementData[index])) {
                    fastRemove(index);
                    return true;
                }
        }
        return false;
    }
    /*
    根据索引移动数组
    */
    private void fastRemove(int index) {
        //不会越界，不用判断
        //modCount+1    
        modCount++;
        int numMoved = size - index - 1;//计算要移动的元素数量
        //复制覆盖元素
        if (numMoved > 0)
            System.arraycopy(elementData, index+1, elementData, index,
                             numMoved);
        //数组尾部置空，size-1，可GC
        elementData[--size] = null; // clear to let GC do its work
    }

当o == null时，o.equals()会抛空指针异常，所以这里要区分o的类型。

因为在数组范围内遍历查找，所以不会越界。

迭代器

    public Iterator<E> iterator() {
            return new Itr();
        }
    private class Itr implements Iterator<E> {
        int cursor;       // index of next element to return 下一个要返回的元素下标，默认是0
        int lastRet = -1; // index of last element returned; -1 if no such 上一个返回的元素下标
        int expectedModCount = modCount;

        Itr() {}

        public boolean hasNext() {
            return cursor != size; //游标是否移动到尾部
        }

        @SuppressWarnings("unchecked")
        public E next() {
            checkForComodification();
            int i = cursor; //i用于存储本次遍历的元素下标
            if (i >= size) //下标越界判断,抛元素找不到异常
                throw new NoSuchElementException();
            Object[] elementData = ArrayList.this.elementData;
            if (i >= elementData.length) //判断越界，可能有线程修改了List
                throw new ConcurrentModificationException();
            //更新cursor
            cursor = i + 1;
            //返回元素 ，并设置上一次返回的元素的下标
            return (E) elementData[lastRet = i];
        }
        //remove掉上一个遍历到的元素
        public void remove() {
            //越界判断
            if (lastRet < 0)
                throw new IllegalStateException();
            //List是是否被修改
            checkForComodification();

            try {
                //调用remove(index);
                ArrayList.this.remove(lastRet);
                cursor = lastRet; //更新游标cursor，目的就是不要发生自增。
                lastRet = -1;   //防止没有next()的情况下连续remove()，只有再次执行next()才会刷新lastRet
                expectedModCount = modCount; //更新expectedModCount
            } catch (IndexOutOfBoundsException ex) {
                throw new ConcurrentModificationException();
            }
        }

        @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++]);
            }
            // update once at end of iteration to reduce heap write traffic
            cursor = i;
            lastRet = i - 1;
            checkForComodification();
        }

        //判断是否修改过了List的结构，如果有修改，抛出异常
        final void checkForComodification() {
            //expectedModCount表示对ArrayList修改次数的期望值，它的初始值为modCount。
            //迭代遍历过程中修改了集合会抛异常
            if (modCount != expectedModCount)
                throw new ConcurrentModificationException();
        }
    }

因为ArrayList没有同步手段，所以是线程不安全的，这里使用一个变量expectedModCount用来确保在迭代过程中集合元素没有改变。

总体而言，ArrayList的大部分源码还是比较好理解的，也没有什么太多的问题。