死磕java集合之CopyOnWriteArrayList源码分析（JDK18）

死磕java集合之CopyOnWriteArrayList源码分析（JDK18）

简介

CopyOnWriteArrayList是ArrayList的线程安全版本，内部也是通过数组实现，每次对数组的修改都完全拷贝一份新的数组来修改，修改完了再替换掉老数组，这样保证了只阻塞写操作，不阻塞读操作，实现读写分离。

继承体系

CopyOnWriteArrayList实现了List, RandomAccess, Cloneable, java.io.Serializable等接口。

CopyOnWriteArrayList实现了List，提供了基础的添加、删除、遍历等操作。

CopyOnWriteArrayList实现了RandomAccess，提供了随机访问的能力。

CopyOnWriteArrayList实现了Cloneable，可以被克隆。

CopyOnWriteArrayList实现了Serializable，可以被序列化。

源码解析

属性

/** 用于修改时加锁 */
final transient Object lock = new Object();

/** 真正存储元素的地方，只能通过getArray()/setArray()访问 */
private transient volatile Object[] array;

（1）lock

CopyOnWriteArrayList的加锁操作，由Lock加锁改为synchronized，这是因为

（2）array

真正存储元素的地方，使用transient修饰表示不自动序列化，使用volatile修饰表示一个线程对这个字段的修改另外一个线程立即可见。

CopyOnWriteArrayList()构造方法

创建空数组。

public CopyOnWriteArrayList() {
    // 所有对array的操作都是通过setArray()和getArray()进行
    setArray(new Object[0]);
}

final void setArray(Object[] a) {
    array = a;
}

CopyOnWriteArrayList(Collection<? extends E> c)构造方法

如果c是CopyOnWriteArrayList类型，直接把它的数组赋值给当前list的数组，注意这里是浅拷贝，两个集合共用同一个数组。

如果c不是CopyOnWriteArrayList类型，则进行拷贝把c的元素全部拷贝到当前list的数组中。

public CopyOnWriteArrayList(Collection<? extends E> c) {
    Object[] es;
    if (c.getClass() == CopyOnWriteArrayList.class)
        // 如果c也是CopyOnWriteArrayList类型
        // 那么直接把它的数组拿过来使用
        es = ((CopyOnWriteArrayList<?>)c).getArray();
    else {
        // 否则调用其toArray()方法将集合元素转化为数组
        es = c.toArray();
        if (c.getClass() != java.util.ArrayList.class)
            // 如果c不是ArrayList类型
            es = Arrays.copyOf(es, es.length, Object[].class);
    }
    setArray(es);
}

CopyOnWriteArrayList(E[] toCopyIn)构造方法

把toCopyIn的元素拷贝给当前list的数组。

public CopyOnWriteArrayList(E[] toCopyIn) {
    setArray(Arrays.copyOf(toCopyIn, toCopyIn.length, Object[].class));
}

add(E e)方法

添加一个元素到末尾。

public boolean add(E e) {
    // 同步代码块
    synchronized (lock) {
        // 获取旧数组
        Object[] es = getArray();
        int len = es.length;
        // 将es的数据复制到一个长度为len+1的数组中，并将引用赋给es
        es = Arrays.copyOf(es, len + 1);
        // 将元素放在最后一位
        es[len] = e;
        // 将es数组赋给成员变量array
        setArray(es);
        return true;
    }
}

采用同步代码块的方式给整段代码加锁

add(int index, E element)方法

添加一个元素在指定索引处。

