ArrayList 源码剖析

ArrayList

 

 

初始化

无参构造器

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

可以看到，在初始化的时候，进行了赋值操作，this.element 和 DEFAULTCAPACITY_EMPTY_ELEMENTDATA  是什么呢，从字面上来看 DEFAULTCAPACITY_EMPTY_ELEMENTDATA 翻译为 默认的空容器元素。

我们往上面查看字段属性，可以看到 element  和 DEFAULTCAPACITY_EMPTY_ELEMENTDATA 的定义，

private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};

transient Object[] elementData;

可以看到 这个贯穿全文的 elementData 是一个数组【并没有指定他的大小】，可以看出 ArrayList 的底层数据结构就是数组，当然也能从名字可以看出来。

无参初始化将会创建一个空数组，相当于懒加载(Lazy)。【默认长度】

 当然你也可以指定他的大小，通过传参构造实现：

 

带参构造器

private static final Object[] 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;
        }
    }

第一个构造器中可以看到，你可以传入一个值，也就是设置 ArrayList 的大小。

第二个构造器可以将一个 Collection 集合 传入，如果长度为0，会将数组变为空数组 EMPTY_ELEMENTDATA。再注释中可以看到 toArray 方法可能不会返回一个 Object[] 数组，因此要使用 Arrays 帮助类的数组拷贝(copyOf C++实现) 将其变化为一个 Object[] 数组。

 

添加数据

单个数据添加

在 ArrayList 中，添加数据的方法为 add() ，我们先看看他的代码

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


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

第一个方法为在尾部添加数据，第二个方法为在指定位置添加数据。

可以看到两个方法都调用了 ensureCapacityInternal(size+1) 方法。这个方法的目的是检测 size+1 的长度是否需要扩容：

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

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

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

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

在这个方法内，调用了  calculateCapacity() ,其作用是初次添加数据的时候(element == DEFAULTCAPACITY_EMPTY_ELEMENTDATA) 将返回 size+1 ，也就是 1 ；然后调用  ensureExplicitCapacity() 方法 ，并将记录操作次数的属性 modCount++ ，判断 size+1 后是否需要进行扩张数组，如果大于当前的length 就扩张，调用 grow() 方法。

private static final int MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8;

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 newCapacity = oldCapacity + (oldCapacity >> 1)  也就是 新数组的大小=旧数组大小*1.5 。

如果 拓展(*1.5)之后，反而变小了就不进行拓展了。

如果 拓展(*1.5)之后，大于整型的最大值 - 8，就将会调用 hugeCapacity() 方法

    private static int hugeCapacity(int minCapacity) {
        if (minCapacity < 0) // overflow
            throw new OutOfMemoryError();
        return (minCapacity > MAX_ARRAY_SIZE) ?
            Integer.MAX_VALUE :
            MAX_ARRAY_SIZE;
    }

如果发生了溢出，就抛出 OutOfMemoryError()  错误，终止程序运行。否则就再将数组拓展最后 的 8个位置。

在指定位置插入数据的时候会进行索引位置的正确性的判断

private void rangeCheckForAdd(int index) {
        if (index > size || index < 0)
            throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
    }

private String outOfBoundsMsg(int index) {
        return "Index: "+index+", Size: "+size;
    }

如果不在 数组索引范围内将会抛出 数组下标超界 的异常

 

集合添加

和单个元素添加类似，有在尾部直接添加和在指定位置的添加。这里就不讲了

public boolean addAll(Collection<? extends E> c) {
        Object[] a = c.toArray();
        int numNew = a.length;

        //判断当前arrayList 长度加上集合的长度是否满足拓展
        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;

        //判断当前arrayList 长度加上集合的长度是否满足拓展
        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;
    }

 

删除

删除一个范围内的数据

protected void removeRange(int fromIndex, int toIndex) {
        modCount++;
        int numMoved = size - toIndex;
        
        //删除的对象数组源，数组源中起始位置，返回的数组，开始删除的位置，长度
        System.arraycopy(elementData, toIndex, elementData, fromIndex,
                         numMoved);

        // clear to let GC do its work
        int newSize = size - (toIndex-fromIndex);
        for (int i = newSize; i < size; i++) {
            elementData[i] = null;
        }
        size = newSize;
    }

删除指定位置数据

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

删除指定对象

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

快速删除指定位置数据

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
    }

清空

public void clear() {
        modCount++;

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

        size = 0;
    }

 

 

未完待续.......