Java并发容器之CopyOnWriteArrayList源码分析

一、简介

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

写入时复制(CopyOnWrite)思想

写入时复制(CopyOnWrite，简称COW)思想是计算机程序设计领域中的一种优化策略。其核心思想是，如果有多个调用者(Callers)同时要求相同的资源(如内存或者是磁盘上的数据存储)，他们会共同获取相同的指针指向相同的资源，直到某个调用者视图修改资源内容时，系统才会真正复制一份专用副本(private copy)给该调用者，而其他调用者所见到的最初的资源仍然保持不变。这过程对其他的调用者都是透明的(transparently)。此做法主要的优点是如果调用者没有修改资源，就不会有副本(private copy)被创建，因此多个调用者只是读取操作时可以共享同一份资源。

应用场景

CopyOnWrite并发容器用于读多写少的并发场景。比如白名单，黑名单，商品类目的访问和更新场景。

二、案例

public class Test {

    public static void main(String[] args) {
        List<Integer> copyOnWriteArrayList = new CopyOnWriteArrayList<>();

        List<Integer> synchronizedList = Collections.synchronizedList(new ArrayList<>());
        int writeLoopCount = 10000;

        // ------ 写 -----------

        StopWatch stopWatch = new StopWatch();
        stopWatch.start("测试写：copyOnWriteArrayList");
        IntStream.rangeClosed(1, writeLoopCount).parallel().forEach(
                x -> copyOnWriteArrayList.add(ThreadLocalRandom.current().nextInt(writeLoopCount))
        );
        stopWatch.stop();
        stopWatch.start("测试写：synchronizedList");
        IntStream.rangeClosed(1, writeLoopCount).parallel().forEach(
                x -> synchronizedList.add(ThreadLocalRandom.current().nextInt(writeLoopCount))
        );
        stopWatch.stop();

        System.out.println(stopWatch.prettyPrint());

        // ------ 读 -----------
        int readLoopCount = 1000000;

        StopWatch stopWatch2 = new StopWatch();
        stopWatch2.start("测试读：copyOnWriteArrayList");
        IntStream.rangeClosed(1, readLoopCount).parallel().forEach(
                x -> copyOnWriteArrayList.get(ThreadLocalRandom.current().nextInt(writeLoopCount))
        );
        stopWatch2.stop();

        stopWatch2.start("测试读：synchronizedList");
        IntStream.rangeClosed(1, readLoopCount).parallel().forEach(
                x -> synchronizedList.get(ThreadLocalRandom.current().nextInt(writeLoopCount))
        );
        stopWatch2.stop();
        System.out.println(stopWatch2.prettyPrint());
    }
}

输出：

StopWatch '': running time (millis) = 281
-----------------------------------------
ms     %     Task name
-----------------------------------------
00275  098%  测试写：copyOnWriteArrayList
00006  002%  测试写：synchronizedList

StopWatch '': running time (millis) = 99
-----------------------------------------
ms     %     Task name
-----------------------------------------
00027  027%  测试读：copyOnWriteArrayList
00072  073%  测试读：synchronizedList

在大量写的情况下，CopyOnWriteArrayList的性能是远远不如普通的加锁List的，性能差距可能在100倍以上，而CopyOnWriteArrayList的读性能大概在普通加锁List的2-5倍左右。所以CopyOnWriteArrayList只适用于大量读的场景。

三、源码分析

3.1 继承体系

CopyOnWriteArrayList实现了List, RandomAccess, Cloneable, java.io.Serializable等接口。提供了基础的添加、删除、遍历等操作，随机访问的能力，克隆，序列化。

3.2 属性

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

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

final Object[] getArray() {
    return array;
}

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

lock用于修改时加锁，使用transient修饰表示不自动序列化。

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

3.3 构造方法

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

public CopyOnWriteArrayList(Collection<? extends E> c) {
    Object[] elements;
    if (c.getClass() == CopyOnWriteArrayList.class)
        // 如果c也是CopyOnWriteArrayList类型
        // 那么直接把它的数组拿过来使用
        elements = ((CopyOnWriteArrayList<?>)c).getArray();
    else {
        // 否则调用其toArray()方法将集合元素转化为数组
        elements = c.toArray();
        // 这里c.toArray()返回的不一定是Object[]类型
        // 详细原因见ArrayList里面的分析
        if (elements.getClass() != Object[].class)
            elements = Arrays.copyOf(elements, elements.length, Object[].class);
    }
    setArray(elements);
}

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

创建空数组。
如果c是CopyOnWriteArrayList类型，直接把它的数组赋值给当前list的数组，注意这里是浅拷贝，两个集合共用同一个数组。如果c不是CopyOnWriteArrayList类型，则进行拷贝把c的元素全部拷贝到当前list的数组中。
把toCopyIn的元素拷贝给当前list的数组。

3.4 添加元素

3.4.1 add(E e)方法

添加一个元素到末尾。

public boolean add(E e) {
    final ReentrantLock lock = this.lock;
    // 加锁
    lock.lock();
    try {
        // 获取旧数组
        Object[] elements = getArray();
        int len = elements.length;
        // 将旧数组元素拷贝到新数组中
        // 新数组大小是旧数组大小加1
        Object[] newElements = Arrays.copyOf(elements, len + 1);
        // 将元素放在最后一位
        newElements[len] = e;
        setArray(newElements);
        return true;
    } finally {
        // 释放锁
        lock.unlock();
    }
}

加锁；
获取元素数组；
新建一个数组，大小为原数组长度加1，并把原数组元素拷贝到新数组；
把新添加的元素放到新数组的末尾；
把新数组赋值给当前对象的array属性，覆盖原数组；
解锁；

