JUC篇：CopyOnWriteArrayList的应用与原理

系列文章目录

JUC篇：volatile可见性的实现原理
JUC篇：synchronized的应用和实现原理
JUC篇：用Java实现一个简单的线程池
JUC篇：java中的线程池
JUC篇：ThreadLocal的应用与原理
JUC篇：Java中的并发工具类

---

---

前言

并发包中的并发List只有CopyOnWriteArrayList。CopyOnWriteArrayList是一个线程安全的ArrayList，对其进行的修改操作都是在底层的一个复制的数组（快照）上进行的，也就是使用了写时复制策略

---

一、介绍

CopyOnWriteArraylist的类图结构如图

在CopyOnWriteArrayList的类图中，每个CopyOnWriteArrayList对象里面有一个array数组对象用来存放具体元素，ReentrantLock独占锁对象用来保证同时只有一个线程对array进行修改

如果让我们自己做一个写时复制的线程安全的list我们会怎么做，有哪些点需要考虑？

• 何时初始化list，初始化的list元素个数为多少，list是有限大小吗？
• 如何保证线程安全，比如多个线程进行读写时如何保证是线程安全的？
• 如何保证使用迭代器遍历list时的数据一致性？

二、主要方法源码剖析

2.1 初始化

首先看下无参构造函数，如下代码在内部创建了一个大小为0的Object数组作为array的初始值。

public CopyOnWriteArrayList() {setArray(new Object[0]);}

有参构造函数

