ArrayList的源码分析

被面试官压榨了,赶紧回来补一下课,看看ArrayList底层的常用方法实现

ArrayList

参数

//默认容量
private static final int DEFAULT_CAPACITY = 10;

//在构造函数中使用的空数组
private static final Object[] EMPTY_ELEMENTDATA = {};

//默认的构造函数中调用
private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};

// 实际元素个数
private int size;  
//存放的数组
transient Object[] elementData;

//最大容量2的31次方-1-8
private static final int MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8;

初始化

	//传递初始容量，如果大于0，新建数组放在原来的数组中，此时也对其进行了初始化，如果等于0，就赋给数组空数组，小于0就报错
	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() {
        this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;
    }
	
	//参数为集合，将集合转换为数组，将数组的长度赋给size,检查转化的类型，如果不是Object[]类型，使用Arrays类中的copyOf方法进行复制,如果c中没有元素，使用EMPTY_ELEMENTDATA初始化。
    public ArrayList(Collection<? extends E> c) {
        Object[] a = c.toArray();
        if ((size = a.length) != 0) {
            if (c.getClass() == ArrayList.class) {
                elementData = a;
            } else {
                elementData = Arrays.copyOf(a, size, Object[].class);
            }
        } else {
            // replace with empty array.
            elementData = EMPTY_ELEMENTDATA;
        }
    }

主要方法

​ 添加方法

​ 当我们添加 1 个元素到 ArrayList 中时，如若 ArrayList 为没有存放任何元素的空集合，那么在执行ensureCapacityInternal()中 calculateCapacity() 方法过后，minCapacity 会变为 10。此时，minCapacity - elementData.length > 0成立，会进入到 grow(minCapacity) 方法。
​ 当 add 添加第 2 个元素时，minCapacity 为 2，此时 elementData.length （容量）在添加第一个元素后扩容成 10 了。此时，minCapacity - elementData.length > 0 不成立，所以不会进入grow(minCapacity) 方法。
​ 倘若一直添加元素，直至添加第 11 个元素，minCapacity - elementData.length > 0成立（即 11 - 10 > 0），进入 grow() 方法进行扩容。

public boolean add(E e) {
    //添加元素之前，先调用 ensureCapacityInternal 对内部容量进行校验
    //因为要添加元素，所以参数为size+1
    ensureCapacityInternal(size + 1);  
    // 元素添加进去实质就是给最后x一个数组元素赋值
    elementData[size++] = e;
    return true;
}
private void ensureCapacityInternal(int minCapacity) {
    ensureExplicitCapacity(calculateCapacity(elementData, minCapacity));
}

// 得到最小扩容量
private static int calculateCapacity(Object[] elementData, int minCapacity) {
    // 判断集合存数据的数组是否等于空容量的数组，实际就是看数组有没有存在数据
    if (elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA) {
        // 通过最小容量和默认容量求出最大值
        return Math.max(DEFAULT_CAPACITY, minCapacity);
    }
    return minCapacity;
}

private void ensureExplicitCapacity(int minCapacity) {
    // 实际修改集合次数++ (在扩容的过程中没用，主要是用于迭代器中)
    modCount++;
    // 如果最小容量大于数组的容量，就进行扩容
    if (minCapacity - elementData.length > 0)
        grow(minCapacity);
}

​ 扩容方法

private void grow(int minCapacity) {
	// 记录原数组的实际长度
	int oldCapacity = elementData.length;
    // 原数组长度加上原数组长度/2，相当于扩容1.5倍，右移更加高效
	int newCapacity = oldCapacity + (oldCapacity >> 1);
    // 检查扩容后的容量是否大于最小需要容量，若还是小于最小需要的容量，那么就把最小需要容量当作数组的新容量
	if (newCapacity - minCapacity < 0)
		newCapacity = minCapacity;
    // 再检查新容量是否超出了ArrayList所定义的最大容量，
    // 若超出了则调用hugeCapacity() 来比较minCapacity和MAX_ARRAY_SIZE
	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);
}

// 最大容量返回 Integer.MAX_VALUE
private static int hugeCapacity(int minCapacity) {
    // 溢出，抛出异常
    if (minCapacity < 0)
        throw new OutOfMemoryError();
    // 如果 minCapacity 大于 MAX_ARRAY_SIZE，则新容量则为 Interger.MAX_VALUE，
    // 否则，新容量大小则为 MAX_ARRAY_SIZE。
    return (minCapacity > MAX_ARRAY_SIZE) ?
        Integer.MAX_VALUE :
    MAX_ARRAY_SIZE;
}

​ 在指定位置添加元素

	/**
     * 将指定的元素插入此列表中的指定位置。
     * 将当前位于该位置的元素（如果有的话）和任何后续元素右移（将其索引添加一个）,最后size +1。
     *
     * @param index 指定元素要插入的索引
     * @param element 要插入的元素
     * @throws IndexOutOfBoundsException {@inheritDoc}
     */
    public void add(int index, E element) {
        // 范围检查
        rangeCheckForAdd(index);

        ensureCapacityInternal(size + 1);  // Increments modCount!!
        // arraycopy()方法实现数组自己复制自己
        // elementData:源数组;index:源数组中的起始位置;
        // elementData：目标数组；index + 1：目标数组中的起始位置；
        // size - index：要复制的数组元素的数量；
        System.arraycopy(elementData, index, elementData, index + 1,
                         size - index);
        elementData[index] = element;
        size++;
    }

	/**
     * add和addAll使用的rangeCheck版本。
     */
    private void rangeCheckForAdd(int index) {
        // 如若超出范围则抛出异常
        if (index > size || index < 0)
            throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
    }

​ 移除指定下标

// 移出列表中指定下标位置的元素，后续的元素向左移动
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);
    // 将引用置空，让GC回收
    elementData[--size] = null;

    return oldValue;
}

移除指定元素

// 移除第一个在列表中出现的指定元素,如果存在，移除返回true,否则，返回false
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);
    // 将引用置空，让GC回收
    elementData[--size] = null;
}

查找指定元素所在位置

/**
 * 返回指定元素第一次出现的下标
 * 如果不存在该元素，返回 -1
 * 如果 o ==null 会特殊处理
 */
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;
}