public void add(int index, E element) {
    // 同步代码块
    synchronized (lock) {
        // 获取旧数组
        Object[] es = getArray();
        int len = es.length;
        // 检查是否越界，可以等于0、len
        if (index > len || index < 0)
            throw new IndexOutOfBoundsException(outOfBounds(index, len));
        Object[] newElements;
        int numMoved = len - index;
        if (numMoved == 0)
            // 如果插入的是最后一位
            // 那么拷贝一个n+1的数组, 其前n个元素与旧数组一致
            newElements = Arrays.copyOf(es, len + 1);
        else {
            // 如果插入的不是最后一位，新建一个n+1的数组
            newElements = new Object[len + 1];
            // 拷贝[0, index -1]的数据到新数组的[0,index - 1]
            System.arraycopy(es, 0, newElements, 0, index);
            // 拷贝[index, len - 1]的数据到新数组的[index + 1, len]
            System.arraycopy(es, index, newElements, index + 1,
                             numMoved);
        }
        // 将元素放在index处
        newElements[index] = element;
        // 将新数组赋给成员变量array
        setArray(newElements);
    }
}

1. 检查索引是否合法，如果不合法抛出IndexOutOfBoundsException异常，注意这里index等于len也是合法的；
2. 如果索引等于数组长度（也就是数组最后一位再加1），那就拷贝一个len+1的数组；
3. 如果索引不等于数组长度，那就新建一个len+1的数组，并按索引位置分成两部分，索引之前（不包含）的部分拷贝到新数组索引之前（不包含）的部分，索引之后（包含）的位置拷贝到新数组索引之后（不包含）的位置，索引所在位置留空；
4. 把索引位置赋值为待添加的元素；
5. 把新数组赋值给当前对象的array属性，覆盖原数组；

addIfAbsent(E e)方法

添加一个元素如果这个元素不存在于集合中。

public boolean addIfAbsent(E e) {
    // 获取旧数组
    Object[] snapshot = getArray();
    // 在旧数组中找不到元素e，则在集合中添加e
    return indexOfRange(e, snapshot, 0, snapshot.length) < 0
        && addIfAbsent(e, snapshot);
}

private static int indexOfRange(Object o, Object[] es, int from, int to) {
        if (o == null) {
            // 如果要添加的元素为null,遍历并找到其索引
            for (int i = from; i < to; i++)
                if (es[i] == null)
                    return i;
        } else {
            // 如果要添加的元素不为null,遍历并找到其索引
            for (int i = from; i < to; i++)
                if (o.equals(es[i]))
                    return i;
        }
        return -1;
}

private boolean addIfAbsent(E e, Object[] snapshot) {
    	// 同步代码块
        synchronized (lock) {
            // 获取旧数组
            Object[] current = getArray();
            int len = current.length;
            // 如果快照与刚获取的数组不一致
            // 说明有修改
            if (snapshot != current) { 
                // Optimize for lost race to another addXXX operation
                // 重新检查元素是否在刚获取的数组里
                int common = Math.min(snapshot.length, len);
                for (int i = 0; i < common; i++)
                    // 在current的[0, common-1]里去找
                    if (current[i] != snapshot[i]
                        && Objects.equals(e, current[i]))
                        return false;
                // 在current的[common, len-1]里找到
                if (indexOfRange(e, current, common, len) >= 0)
                        return false;
            }
            // 拷贝一份n+1的数组
            Object[] newElements = Arrays.copyOf(current, len + 1);
            // 元素放在最后一位
            newElements[len] = e;
            setArray(newElements);
            return true;
        }
}

1. 检查这个元素是否存在于数组快照中；
2. 如果存在直接返回false，如果不存在调用addIfAbsent(E e, Object[] snapshot)处理;
3. 如果当前数组不等于传入的快照，说明有修改，检查待添加的元素是否存在于当前数组中，如果存在直接返回false;
4. 拷贝一个新数组，长度等于原数组长度加1，并把原数组元素拷贝到新数组中；
5. 把新元素添加到数组最后一位；
6. 把新数组赋值给当前对象的array属性，覆盖原数组；

get(int index)

获取指定索引的元素，支持随机访问，时间复杂度为O(1)。

public E get(int index) {
    return elementAt(getArray(), index);
}

static <E> E elementAt(Object[] a, int index) {
        return (E) a[index];
}

1. 获取元素数组；
2. 返回数组指定索引位置的元素；

remove(int index)方法

删除指定索引位置的元素。

