关于java:JDK源码分析ArrayList

本文首发于微信公众号【WriteOnRead】，欢送关注。

ArrayList 是 List 接口的一个实现类，也是 Java 中最罕用的容器实现类之一，能够把它了解为「可变数组」。

咱们晓得，Java 中的数组初始化时须要指定长度，而且指定后不能扭转。ArrayList 外部也是一个数组，它对数组的性能做了加强：次要是在容器内元素减少时能够动静扩容，这也是 ArrayList 的外围所在。

后面「JDK 源码剖析 -List, Iterator, ListIterator」曾经概述了 List 接口的办法，ArrayList 的次要办法与 List 基本一致，因而这里重点剖析其内部结构和扩容的原理。

ArrayList 的继承构造如下（省略局部接口）：

咱们先从结构器着手进行剖析。ArrayList 有三个结构器，别离为：

无参结构器

/**
 * Constructs an empty list with an initial capacity of ten.
 */
public ArrayList() {this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;}

该结构器波及两个变量：elementData 和 DEFAULTCAPACITY_EMPTY_ELEMENTDATA。这两个变量的定义如下：

transient Object[] elementData; // non-private to simplify nested class access

能够看到 elementData 是一个 Object 类型的数组，该数组也是 ArrayList 作为容器用于存储数据的中央。

/**
 * Shared empty array instance used for default sized empty instances. We
 * distinguish this from EMPTY_ELEMENTDATA to know how much to inflate when
 * first element is added.
 */
private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};

DEFAULTCAPACITY_EMPTY_ELEMENTDATA 是一个 Object 类型的空数组。因而，该无参结构器的作用就是将 elementData 初始化为一个 Object 类型的空数组。

指定初始化容量的结构器

该结构传入一个参数，即初始化外部数组容量的 initialCapacity，如下：

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

该结构器依据传入的初始容量（initialCapacity）初始化用于存储元素的数组 elementData 变量。当初始容量为 0 时，elementData 被初始化为 EMPTY_ELEMENTDATA，该变量如下：

private static final Object[] EMPTY_ELEMENTDATA = {};

该数组与 DEFAULTCAPACITY_EMPTY_ELEMENTDATA 都是一个空的 Object 数组，二者名字不同是为了辨别 ArrayList 初始化时是否指定了容量，前期进行扩容的时候有所不同。

指定初始化汇合的结构器

该结构器传入一个汇合 Collection，即应用 Collection 中的元素初始化 ArrayList 对象，代码如下：

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

留神：这里若 Collection 为空时会抛出 NPE，因而初始化前有必要判空。

下面剖析了 ArrayList 的结构器，但 ArrayList 如何做到动静扩容呢？

咱们能够从 add() 办法着手进行剖析（addAll() 办法相似，不再独自剖析），如下：

// ArrayList 的大小（蕴含元素的个数）private int size;

// 将指定的元素增加到 List 开端
public boolean add(E e) {ensureCapacityInternal(size + 1);  // Increments modCount!!
    elementData[size++] = e;
    return true;
}

能够看到，在 add() 办法执行时，会首先执行 ensureCapacityInternal() 办法：

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

该办法会先通过 calculateCapacity 办法计算数组须要的容量 minCapacity，而后判断是否须要执行 grow() 办法：

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

private static int calculateCapacity(Object[] elementData, int minCapacity) {
    // 这里只会在应用无参结构器初始化，并且第一次应用 add 办法时执行（将容量初始化为 10）if (elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA) {return Math.max(DEFAULT_CAPACITY, minCapacity);
    }
    return minCapacity;
}

private void ensureExplicitCapacity(int minCapacity) {
    modCount++;
    // overflow-conscious code
    if (minCapacity - elementData.length > 0)
        grow(minCapacity);
}

这里能够看到，若 elementData 初始值为 DEFAULTCAPACITY_EMPTY_ELEMENTDATA，即应用无参结构器初始化 ArrayList，则默认初始化容量为 10.

若所需容量大小 minCapacity 比原数组长度大（即原数组长度不够用了），则执行 grow() 办法（对数组进行扩容）：

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

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

新容量大小计算：

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

由此能够看出，新容量为原容量的 1.5 倍；若扩容为 1.5 倍后，仍未达到所需容量，则间接应用所须要的容量。