3.4.2 add(int index, E element)方法

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

public void add(int index, E element) {
    final ReentrantLock lock = this.lock;
    // 加锁
    lock.lock();
    try {
        // 获取旧数组
        Object[] elements = getArray();
        int len = elements.length;
        // 检查是否越界，可以等于len
        if (index > len || index < 0)
            throw new IndexOutOfBoundsException("Index: "+index+", Size: "+len);
        Object[] newElements;
        int numMoved = len - index;
        if (numMoved == 0)
            // 如果插入的位置是最后一位
            // 那么拷贝一个n+1的数组，其前n个元素与旧数组一致
            newElements = Arrays.copyOf(elements, len + 1);
        else {
            // 如果插入的位置不是最后一位
            // 那么新建一个n+1的数组
            newElements = new Object[len + 1];
            // 拷贝旧数组前index的元素到新数组中
            System.arraycopy(elements, 0, newElements, 0, index);
            // 将index及其之后的元素往后挪一位拷贝到新数组中
            // 这样正好index位置是空出来的
            System.arraycopy(elements, index, newElements, index + 1, numMoved);
        }
        // 将元素放置在index处
        newElements[index] = element;
        setArray(newElements);
    } finally {
        // 释放锁
        lock.unlock();
    }
}

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

3.4.3 addIfAbsent(E e)方法

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

public boolean addIfAbsent(E e) {
    // 获取元素数组，取名为快照
    Object[] snapshot = getArray();
    // 检查如果元素不存在，直接返回false
    // 如果存在再调用addIfAbsent()方法添加元素
    return indexOf(e, snapshot, 0, snapshot.length) >= 0 ? false :
        addIfAbsent(e, snapshot);
}

private boolean addIfAbsent(E e, Object[] snapshot) {
    final ReentrantLock lock = this.lock;
    // 加锁
    lock.lock();
    try {
        // 重新获取旧数组
        Object[] current = getArray();
        int len = current.length;
        // 如果快照与刚获取的数组不一致
        // 说明有修改
        if (snapshot != current) {
            // 重新检查元素是否在刚获取的数组里
            int common = Math.min(snapshot.length, len);
            for (int i = 0; i < common; i++)
                // 到这个方法里面了，说明元素不在快照里面
                if (current[i] != snapshot[i] && eq(e, current[i]))
                    return false;
            if (indexOf(e, current, common, len) >= 0)
                    return false;
        }
        // 拷贝一份n+1的数组
        Object[] newElements = Arrays.copyOf(current, len + 1);
        // 将元素放在最后一位
        newElements[len] = e;
        setArray(newElements);
        return true;
    } finally {
        // 释放锁
        lock.unlock();
    }
}

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

3.5 修改元素

public E set(int index, E element) {
    final ReentrantLock lock = this.lock;
    // 获得锁
    lock.lock();
    try {
        Object[] elements = getArray();
        E oldValue = get(elements, index);

        if (oldValue != element) {
            int len = elements.length;
            // 创建新数组
            Object[] newElements = Arrays.copyOf(elements, len);
            // 替换元素
            newElements[index] = element;
            // 将新数组指向原来的引用
            setArray(newElements);
        } else {
            // Not quite a no-op; ensures volatile write semantics
            setArray(elements);
        }
        return oldValue;
    } finally {
        // 释放锁
        lock.unlock();
    }
}

3.6 获取元素

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

public E get(int index) {
    // 获取元素不需要加锁
    // 直接返回index位置的元素
    // 这里是没有做越界检查的，因为数组本身会做越界检查
    return get(getArray(), index);
}

final Object[] getArray() {
    return array;
}

private E get(Object[] a, int index) {
    return (E) a[index];
}

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

3.7 删除元素

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

public E remove(int index) {
    final ReentrantLock lock = this.lock;
    // 加锁
    lock.lock();
    try {
        // 获取旧数组
        Object[] elements = getArray();
        int len = elements.length;
        E oldValue = get(elements, index);
        int numMoved = len - index - 1;
        if (numMoved == 0)
            // 如果移除的是最后一位
            // 那么直接拷贝一份n-1的新数组，最后一位就自动删除了
            setArray(Arrays.copyOf(elements, len - 1));
        else {
            // 如果移除的不是最后一位
            // 那么新建一个n-1的新数组
            Object[] newElements = new Object[len - 1];
            // 将前index的元素拷贝到新数组中
            System.arraycopy(elements, 0, newElements, 0, index);
            // 将index后面(不包含)的元素往前挪一位
            // 这样正好把index位置覆盖掉了，相当于删除了
            System.arraycopy(elements, index + 1, newElements, index, numMoved);
            setArray(newElements);
        }
        return oldValue;
    } finally {
        // 释放锁
        lock.unlock();
    }
}

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

3.8 获取数组长度

返回数组的长度。

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

为什么CopyOnWriteArrayList没有size属性？
因为每次修改都是拷贝一份正好可以存储目标个数元素的数组，所以不需要size属性了，数组的长度就是集合的大小，而不像ArrayList数组的长度实际是要大于集合的大小的。
比如，add(E e)操作，先拷贝一份n+1个元素的数组，再把新元素放到新数组的最后一位，这时新数组的长度为len+1了，也就是集合的size了。

四、总结

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

posted @ 2022-05-11 16:21 夏尔_717 阅读(28) 评论(0) 编辑收藏举报

会员力量，点亮园子希望

刷新页面返回顶部

ciel_717