记录学习ArrayList源码过程

Java集合（JDK8） ArrayList篇
首先先看看ArrayList的继承关系

下面来看看每个方法的具体实现
1、带整数的构造方法

  public ArrayList(int initialCapacity) {
         /**
         判断initialCapacity是否大于0,大于0则创建一个initialCapacity大小的数组，等于0则使用空数组，小于0则抛出异常
         **/
        if (initialCapacity > 0) {
            this.elementData = new Object[initialCapacity];
        } else if (initialCapacity == 0) {
            this.elementData = EMPTY_ELEMENTDATA;
        } else {
            throw new IllegalArgumentException("Illegal Capacity: "+
                                               initialCapacity);
        }
    }

该构造方法可以创建一个初始化大小的链表，如果我们可以预期所要存储的数据量大小时，建议用该方法来创建一个链表。避免了后面由于容量不够时需要扩容带来的资源消耗。但也不能创建太大，会浪费内存，够用就行。
2、无参的构造方法

/**
     * Constructs an empty list with an initial capacity of ten.
     */
public ArrayList() {
   /**
    注释上写着是创建一个容量为10的空链表，但是我们看看
     DEFAULTCAPACITY_EMPTY_ELEMENTDATA却是一个空数组，
    因为它是在第一次添加元素进去时才将数组初始化为10
    (不清楚这样做跟直接创建一个容量为10的链表有什么不同)
  **/
        this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;
    }
     private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};

3、以一个集合为参数的构造方法

 public ArrayList(Collection<? extends E> c) {
        //将collection集合转化为数组
        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;
        }
    }

其中这里的注释// c.toArray might (incorrectly) not return Object[] (see 6260652)可以参看下这篇博客 链接地址
4、添加一个元素，这里是添加到数组的末尾，如果数组容量不够则进行扩容。

  public boolean add(E e) {
        //判断是否需要扩容
        ensureCapacityInternal(size + 1);  // Increments modCount!!
        elementData[size++] = e;
        return true;
    }

   private void grow(int minCapacity) {
        // overflow-conscious code
        int oldCapacity = elementData.length;
        //扩容时先将数组的容量扩大为原来的1.5倍
        int newCapacity = oldCapacity + (oldCapacity >> 1);
        //如果还是不够则直接扩大到刚好满足。
        if (newCapacity - minCapacity < 0)
            newCapacity = minCapacity;
         //MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8，
         //这里减8是因为有些jvm存储数组时会需要在头部存储其他的信息，防止超过jvm所限制内存的大小
         //如果大于Integer.MAX_VALUE - 8则扩容到Integer.MAX_VALUE
        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);
    }

5、在指定位置添加元素

 public void add(int index, E element) {
     //先判断index是否非法。
        rangeCheckForAdd(index);
        //判断是否需要扩容
        ensureCapacityInternal(size + 1);  // Increments modCount!!
        //将index开始的数往后移一位
        System.arraycopy(elementData, index, elementData, index + 1,
                         size - index);
        //
        elementData[index] = element;
        size++;
    }

6、将一个collection集合内的元素添加到链表中

public boolean addAll(Collection<? extends E> c) {
        //将collection集合转化为数组
        Object[] a = c.toArray();
        int numNew = a.length;
        //判断是否需要扩容
        ensureCapacityInternal(size + numNew);  // Increments modCount
        //将数组a中的元素复制到链表中
        System.arraycopy(a, 0, elementData, size, numNew);
        size += numNew;
        return numNew != 0;
    }

其实就是先将collection转化为数组，再将数组内的元素复制过来
7、将一个collection集合内的元素添加到链表指定的位置中