如何扩容的呢？应用 Arrays.copyOf() 办法创立了一个新的数组，而后将原先数组的元素拷贝到新的数组中：

elementData = Arrays.copyOf(elementData, newCapacity);

跟踪该办法能够发现，最终调用了 System.arraycopy() 办法：

public static native void arraycopy(Object src,  int  srcPos,
                                        Object dest, int destPos, int length);

若未指定初始化容量
当第一次执行 add() 办法时，将数组长度默认初始化为 10，之后再增加元素时不扩容，直至容量等于 10，再增加第 11 个元素时，将容量扩容为 15 (10 + 10 >> 1)，以此类推。
若指定了初始化容量 initialCapacity
当数组容量达到 initialCapacity 之前，不进行扩容，当容量等于 initialCapacity 时若再增加元素，则执行扩容，扩容操作同上。
新容量大小
默认扩容后数组的容量为原数组容量的 1.5 倍；若仍未达到所需大小（应用 addAll() 办法时可能呈现），则扩容为所需的容量。

线程平安能够简略了解为：多个线程同时操作一个办法或变量时，不会呈现问题；若呈现问题，可认为是线程不平安的。

ArrayList 是线程不平安的，次要体现有二：

多个线程往 ArrayList 增加数据时（扩容时），可能会产生数组越界异样（ArrayIndexOutOfBoundsException）；
多个线程遍历同一个 ArrayList，有线程对其进行批改时，可能会抛出 ConcurrentModificationException。

先对 add() 办法进行剖析：

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

留神：i++ 操作是非原子性的。

若有一个初始容量为 1 的 ArrayList，线程 T1 和 T2 同时向其中增加元素（add() 办法），当增加第 2 个元素时，须要进行扩容。

此时若有以下执行时序：

T1、T2 检测到须要扩容
此时，T1 和 T2 拿到的都是 elementData.length=1, size=1，若 T1 先执行 ensureCapacityInternal() 办法扩容，则 elementData.length=2, size=1；之后 T2 再执行 ensureCapacityInternal() 办法时，因为初始 size=1，而 T1 扩容后 elementData.length=2，所以 T2 不会再进行扩容（不再执行 grow() 办法）。
T1 执行赋值操作和 size++ 操作
之后 T1 执行赋值操作 elementData[1]=XX 和 size++，size 自增为 2。
T2 执行赋值操作（数组越界）和 size++ 操作
因为上一步 T1 执行了 size++ 操作，以后 size=2，这时的赋值 elementData[size++] 将对 elementData[2] 执行赋值操作，而 elementData.length=2，最大下标为 1，这时会产生数组越界异样（ArrayIndexOutOfBoundsException）。

有一个 ArrayList，线程 T1 对其进行遍历；线程 T2 对其遍历，并移除局部元素。

对 ArrayList 进行遍历时，以 iterator 办法为例，其代码如下：

public Iterator<E> iterator() {return new Itr();
}

会创立一个外部类 Itr，如下：

private class Itr implements Iterator<E> {
    int expectedModCount = modCount;

    // ...
    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];
    }

    // 查看是否有其余线程进行结构性批改
    final void checkForComodification() {if (modCount != expectedModCount)
            throw new ConcurrentModificationException();}    
}

而 ArrayList 的 add()、remove() 等结构性批改的操作都会使 modCount++。因而有：若线程 T1 只对 ArrayList 进行遍历；而线程 T2 对同一个 ArrayList 进行了移除元素操作，则会批改 modCount 的值，导致线程 T1 中 modCount != expectedModCount，从而触发 ConcurrentModificationException。

ArrayList 能够了解为「能够主动扩容的数组」，默认初始化容量为 10，默认每次扩容为原容量的 1.5 倍；
扩容时会创立一个新的数组，并将之前的元素拷贝到新数组中（因而，若要将数量已知的元素放入 ArrayList，在初始化时指定长度能够防止屡次扩容）；
ArrayList 线程不平安，不适宜在多线程场景下应用。

关于java:JDK源码分析ArrayList

1. 概述

2. 代码剖析

2.1 结构器

2.2 扩容实现原理

2.3 扩容小结

3. 线程安全性

场景剖析一

场景剖析二

4. 小结