ArrayList源码学习

在之前已经讲解了迭代器在ArrayList中的实现，那么我们接下来看一下这个ArrayList的类的详细实现；

首先它定义了一个容量：

private static final int DEFAULT_CAPACITY = 10;

这个容量有什么作用呢？或者说在创建list集合的时候就会给你这个容量吗？先来看一下无参构造：

    public ArrayList() {
        this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;
    }

这里的无参构造是jdk1.8的，之前的应该默认创建一个数组大小为10的数组，而jdk1.8则创建了一个空的数组；也没有用到DEFAULT_CAPACITY 这个数值，但这里有一个DEFAULTCAPACITY_EMPTY_ELEMENTDATA参数：

private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};

这个参数是一个空数组，接着看一下有参构造：

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

这里也没有用到，在看一个：

    public ArrayList(Collection<? extends E> c) {
        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;
        }
    }

三个构造函数都没有用到DEFAULT_CAPACITY这个数值，这就有点奇怪了？接着看，有参构造里面用到了EMPTY_ELEMENTDATA的这个参数，看一下在哪里定义的：

    /**
     * Shared empty array instance used for empty instances.
     */
    private static final Object[] EMPTY_ELEMENTDATA = {};

原来定义的是一个空数组，那么我们知道，当使用有参构造函数的时候如果传的参数是int类型的数据，并且是0的时候，jdk给我们创建了一个空数组；当我们传递Collection的参数，长度为0的话也给我们创建了一个空数组。

总结：

ArrayList再给我们初始化的时候，要么创建我们参数的指定大小的容量，要么给我们创建一个空数组；

看到这里，会有两个问题：

1.为什么会定义两个空数组的变量呢？

2.DEFAULT_CAPACITY变量为什么没有在初始化的时候定义默认大小呢？

带着问题，想象一下，如果定义了空数组给我们，我们下一步要干嘛？肯定是给数组添加元素。那么就看一下add方法：

    public boolean add(E e) {
        ensureCapacityInternal(size + 1);  // Increments modCount!!
        elementData[size++] = e;
        return true;
    }

这里重要的是ensureCapacityInternal(size + 1)方法，按上面的思路现在的参数中的size肯定是0了。那我们来看一下它的实现：

    private void ensureCapacityInternal(int minCapacity) {
        ensureExplicitCapacity(calculateCapacity(elementData, minCapacity));
    }

我们来看看calculateCapacity(elementData, minCapacity)这个方法：

    private static int calculateCapacity(Object[] elementData, int minCapacity) {
        if (elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA) {
            return Math.max(DEFAULT_CAPACITY, minCapacity);
        }
        return minCapacity;
    }

等等，我们要的DEFAULT_CAPACITY参数出现了，那么看一下判断条件：

elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA

然后看一下无参构造函数中的：

 this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;

那么这里的判断条件成立，然后这里的：

 return Math.max(DEFAULT_CAPACITY, minCapacity);

返回两个值中的最大一个，那么在这里肯定是DEFAULT_CAPACITY这个参数了。

注意：

这里的其他两个有参构造中，当初始化为空数组时，取得却是this.elementData = EMPTY_ELEMENTDATA;

所以这里的判断就直接增加1。而不是10了。

那么我们继续看这个ensureExplicitCapacity(10)方法:

    private void ensureExplicitCapacity(int minCapacity) {
        modCount++;

        // overflow-conscious code
        if (minCapacity - elementData.length > 0)
            grow(minCapacity);
    }

这里的第一行modCount++;是不是很熟悉，这就是之前说迭代器的时候在执行增删操作的时候，modCount计数会增加1，就是在这里增加的；

接下来看一下grow(minCapacity);这个方法是干嘛的：

    private void grow(int minCapacity) {
        // overflow-conscious code
        int oldCapacity = elementData.length;
        int newCapacity = oldCapacity + (oldCapacity >> 1);
        if (newCapacity - minCapacity < 0)
            newCapacity = minCapacity;
        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);
    }

先看上半部分：

        int oldCapacity = elementData.length;
        int newCapacity = oldCapacity + (oldCapacity >> 1);
        if (newCapacity - minCapacity < 0)
            newCapacity = minCapacity;

这里oldCapacity的为0，int newCapacity = oldCapacity + (oldCapacity >> 1);数值扩充原来的1.5倍，但是在这里他还是0；

所以这种情况下走了下面的判断，那么最后newCapacity 等于刚才上面我们的返回数值，也就是给newCapacity 参数赋值为10；

elementData = Arrays.copyOf(elementData, newCapacity);方法，在这里你能够看到数组第一次添加的时候，数组扩展到10了。

总结：

1.jdk1.8给我们初始化ArrayList的时候，如果不传参数或者传的参数是0或者长度是0，那么会给我们创建一个空数组，没有任何容量，当我们第一次添加数据的时候，才会给我们分配空间大小为10的数组。

2.为什么创建了两个空数组？

首先DEFAULTCAPACITY_EMPTY_ELEMENTDATA空数组，用于默认大小的空实例的共享空数组实例，就用用创建无参构造的数组时使用的；其他的两种构造函数则是用于EMPTY_ELEMENTDATA。

 

继续看ensureExplicitCapacity方法里执行了modCount++这一个操作，并且当添加到第11个的时候if (minCapacity - elementData.length > 0)判断又成立了，再次进入grow方法中了，这时候你看到这句代码：

int newCapacity = oldCapacity + (oldCapacity >> 1);

你就知道这时候就是扩容后的大小，就是原来的1.5倍；

那么我们来看一下它是如何实现数组扩容的，我们进入Arrays.copyOf这个方法看一下：

 

    public static <T> T[] copyOf(T[] original, int newLength) {
        return (T[]) copyOf(original, newLength, original.getClass());
    }

