关于java:一文彻底弄懂ArrayList源码

ArrayList 是一种以数组实现的 List，与数组相比，它具备动静扩大的能力，因而也可称之为动静数组。

在 ArrayList 汇合外面能够存储任何类型的数据，而且它是一个程序容器，寄存的数据程序就是和咱们放入的程序是统一的，而且它还容许咱们放入 null 元素。

public class ArrayList<E> extends AbstractList<E>
        implements List<E>, RandomAccess, Cloneable, java.io.Serializable
{...}

ArrayList 实现了 List，提供了根底的增加、删除、遍历等操作。
ArrayList 实现了 RandomAccess，提供了随机拜访的能力。
ArrayList 实现了 Cloneable，能够被克隆。
ArrayList 实现了 Serializable，能够被序列化。

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

/**
 * 空数组，如果传入的容量为 0 时应用
 */
private static final Object[] EMPTY_ELEMENTDATA = {};

/**
 * 空数组，传传入容量时应用，增加第一个元素的时候会从新初始为默认容量大小
 */
private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};

/**
 * 存储元素的数组
 */
transient Object[] elementData; // non-private to simplify nested class access

/**
 * 汇合中元素的个数
 */
private int size;

（1）DEFAULT_CAPACITY：默认容量为 10，也就是通过 new ArrayList() 创立时的默认容量。

（2）EMPTY_ELEMENTDATA：空的数组，这种是通过 new ArrayList(0) 创立时用的是这个空数组。

（3）DEFAULTCAPACITY_EMPTY_ELEMENTDATA：也是空数组，这种是通过 new ArrayList() 创立时用的是这个空数组，与 EMPTY_ELEMENTDATA 的区别是在增加第一个元素时应用这个空数组的会初始化为 DEFAULT_CAPACITY（10） 个元素。

（4）elementData：真正寄存元素的中央。

（5）size：真正存储元素的个数，而不是 elementData 数组的长度。

为什么 ArrayList 的 elementData 数组要加上 transient 润饰?

因为 ArrayList 有主动扩容机制，所以 ArrayList 的 elementData 数组大小往往比现有的元素数量大，如果不加 transient 间接序列化的话会把数组中空余的地位也序列化了，节约不少的空间。

ArrayList 中重写了序列化和反序列化对应的 writeObject 和readObject办法，在遍历数组元素时，以 size 作为完结标记，只序列化 ArrayList 中曾经存在的元素。

public ArrayList(int initialCapacity) {if (initialCapacity > 0) {
        // 如果传入的初始容量大于 0，就新建一个数组存储元素
        this.elementData = new Object[initialCapacity];
    } else if (initialCapacity == 0) {
        // 如果传入的初始容量等于 0，应用空数组 EMPTY_ELEMENTDATA
        this.elementData = EMPTY_ELEMENTDATA;
    } else {
        // 如果传入的初始容量小于 0，抛出异样
        throw new IllegalArgumentException("Illegal Capacity:" + initialCapacity);
    }
}

public ArrayList() {
    // 如果没有传入初始容量，则应用空数组 DEFAULTCAPACITY_EMPTY_ELEMENTDATA
    // 应用这个数组是在增加第一个元素的时候会扩容到默认大小 10
    this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;
}

/**
* 把传入汇合的元素初始化到 ArrayList 中
*/
public ArrayList(Collection<? extends E> c) {
    // 汇合转数组
    elementData = c.toArray();
    if ((size = elementData.length) != 0) {// 查看 c.toArray()返回的是不是 Object[]类型，如果不是，从新拷贝成 Object[].class 类型
        if (elementData.getClass() != Object[].class)
            elementData = Arrays.copyOf(elementData, size, Object[].class);
    } else {
        // 如果 c 的空集合，则初始化为空数组 EMPTY_ELEMENTDATA
        this.elementData = EMPTY_ELEMENTDATA;
    }
}

增加元素到开端，均匀工夫复杂度为 O(1)。

public boolean add(E e) {
    // 查看是否须要扩容
    ensureCapacityInternal(size + 1);
    // 把元素插入到最初一位
    elementData[size++] = e;
    return true;
}

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

private static int calculateCapacity(Object[] elementData, int minCapacity) {
    // 如果是空数组 DEFAULTCAPACITY_EMPTY_ELEMENTDATA，就初始化为默认大小 10
    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;
    // 新容量为旧容量的 1.5 倍
    int newCapacity = oldCapacity + (oldCapacity >> 1);
    // 如果新容量发现比须要的容量还小，则以须要的容量为准
    if (newCapacity - minCapacity < 0)
        newCapacity = minCapacity;
    // 如果新容量曾经超过最大容量了，则应用最大容量
    if (newCapacity - MAX_ARRAY_SIZE > 0)
        newCapacity = hugeCapacity(minCapacity);
    // 以新容量拷贝进去一个新数组
    elementData = Arrays.copyOf(elementData, newCapacity);
}