public E remove(int index) {
    // 同步代码块
    synchronized (lock) {
        // 获取旧数组
        Object[] es = getArray();
        int len = es.length;
        // 获取旧值
        E oldValue = elementAt(es, index);
        // 获取需要移动的元素个数
        int numMoved = len - index - 1;
        Object[] newElements;
        if (numMoved == 0)
            // 如果移除的是最后一位
            newElements = Arrays.copyOf(es, len - 1);
        else {
            // 如果移除的不是最后一位，新建一个n-1的数组
            newElements = new Object[len - 1];
            // 拷贝[0, index -1]的元素到新数组的[0,index-1]中
            System.arraycopy(es, 0, newElements, 0, index);
            // 拷贝[index + 1, len - 1]的元素到新数组的[index, len -2]中
            System.arraycopy(es, index + 1, newElements, index,
                             numMoved);
        }
        setArray(newElements);
        return oldValue;
    }
}

1. 获取索引位置的旧值；
2. 如果移除的是最后一位，则把原数组的[0, len - 2]的元素拷贝到新数组的[0, len -2]中，并把新数组赋值给当前对象的array属性；
3. 如果移除的不是最后一位，则新建一个len-1长度的数组，并把原数组除了指定索引位置的元素全部拷贝到新数组中，并把新数组赋值给当前对象的array属性；
4. 返回旧值。

size()方法

返回数组的长度。

public int size() {
    // 获取元素个数不需要加锁
    // 直接返回数组的长度
    return getArray().length;
}

clone()方法

public Object clone() {
    try {
        @SuppressWarnings("unchecked")
        // 获取clone对象
        CopyOnWriteArrayList<E> clone =
        (CopyOnWriteArrayList<E>) super.clone();
        // 获取clone对象中的lock属性，并将新的Object对象赋值给lock
        clone.resetLock();
        // Unlike in readObject, here we cannot visibility-piggyback on the
        // volatile write in setArray().
        VarHandle.releaseFence();
        return clone;
    } catch (CloneNotSupportedException e) {
        // 因为CopyOnWriteArrayList声明了实现Cloneable接口，所以这里不会发生异常
        // this shouldn't happen, since we are Cloneable
        throw new InternalError();
    }
}

private void resetLock() {
    @SuppressWarnings("removal")
    // 获取lock属性
    Field lockField = java.security.AccessController.doPrivileged(
        (java.security.PrivilegedAction<Field>) () -> {
            try {
                Field f = CopyOnWriteArrayList.class
                    .getDeclaredField("lock");
                f.setAccessible(true);
                return f;
            } catch (ReflectiveOperationException e) {
                throw new Error(e);
            }});
    try {
        // 将lock设置为一个新的Object对象
        lockField.set(this, new Object());
    } catch (IllegalAccessException e) {
        throw new Error(e);
    }
}

总结

1. CopyOnWriteArrayList使用ReentrantLock重入锁加锁，保证线程安全；
2. CopyOnWriteArrayList的写操作都要先拷贝一份新数组，在新数组中做修改，修改完了再用新数组替换老数组，所以空间复杂度是O(n)，性能比较低下；
3. CopyOnWriteArrayList的读操作支持随机访问，时间复杂度为O(1)；
4. CopyOnWriteArrayList采用读写分离的思想，读操作不加锁，写操作加锁，且写操作占用较大内存空间，所以适用于读多写少的场合；
5. CopyOnWriteArrayList只保证最终一致性，不保证实时一致性；

彩蛋

为什么CopyOnWriteArrayList没有size属性？

因为每次修改都是拷贝一份正好可以存储目标个数元素的数组，所以不需要size属性了，数组的长度就是集合的大小，而不像ArrayList数组的长度实际是要大于集合的大小的。

比如，add(E e)操作，先拷贝一份n+1个元素的数组，再把新元素放到新数组的最后一位，这时新数组的长度为len+1了，也就是集合的size了。

本文是参照彤哥的文章写的，故文末附上彤哥的文章链接，可点击链接查看彤哥的更多文章。