public boolean addAll(int index, Collection<? extends E> c) {
        //判断index是否合法
        rangeCheckForAdd(index);

        Object[] a = c.toArray();
        int numNew = a.length;
        //判断是否需要扩容
        ensureCapacityInternal(size + numNew);  // Increments modCount

        int numMoved = size - index;
        //将index开始的数往后移动numNew位，一共移动numMoved个数
        if (numMoved > 0)
            System.arraycopy(elementData, index, elementData, index + numNew,
                             numMoved);
        //将数组a的元素复制到链表中
        System.arraycopy(a, 0, elementData, index, numNew);
        size += numNew;
        return numNew != 0;
    }

8、清空链表的元素

  /**
     * Removes all of the elements from this list.  The list will
     * be empty after this call returns.
     */
    public void clear() {
        modCount++;

        // clear to let GC do its work
        //这里将每个元素都设置为null，是为了让当前引用不指向对象
        //可以让jvm的垃圾回收机制回收链表内的对象
        for (int i = 0; i < size; i++)
            elementData[i] = null;

        size = 0;
    }

9、克隆一个链表

/**
     * Returns a shallow copy of this <tt>ArrayList</tt> instance.  (The
     * elements themselves are not copied.)
     *
     * @return a clone of this <tt>ArrayList</tt> instance
     */
    public Object clone() {
        try {
            //克隆链表的基本数据，
            ArrayList<?> v = (ArrayList<?>) super.clone();
            //复制链表的数组（数组里存放的对象没有克隆，所以是浅克隆，
            //两个链表操作的虽然是不同的数组，但存放的却是相同的对象）
            v.elementData = Arrays.copyOf(elementData, size);
            v.modCount = 0;
            return v;
        } catch (CloneNotSupportedException e) {
            // this shouldn't happen, since we are Cloneable
            throw new InternalError(e);
        }
    }

10、判断对象是否在链表中

 public boolean contains(Object o) {
        return indexOf(o) >= 0;
    }

 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++)
                //调用equals()方法判断两个对象是否相等
                if (o.equals(elementData[i]))
                    return i;
        }
        return -1;
    }

这里还有一个找出最后出现的元素的方法

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

11、通过下标获取元素

 @SuppressWarnings("unchecked")
    E elementData(int index) {
        return (E) elementData[index];
    }

    /**
     * Returns the element at the specified position in this list.
     *
     * @param  index index of the element to return
     * @return the element at the specified position in this list
     * @throws IndexOutOfBoundsException {@inheritDoc}
     */
    public E get(int index) {
        //检查index是否合法
        rangeCheck(index);
        //调用elementData方法获取下标为index的元素
        return elementData(index);
    }

12、删除指定位置的元素

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);
        //释放对象的引用，好让jvm的垃圾回收机制回收该对象
        elementData[--size] = null; // clear to let GC do its work

        return oldValue;
    }

13、删除指定的对象

 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++)
            //用equals方法判断连个对象是否相等，再调用快速删除方法删除元素
                if (o.equals(elementData[index])) {
                    fastRemove(index);
                    return true;
                }
        }
        return false;
    }

 /**
     * Private remove method that skips bounds checking and does not
     * return the value removed.
     * 快速删除方法和remove(int index)方法不同的地方就是不同检查
     * 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
    }

14、删除在集合collection中出现的元素

public boolean removeAll(Collection<?> c) {
        //判断集合c是否为空
        Objects.requireNonNull(c);
        //批量删除
        return batchRemove(c, false);
    }

//complement为false时删除在c出现元素，为true时则保留
 private boolean batchRemove(Collection<?> c, boolean complement) {
        final Object[] elementData = this.elementData;
        int r = 0, w = 0;
        boolean modified = false;
        try {
    //遍历链表中的每个元素，根据complement判断如果有在集合c中出现时是该删除还是保留
            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.
            //如果操作失败了，直接将r后面的元素往前移动
            if (r != size) {
                System.arraycopy(elementData, r,
                                 elementData, w,
                                 size - r);
                w += size - r;
            }
            //释放掉已被删除的元素
            if (w != size) {
                // clear to let GC do its work
                for (int i = w; i < size; i++)
                    elementData[i] = null;
                modCount += size - w;
                size = w;
                modified = true;
            }
        }
        return modified;
    }

15、保留在集合collection出现的元素

 public boolean retainAll(Collection<?> c) {
        Objects.requireNonNull(c);
        //调用bathRemove来处理，complement设置为true
        return batchRemove(c, true);
    }

16、将链表维护的数组的大小缩小到刚好满足当前元素存放

  /**
     * Trims the capacity of this <tt>ArrayList</tt> instance to be the
     * list's current size.  An application can use this operation to minimize
     * the storage of an <tt>ArrayList</tt> instance.
     */
    public void trimToSize() {
        //记录链表的大小被修改
        modCount++;
        if (size < elementData.length) {
            //如果是空链表则直接将数组设为空，否则复制链表的有效元素
            elementData = (size == 0)
              ? EMPTY_ELEMENTDATA
              : Arrays.copyOf(elementData, size);
        }
    }