//创建一个list，其内部元素是入参toCopyin的副本
public CopyOnWriteArrayList(E[] toCopyIn) {setArray(Arrays.copyOf(toCopyIn, toCopyIn.length, Object[].class));}//入参为集合，将集合里面的元素复制到本list
public CopyOnWriteArrayList(Collection<? extends E> c) {Object[] elements;if (c.getClass() == CopyOnWriteArrayList.class)elements = ((CopyOnWriteArrayList<?>)c).getArray();else {elements = c.toArray();// c.toArray might (incorrectly) not return Object[] (see 6260652)if (elements.getClass() != Object[].class)elements = Arrays.copyOf(elements, elements.length, Object[].class);}setArray(elements);}

2.2 添加元素

CopyOnWrit巳ArrayList中用来添加元素的函数有add(E e）、add(int index,E element）、addifAbsent(E e）和addAllAbsent(Collection<?extendsE> c）等，它们的原理类似，所以以add(E e）为例来讲解。

public boolean add(E e) {//获取独占锁（1）final ReentrantLock lock = this.lock;lock.lock();try {//获取array(2)Object[] elements = getArray();//复制array到新数组，添加元素到新数纽（3）int len = elements.length;Object[] newElements = Arrays.copyOf(elements, len + 1);newElements[len] = e;//使用新数纽替换添加前的数纽(4)setArray(newElements);return true;} finally {//释放独占锁（5）lock.unlock();}}

在如上代码中，调用add方法的线程会首先执行代码（1)去获取独占锁，如果多个线程都调用add方法则只有一个线程会获取到该锁，其他线程会被阻塞挂起直到锁被释放。

所以一个线程获取到锁后，就保证了在该线程添加元素的过程中其他线程不会对array进行修改。

线程获取锁后执行代码（2）获取array，然后执行代码（3）复制array到一个新数组（从这里可以知道新数组的大小是原来数组大小增加1，所以CopyOnWriteArrayList是无界list），并把新增的元素添加到新数组。

然后执行代码（4）使用新数组替换原数组，并在返回前释放锁。由于加了锁，所以整个add过程是个原子性操作。需要注意的是，在添加元素时，首先复制了一个快照，然后在快照上进行添加，而不是直接在原来数组上进行。

2.3 获取指定位置元素

使用E get(int index）获取下标为index的元素，如果元素不存在则抛出IndexOutOfBoundsException异常。

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

在如上代码中，当线程x调用get方法获取指定位置的元素时，分两步走，首先获取array数组（这里命名为步骤A），然后通过下标访问指定位置的元素（这里命名为步骤B),这是两步操作，但是在整个过程中并没有进行加锁同步。假设这时候List内容如图所示，
里面有1、2、3三个元素。

由于执行步骤A和步骤B没有加锁，这就可能导致在线程x执行完步骤A后执行步骤B前，另外一个线程y进行了remove操作，假设要删除元素1。remove操作首先会获取独占锁，然后进行写时复制操作，也就是复制一份当前array数组，然后在复制的数组里面删除线程x通过get方法要访问的元素1，之后让array指向复制的数组。而这时候array之前指向的数组的引用计数为1而不是0，因为线程x还在使用它，这时线程x开始执行步骤B，步骤B操作的数组是线程y删除元素之前的数组，如图

所以，虽然线程y己经删除了index处的元素，但是线程x的步骤B还是会返回index处的元素，这其实就是写时复制策略产生的弱一致性问题。

2.4 弱一致性的迭代器

遍历列表元素可以使用法代器。在讲解什么是法代器的弱一致性前，先举一个例子来·说明如何使用法代器。

public static void main(String[] args) {CopyOnWriteArrayList<String> arrayList = new CopyOnWriteArrayList<>();arrayList.add("hello");arrayList.add("hi");Iterator<String> iterator = arrayList.iterator();while (iterator.hasNext()){System.out.println(iterator.next());}}

输出如下

迭代器的hasNext方法用于判断列表中是否还有元素，next方法则具体返回元素，好了，下面来看CopyOnWriteArrayList中法代器的弱一致性是怎么回事，所谓弱一致性是指返回迭代器后，其他线程对list的增删改对迭代器是不可见的，下面看看这是如何做到的。

public Iterator<E> iterator() {return new COWIterator<E>(getArray(), 0);}static final class COWIterator<E> implements ListIterator<E> {//array的快照版本private final Object[] snapshot;//	数组下标private int cursor;private COWIterator(Object[] elements, int initialCursor) {cursor = initialCursor;snapshot = elements;}//是否遍历结束public boolean hasNext() {return cursor < snapshot.length;}//获取元素public E next() {if (! hasNext())throw new NoSuchElementException();return (E) snapshot[cursor++];}}

如上代码中，当调用iterator（）方法获取法代器时实际上会返回一个COWiterator对象，COWiterator对象的snapshot变量保存了当前list的内容，cursor是遍历list时数据的下标。

为什么说snapshot是list的快照呢？明明是指针传递的引用啊，而不是副本。

如果在该线程使用返回的法代器遍历元素的过程中，其他线程没有对list进行增删改，那么snapshot本身就是list的array，因为它们是引用关系。但是如果在遍历期间其他线程对该list进行了增删改，那么snapshot就是快照了，因为增删改后list里面的数组被新数组替换了，
这时候老数组被snapshot引用。这也说明获取迭代器后，使用该法代器元素时，其他线程对该list进行的增删改不可见，因为它们操作的是两个不同的数组，这就是弱一致性。

下面通过一个例子来演示多线程下法代器的弱一致性的效果。

//测试CopyOnWriteArrayList的迭代器的弱一致性
public class CopyOnWriteArrayListTest {public static void main(String[] args) throws InterruptedException {CopyOnWriteArrayList<String> arrayList = new CopyOnWriteArrayList<>();arrayList.add("hello");arrayList.add("hi");arrayList.add("welcome");arrayList.add("turbos");arrayList.add("tube");Thread thread = new Thread(new Runnable() {@Overridepublic void run() {arrayList.set(0,"hello world!");arrayList.remove(2);arrayList.remove(3);}});//线程启动前，先获取迭代器Iterator<String> iterator = arrayList.iterator();//线程启动并保证主线程在子线程之后执行thread.start();thread.join();while (iterator.hasNext()){System.out.println(iterator.next());}}
}

输出结果

如上代码中，main函数首先初始化了arrayList，然后在启动线程前获取到了arrayList迭代器。子线程thread启动后首先修改了arrayList的第一个元素的值，然后删除了arrayList中下标为2和3的元素。
主线程在子线程执行完毕后使用获取的迭代器遍历数组元素，从输出结果我们知道，在子线程里面进行的操作一个都没有生效，这就是选代器弱一致性的体现。
需要注意的是，获取迭代器的操作必须在子线程操作之前进行。

---

总结

CopyOnWriteArrayList使用写时复制的策略来保证list的一致性，而获取一修改一写入三步操作并不是原子性的，所以在增删改的过程中都使用了独占锁，来保证在某个时间只有一个线程能对list数组进行修改。另外CopyOnWriteArrayList提供了弱一致性的迭代
器，从而保证在获取迭代器后，其他线程对list的修改是不可见的，迭代器遍历的数组是一个快照。