增加元素到指定地位，均匀工夫复杂度为 O(n)。

public void add(int index, E element) {
    // 查看是否越界
    rangeCheckForAdd(index);
    // 查看是否须要扩容
    ensureCapacityInternal(size + 1);
    // 将 inex 及其之后的元素往后挪一位，则 index 地位处就空进去了
    System.arraycopy(elementData, index, elementData, index + 1,
                     size - index);
    // 将元素插入到 index 的地位
    elementData[index] = element;
    // 大小增 1
    size++;
}

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

ArrayList 在新增的时候为什么慢？

通过以上的源码，咱们能够看出 ArrayList 有指定 index 新增，也有间接新增的，在这之前他会有一步校验长度的判断ensureCapacityInternal，就是说如果长度不够，是须要扩容的。

在扩容的时候，老版本的 jdk 和 8 当前的版本是有区别的，8 之后的效率更高了，采纳了位运算，右移一位，其实就是除以 2 这个操作。int newCapacity = oldCapacity + (oldCapacity >> 1);新增后的数组容量是旧数组容量的 1.5 倍。

指定地位新增的时候，在校验之后的操作很简略，就是数组的 copy，System.arraycopy(elementData, index, elementData, index + 1, size - index);，为了更好的解释，这里画个图，如下：

比方有上面这样一个数组我须要在 index 4 的地位去新增一个元素 a

从代码外面咱们能够看到，它复制了一个数组，是从 index 4 的地位开始的，而后把它放在了 index 4+1 的地位

给咱们要新增的元素腾出了地位，而后在 index 的地位放入元素 a 就实现了新增的操作了。

这只是在一个这么小的 List 外面操作，要是我去一个几百几千几万大小的 List 新增一个元素，那就须要前面所有的元素都复制，而后如果再波及到扩容啥的就更慢了不是嘛。

求两个汇合的并集。

/**
* 将汇合 c 中所有元素增加到以后 ArrayList 中
*/
public boolean addAll(Collection<? extends E> c) {
    // 将汇合 c 转为数组
    Object[] a = c.toArray();
    int numNew = a.length;
    // 查看是否须要扩容
    ensureCapacityInternal(size + numNew);
    // 将 c 中元素全副拷贝到数组的最初
    System.arraycopy(a, 0, elementData, size, numNew);
    // 大小减少 c 的大小
    size += numNew;
    // 如果 c 不为空就返回 true，否则返回 false
    return numNew != 0;
}

获取指定索引地位的元素，工夫复杂度为 O(1)。

public E get(int index) {
    // 查看是否越界
    rangeCheck(index);
    // 返回数组 index 地位的元素
    return elementData(index);
}

private void rangeCheck(int index) {if (index >= size)
        throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
}

E elementData(int index) {return (E) elementData[index];
}

（1）查看索引是否越界，这里只查看是否越上界，如果越上界抛出 IndexOutOfBoundsException 异样，如果越下界抛出的是 ArrayIndexOutOfBoundsException 异样。

（2）返回索引地位处的元素；

删除指定索引地位的元素，工夫复杂度为 O(n)。

public E remove(int index) {
    // 查看是否越界
    rangeCheck(index);

    modCount++;
    // 获取 index 地位的元素
    E oldValue = elementData(index);

    // 如果 index 不是最初一位，则将 index 之后的元素往前挪一位
    int numMoved = size - index - 1;
    if (numMoved > 0)
        System.arraycopy(elementData, index+1, elementData, index, numMoved);

    // 将最初一个元素删除，帮忙 GC
    elementData[--size] = null; // clear to let GC do its work

    // 返回旧值
    return oldValue;
}

删除指定元素值的元素，工夫复杂度为 O(n)。

public boolean remove(Object o) {if (o == null) {
        // 遍历整个数组，找到元素第一次呈现的地位，并将其疾速删除
        for (int index = 0; index < size; index++)
            // 如果要删除的元素为 null，则以 null 进行比拟，应用 ==
            if (elementData[index] == null) {fastRemove(index);
                return true;
            }
    } else {
        // 遍历整个数组，找到元素第一次呈现的地位，并将其疾速删除
        for (int index = 0; index < size; index++)
            // 如果要删除的元素不为 null，则进行比拟，应用 equals()办法
            if (o.equals(elementData[index])) {fastRemove(index);
                return true;
            }
    }
    return false;
}