17、将链表转化为数组

 public Object[] toArray() {
         //调用Arrays的copyOf方法
         //直接复制链表里的有效元素
        return Arrays.copyOf(elementData, size);
    }

//复制链表的元素到指定的数组中
 public <T> T[] toArray(T[] a) {
        //如果指定的数组的大小小于链表的大小，
        //就调用Arrays的copyOf方法
        //直接复制链表里的有效元素
        if (a.length < size)
            // Make a new array of a's runtime type, but my contents:
            return (T[]) Arrays.copyOf(elementData, size, a.getClass());
         //否则就将链表里的有效元素复制到指定的数组中
        System.arraycopy(elementData, 0, a, 0, size);
        //并把第size个元素设置为null，如果知道链表里的元素不为null,
        //可以通过判断当前元素是否为空来作为遍历数组的结束标志
        if (a.length > size)
            a[size] = null;
        return a;
    }

18、将链表里的元素排序

 @Override
    @SuppressWarnings("unchecked")
     //以一个comparator作为一个排序规则
    public void sort(Comparator<? super E> c) {
        //记录排序前的modCount
        final int expectedModCount = modCount;
        //进行排序
        Arrays.sort((E[]) elementData, 0, size, c);
        //判断排序过程中链表的大小是否被修改（添加，删除元素）
        if (modCount != expectedModCount) {
            throw new ConcurrentModificationException();
        }
        //记录链表结构被修改
        modCount++;
    }

19、获取一个迭代器

  public Iterator<E> iterator() {
      //返回一个内部实现的迭代器
        return new Itr();
    }

    /**
     * An optimized version of AbstractList.Itr
     */
    private class Itr implements Iterator<E> {
        int cursor;       // index of next element to return
        int lastRet = -1; // index of last element returned; -1 if no such
    //在操作迭代器过程中，如果有进行修改链表大小的操作，则在迭代器下次
    //获取元素时马上失败,如果不使用快速失败机制，则在实现Iterator时可以忽略modCount
        // 每次进行修改链表操作时modCount会加1
        //只要判断到expectedModCount ！=modCount，则迭代器马上失败
        int expectedModCount = modCount;


        Itr() {}

        public boolean hasNext() {
            //判断后面是否还有元素，其实就是简单的判断当前的元素是否最后一个
            return cursor != size;
        }

        @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];
        }
        public void remove() {
            if (lastRet < 0)
                throw new IllegalStateException();
             //这里判断链表的元素是否被添加或删除
            checkForComodification();

            try {
               //删除该下标的元素
                ArrayList.this.remove(lastRet);
                cursor = lastRet;
                //上次访问的元素已经被删除，所以设置为-1
                lastRet = -1;
           //修改expectedModCount ，不然就是被检查到链表的大小被修改，
           //会在下次操作时马上失败
                expectedModCount = modCount;
            } catch (IndexOutOfBoundsException ex) {
                throw new ConcurrentModificationException();
            }
        }