继续跟进：

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

在这里他直接(T[]) new Object[newLength]一个数组出来，大小使我们传进去的newCapacity这个值，在这里先以10为例；然后调用System.arraycopy(original, 0, copy, 0, Math.min(original.length, newLength))方法实现数组的转换，即把数据复制到新数组中，这个方法是native方法，它的实现不是Java语言实现的。

 

    public void trimToSize() {
        modCount++;
        if (size < elementData.length) {
            elementData = (size == 0)
              ? EMPTY_ELEMENTDATA
              : Arrays.copyOf(elementData, size);
        }
    }

我们从上面知道当数组扩容的时候是原来的1.5倍，所以这个方法就是当你扩展到10的时候你就加入一个元素那么其他9个预留元素就会被清除，这就是它的作用。

接下来我们继续看，判断集合是否包含某个元素的方法：

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

看到上面的方法，我们能够知道indexOf(o)返回的是一个int类型的数字，那么我们看一下他的实现：

    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；同时我们也知道了这个方法的作用，他还有一个：

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

这个方法正好indexOf(Object o)方法遍历的顺序相反，一个从前面一个从后面；

我继续往下看clone()方法：

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

这里调用了Object中的方法，复制了一个新的集合，然后给新的集合复制元素，这里的object的clone方法是一个浅复制，即新集合中的元素的还是指向原来的ArrayList中的元素；所以接下来使用Arrays的copy方法，复制了一份新的数组给新集合；这里的的复制是浅复制，就是只复制了指针，使用同一个对象；

		ArrayList<Integer> a =new ArrayList<Integer>();
		a.add(1);
		a.add(2);
		ArrayList<Integer> b=(ArrayList<Integer>)a.clone();
		System.out.println("移除之前");
		System.out.println(a);
		System.out.println(b);
		b.remove(1);
		System.out.println("移除之后");
		System.out.println(a);
		System.out.println(b);

这样执行的结果是：

移除之前
[1, 2]
[1, 2]
移除之后
[1, 2]
[1]

接下来我们改一下：

		ArrayList<Integer> a =new ArrayList<Integer>();
		a.add(1);
		a.add(2);
		ArrayList<ArrayList<Integer>> c=new ArrayList<ArrayList<Integer>>();
		c.add(a);
		ArrayList<ArrayList<Integer>> d=(ArrayList<ArrayList<Integer>>) c.clone();
		System.out.println("移除之前");
		System.out.println(c);
		System.out.println(d);
		a.remove(1);
		System.out.println("移除之后");
		System.out.println(c);
		System.out.println(d);

运行结果是：

移除之前
[[1, 2]]
[[1, 2]]
移除之后
[[1]]
[[1]]

上下对比我们可以看出来他们用的是一个同一个对象，只是所用的指针不是同一个。

接下来的方法：

    public Object[] toArray() {
        return Arrays.copyOf(elementData, size);
    }

    @SuppressWarnings("unchecked")
    public <T> T[] toArray(T[] a) {
        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);
        if (a.length > size)
            a[size] = null;
        return a;
    }

细看这两个方法是不是就是clone里面的一部分，就是将list集合转换成数组；

    public E get(int index) {
        rangeCheck(index);

        return elementData(index);
    }

集合的get说白了就是操作数组获取相应的值，只是多一步校验而已。

那继续看set方法：

    public E set(int index, E element) {
        rangeCheck(index);

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

这里的set方法其实就是替换指定位置的元素，然后返回被替换的元素；

对于add前面扩容的时候已经说过了，我们知道他是在末尾添加一个元素，那么我们来看一下两个参数的add，

    public void add(int index, E element) {
        rangeCheckForAdd(index);

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

通过rangeCheckForAdd(index)我们能够知道添加的元素可以在包括末尾之前的任意位置添加一个元素；然后通过System.arraycopy(elementData, index, elementData, index + 1,size - index);方法将插入位置往后的数据的坐标加1后重新复制到当前数组中，这样就实现了后面的坐标移动。

到这里是不是觉得这里的System.arraycopy方法和之前的clone里面的Arrays.copyOf(elementData, size)到底有什么区别？

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

上面这是Arrays.copyOf(elementData, size)的底层实现，你可以发现它还调用了System.arraycopy方法，可以看到Arrays.copyOf(elementData, size)先创建了一个新的数组，然后才调用的System.arraycopy方法，

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

这里的remove(Object o)其实就是在内部找到要移除元素的坐标，然后获取循环中的第一个与之对应的元素的坐标，然后使用坐标实现数组的复制，来实现元素的删除。

    public void clear() {
        modCount++;

        // clear to let GC do its work
        for (int i = 0; i < size; i++)
            elementData[i] = null;

        size = 0;
    }

清除方法，其实就是将数组中的各个元素置为null，而数组的容量大小是不会变化的。

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

这个方法其实就是将两个类型相同的集合合成一个集合，也是通过复制来实现的。

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

这是在指定位置添加另一个集合。不过这里要注意，当你插入的位置在数组size之内的时候，数组其实是先实现自身的复制，即把要复制进的集合元素的坐标数先给确定下来，然后在把目标集合复制进去，实现添加功能。

    public boolean retainAll(Collection<?> c) {
        Objects.requireNonNull(c);
        return batchRemove(c, true);
    }

从集合中移除一个集合，Objects.requireNonNull(c)方法是用来显示要移除的数组不是null值，重点看一下batchRemove(c, false)方法：

    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) {
                // 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;
    }

try里面首先将不在移除数组里面的元素重新指定位置，也就是把不包含的元素移动到数组前面去，然后执行finally中的方法，可以看到其实r==size的，所以走下面的方法，把上面移动元素之后的元素都置为null，这就实现了移除；这里的移除包括重复的元素一起移除。