概述
并发包中的并发List只有CopyOnWriteArrayList
。CopyOnWriteArrayList是一个线程安全的ArrayList,对其进行的修改操作都是在底层的一个复制的数组(快照)上进行的,也就是使用了写时复制策略。
在CopyOnWriteArrayList的类中,每个CopyOnWriteArrayList对象里面有一个array数组对象用来存放具体元素,ReentrantLock独占锁对象用来保证同时只有一个线程对array进行修改。
我们思考几个问题
何时初始化list,初始化的list元素个数为多少,list是有限大小吗?
如何保证线程安全,比如多个线程进行读写时如何保证是线程安全的?
如何保证使用迭代器遍历list时的数据一致性?
源码解析
初始化
首先看下无参构造函数,如下代码在内部创建了一个大小为0的Object数组作为array的初始值。
/** * Creates an empty list. */ public CopyOnWriteArrayList() { setArray(new Object[0]); }
然后看下有参构造函数。
/** * Creates a list containing the elements of the specified * collection, in the order they are returned by the collection's * iterator. * * @param c the collection of initially held elements * @throws NullPointerException if the specified collection is null */ // 入参为集合,将集合中的元素复制到本List public CopyOnWriteArrayList(Collection<? extends E> c) { Object[] elements; if (c.getClass() == CopyOnWriteArrayList.class) elements = ((CopyOnWriteArrayList<?>)c).getArray(); else { elements = c.toArray(); if (c.getClass() != ArrayList.class) elements = Arrays.copyOf(elements, elements.length, Object[].class); } setArray(elements); } /** * Creates a list holding a copy of the given array. * * @param toCopyIn the array (a copy of this array is used as the * internal array) * @throws NullPointerException if the specified array is null */ // 创建一个List , 其内部元素是toCopyIn的副本 public CopyOnWriteArrayList(E[] toCopyIn) { setArray(Arrays.copyOf(toCopyIn, toCopyIn.length, Object[].class)); }
添加元素
用来添加元素的函数有 add(E e)、add(int index, E element)、addIfAbsent(E e)和addAllAbsent(Collection<? extends E> c)等 原理类似, 以add(E e)为例
/** * Appends the specified element to the end of this list. * * @param e element to be appended to this list * @return {@code true} (as specified by {@link Collection#add}) */ public boolean add(E e) { // 1 获取独占锁 final ReentrantLock lock = this.lock; lock.lock(); try { // 2 获取array Object[] elements = getArray(); int len = elements.length; // 3 复制array到新数组,添加元素到新数组 Object[] newElements = Arrays.copyOf(elements, len + 1); newElements[len] = e; // 4 使用新数组代替添加前的数组 setArray(newElements); return true; } finally { // 5 释放独占锁 lock.unlock(); } }
首先执行代码(1)去获取独占锁,如果多个线程都调用add方法则只有一个线程会获取到该锁,其他线程会被阻塞挂起直到锁被释放。 所以一个线程获取到锁后,就保证了在该线程添加元素的过程中其他线程不会对array进行修改
线程获取锁后执行代码(2)获取array
执行代码(3)复制array到一个新数组(从这里可以知道新数组的大小是原来数组大小增加1,所以CopyOnWriteArrayList是无界list),并把新增的元素添加到新数组
执行代码(4)使用新数组替换原数组
执行代码(5)返回前释放锁。
由于加了锁,所以整个add过程是个原子性操作。需要注意的是,在添加元素时,首先复制了一个快照,然后在快照上进行添加,而不是直接在原来数组上进行。
获取指定位置元素
使用E get(int index) 获取下标为index的元素,如果元素不存在则抛出IndexOutOfBoundsException异常。
@SuppressWarnings("unchecked") private E get(Object[] a, int index) { return (E) a[index]; } /** * {@inheritDoc} * * @throws IndexOutOfBoundsException {@inheritDoc} */ public E get(int index) { return get(getArray(), index); }
在如上代码中,当线程x调用get方法获取指定位置的元素时,分两步走,首先获取array数组(这里命名为步骤A),然后通过下标访问指定位置的元素(这里命名为步骤B),这是两步操作,但是在整个过程中并没有进行加锁同步。
由于执行步骤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处的元素,这其实就是写时复制策略产生的弱一致性问题。
修改指定元素
使用E set(int index,E element)修改list中指定元素的值,如果指定位置的元素不存在则抛出IndexOutOfBoundsException异常
/** * Replaces the element at the specified position in this list with the * specified element. * * @throws IndexOutOfBoundsException {@inheritDoc} */ 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(); } }
首先获取了独占锁,从而阻止其他线程对array数组进行修改,然后获取当前数组,并调用get方法获取指定位置的元素,如果指定位置的元素值与新值不一致则创建新数组并复制元素,然后在新数组上修改指定位置的元素值并设置新数组到array。
如果指定位置的元素值与新值一样,则为了保证volatile语义,还是需要重新设置array,虽然array的内容并没有改变。
删除元素
删除list里面指定的元素,可以使用 E remove(int index) 、 boolean remove(Object o)和boolean remove(Object o, Object[] snapshot, int index) 等方法,它们的原理一样。
/** * Removes the element at the specified position in this list. * Shifts any subsequent elements to the left (subtracts one from their * indices). Returns the element that was removed from the list. * * @throws IndexOutOfBoundsException {@inheritDoc} */ 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) setArray(Arrays.copyOf(elements, len - 1)); else { Object[] newElements = new Object[len - 1]; // 分两次复制删除后剩余的元素到新数组 System.arraycopy(elements, 0, newElements, 0, index); System.arraycopy(elements, index + 1, newElements, index, numMoved); // 使用新数组代替旧数组 setArray(newElements); } return oldValue; } finally { // 解锁 释放独占锁 lock.unlock(); } }
其实和新增元素的代码类似,首先获取独占锁以保证删除数据期间其他线程不能对array进行修改,然后获取数组中要被删除的元素,并把剩余的元素复制到新数组,之后使用新数组替换原来的数组,最后在返回前释放锁。
弱一致性的迭代器
遍历列表元素可以使用迭代器。在讲解什么是迭代器的弱一致性前,先举一个例子来说明如何使用迭代器。
import java.util.Iterator; import java.util.concurrent.CopyOnWriteArrayList; /** * @author 小工匠 * @version 1.0 * @description: TODO * @date 2021/12/1 21:07 * @mark: show me the code , change the world */ public class COWArrayListTest { public static void main(String[] args) { CopyOnWriteArrayList copyOnWriteArrayList = new CopyOnWriteArrayList<>(); copyOnWriteArrayList.add("hello"); copyOnWriteArrayList.add("artisan"); copyOnWriteArrayList.add("learn"); copyOnWriteArrayList.add("ml"); Iterator iterator = copyOnWriteArrayList.iterator(); while (iterator.hasNext()){ System.out.println(iterator.next()); } } }
迭代器的hasNext方法用于判断列表中是否还有元素,next方法则具体返回元素。
下面来看CopyOnWriteArrayList中迭代器的弱一致性是怎么回事,所谓弱一致性是指返回迭代器后,其他线程对list的增删改对迭代器是不可见的.
下面看个例子
import java.util.Iterator; import java.util.concurrent.CopyOnWriteArrayList; /** * @author 小工匠 * @version 1.0 * @description: TODO * @date 2021/12/1 21:17 * @mark: show me the code , change the world */ public class COWArrayListTest2 { private static volatile CopyOnWriteArrayList cow = new CopyOnWriteArrayList<>(); public static void main(String[] args) throws InterruptedException { cow.add("hello"); cow.add("artisan"); cow.add("learn"); cow.add("ml"); Thread thread = new Thread(() -> { System.out.println("异步线程开始操作COW~"); // 异步线程修改 删除 cow.set(0, "xxxx"); cow.remove(1); cow.remove(2); Iterator iterator = cow.iterator(); while (iterator.hasNext()) { System.out.println(iterator.next()); } System.out.println("异步线程结束操作COW~"); }); // 一定要在异步线程启动前获取到 迭代器 Iterator iterator = cow.iterator(); // 启动线程 thread.start(); // 等待子线程结束 thread.join(); // 遍历 while (iterator.hasNext()) { System.out.println(iterator.next()); } } }
在如上代码中,main函数首先初始化了cow,然后在启动线程前获取到了cow迭代器。子线程thread启动后首先修改了cow的第1个元素的值,然后删除了cow中下标为1和2的元素。
主线程在子线程执行完毕后使用获取的迭代器遍历数组元素,从输出结果我们知道,在子线程里面进行的操作一个都没有生效,这就是迭代器弱一致性的体现。需要注意的是,获取迭代器的操作必须在子线程操作之前进行。
CopyOnWriteArrayList 是如何实现弱一致性的
/** * Returns an iterator over the elements in this list in proper sequence. * * <p>The returned iterator provides a snapshot of the state of the list * when the iterator was constructed. No synchronization is needed while * traversing the iterator. The iterator does <em>NOT</em> support the * {@code remove} method. * * @return an iterator over the elements in this list in proper sequence */ public Iterator<E> iterator() { return new COWIterator<E>(getArray(), 0); }
static final class COWIterator<E> implements ListIterator<E> { /** Snapshot of the array */ // array的快照版本 private final Object[] snapshot; /** Index of element to be returned by subsequent call to next. */ // 数组下标 private int cursor; // 构造函数 private COWIterator(Object[] elements, int initialCursor) { cursor = initialCursor; snapshot = elements; } // 是否遍历结束 public boolean hasNext() { return cursor < snapshot.length; } // 获取元素 @SuppressWarnings("unchecked") 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使用写时复制的策略来保证list的一致性,而获取—修改—写入三步操作并不是原子性的,所以在增删改的过程中都使用了独占锁,来保证在某个时间只有一个线程能对list数组进行修改。
另外CopyOnWriteArrayList提供了弱一致性的迭代器,从而保证在获取迭代器后,其他线程对list的修改是不可见的,迭代器遍历的数组是一个快照。
另外,CopyOnWriteArraySet的底层就是使用CopyOnWriteArrayList实现的 。