private void fastRemove(int index) {
    // 少了一个越界的查看
    modCount++;
    // 如果 index 不是最初一位，则将 index 之后的元素往前挪一位
    int numMoved = size - index - 1;
    if (numMoved > 0)
        System.arraycopy(elementData, index+1, elementData, index, numMoved);
    // 将最初一个元素删除，帮忙 GC
    elementData[--size] = null; // clear to let GC do its work
}

（1）找到第一个等于指定元素值的元素；

（2）疾速删除，fastRemove(int index)绝对于 remove(int index) 少了查看索引越界的操作。

求两个汇合的交加。

public boolean retainAll(Collection<?> c) {
    // 汇合 c 不能为 null
    Objects.requireNonNull(c);
    // 调用批量删除办法，这时 complement 传入 true，示意删除不蕴含在 c 中的元素
    return batchRemove(c, true);
}

/**
* 批量删除元素
* complement 为 true 示意删除 c 中不蕴含的元素
* complement 为 false 示意删除 c 中蕴含的元素
*/
private boolean batchRemove(Collection<?> c, boolean complement) {final Object[] elementData = this.elementData;
    // 应用读写两个指针同时遍历数组
    // 读指针每次自增 1，写指针放入元素的时候才加 1
    // 这样不须要额定的空间，只须要在原有的数组上操作就能够了
    int r = 0, w = 0;
    boolean modified = false;
    try {
        // 遍历整个数组，如果 c 中蕴含该元素，则把该元素放到写指针的地位（以 complement 为准）for (; r < size; r++)
            if (c.contains(elementData[r]) == complement)
                elementData[w++] = elementData[r];
    } finally {// 失常来说 r 最初是等于 size 的，除非 c.contains()抛出了异样
        if (r != size) {// 如果 c.contains()抛出了异样，则把未读的元素都拷贝到写指针之后
            System.arraycopy(elementData, r,
                             elementData, w,
                             size - r);
            w += size - r;
        }
        if (w != size) {
            // 将写指针之后的元素置为空，帮忙 GC
            for (int i = w; i < size; i++)
                elementData[i] = null;
            modCount += size - w;
            // 新大小等于写指针的地位（因为每写一次写指针就加 1，所以新大小正好等于写指针的地位）size = w;
            modified = true;
        }
    }
    // 有批改返回 true
    return modified;
}

（1）遍历 elementData 数组；

（2）如果元素在 c 中，则把这个元素增加到 elementData 数组的 w 地位并将 w 地位往后移一位；

（3）遍历完之后，w 之前的元素都是两者共有的，w 之后（蕴含）的元素不是两者共有的；

（4）将 w 之后（蕴含）的元素置为 null，不便 GC 回收；

求两个汇合的单方向差集，只保留以后汇合中不在 c 中的元素，不保留在 c 中不在以后个体中的元素。

public boolean removeAll(Collection<?> c) {
    // 汇合 c 不能为空
    Objects.requireNonNull(c);
    // 同样调用批量删除办法，这时 complement 传入 false，示意删除蕴含在 c 中的元素
    return batchRemove(c, false);
}

与 retainAll(Collection<?> c) 办法相似，只是这里保留的是不在 c 中的元素。

（1）ArrayList 外部应用数组存储元素，扩容时，每次加一半的空间，ArrayList 不会进行缩容。

（2）ArrayList 反对随机拜访，通过索引拜访元素极快，工夫复杂度为 O(1)。

（3）ArrayList 增加元素到尾部极快，均匀工夫复杂度为 O(1)。

（4）ArrayList 增加元素到两头比较慢，因为要搬移元素，均匀工夫复杂度为 O(n)。

（5）ArrayList 从尾部删除元素极快，工夫复杂度为 O(1)。

（6）ArrayList 从两头删除元素比较慢，因为要搬移元素，均匀工夫复杂度为 O(n)。

（7）ArrayList 反对求并集，调用 addAll(Collection<? extends E> c) 办法即可。

（8）ArrayList 反对求交加，调用 retainAll(Collection<? extends E> c) 办法即可。

（7）ArrayList 反对求单向差集，调用 removeAll(Collection<? extends E> c) 办法即可。

关于java:一文彻底弄懂ArrayList源码

前言

继承体系

源码解析

属性

ArrayList(int initialCapacity)构造方法

ArrayList()构造方法

ArrayList 构造方法

add(E e)办法

add(int index, E element)办法

addAll 办法

get(int index)办法

remove(int index)办法

remove(Object o)办法

retainAll 办法

removeAll

总结