并发容器之CopyOnWriteArrayList
JDK的并发List之CopyOnWriteArrayList
1.介绍
CopyOnWriteArrayList是一个线程安全的ArrayList，它的写操作都是在底层的一个复制数组（快照）中进行的，也就是使用了写时复制策略。
什么是写时复制策略？
通俗易用地讲，不同进程访问同一资源的时候，只有在写操作，才会复制一份新的数据，否则都是访问同一资源。
每个CopyOnWriteArrayList对象中，都有一个array对象来存放具体的元素，ReentrantLock独占锁对象用来保证同一时刻只有一个线程对array进行修改。
2.主要方法源码解析
2.1 构造函数
无参构造函数，内部创建了一个大小为0的Object数组，作为array的初始值。
public CopyOnWriteArrayList() {
setArray(new Object[0]);
}
再来看有参构造函数。
/**
* 入参为集合，将集合里面的元素复制到新的数组，把array的引用指向新的数组
*/
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);
}
/**
* 入参为数组
*/
public CopyOnWriteArrayList(E[] toCopyIn) {
setArray(Arrays.copyOf(toCopyIn, toCopyIn.length, Object[].class));
}
2.2 添加元素
public boolean add(E e) {
// 1.首先去获取独占锁
final ReentrantLock lock = this.lock;
lock.lock();
try {
// 2.获取array
Object[] elements = getArray();
// 3.复制到新的数组newElements，添加元素到新数组
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，所以CopyOnWriteArrayList是无界list。
- 保证添加元素的时候是一个原子性操作。
- 需要注意的是，在添加元素的时候，首先复制了一个快照，再在快照的基础上添加一个元素，而不是在原来的数组上进行。
2.3 获取指定的元素位置
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];
}
当某个线程调用get方法获取指定位置的元素时，有两步操作：
1.会首先获取array
2.再通过下标访问指定位置的元素
在这个过程中并没有加锁同步。可以假设有这个场景，有x、y两个线程，x执行get方法，当x在执行完步骤1后步骤2前。
此时，y线程进来了，y线程要进行remove操作，当然就是获取锁进行写时复制，复制一份新的数组，删除此数组后，把array指向新数组。
但是，这个时候x线程读取到的还是原来旧的数组，这种情况，就是写时复制策略产生的弱一致性问题。
2.4 修改指定的元素
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();
}
}
跟上面的方法一样，也是先拿到独占锁，调用get方法获取指定元素的位置，如果得到的值与新值不一样，则复制一个新数组，把元素设置到新数组中，并让array指向新数组。
如果新值等于旧值，为了保证volatile语义，还是需要重新设置array，虽然array的内容没有改变。
2.5 删除元素
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();
}
}
没什么特别的，首先拿到要删除元素的值，判断是否是删除最后一个元素，是的话，则直接拷贝0~len-1的数组，否则，新建一个长度为len-1的数组，分两次复制删除后剩余的数组。
2.6 弱一致性的迭代器
public Iterator<E> iterator() {
return new COWIterator<E>(getArray(), 0);
}
static final class COWIterator<E> implements ListIterator<E> {
/** Snapshot of the 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;
}
public boolean hasPrevious() {
return cursor > 0;
}
@SuppressWarnings("unchecked")
public E next() {
if (! hasNext())
throw new NoSuchElementException();
return (E) snapshot[cursor++];
}
@SuppressWarnings("unchecked")
public E previous() {
if (! hasPrevious())
throw new NoSuchElementException();
return (E) snapshot[--cursor];
}
public int nextIndex() {
return cursor;
}
public int previousIndex() {
return cursor-1;
}
/**
* Not supported. Always throws UnsupportedOperationException.
* @throws UnsupportedOperationException always; {@code remove}
* is not supported by this iterator.
*/
public void remove() {
throw new UnsupportedOperationException();
}
/**
* Not supported. Always throws UnsupportedOperationException.
* @throws UnsupportedOperationException always; {@code set}
* is not supported by this iterator.
*/
public void set(E e) {
throw new UnsupportedOperationException();
}
/**
* Not supported. Always throws UnsupportedOperationException.
* @throws UnsupportedOperationException always; {@code add}
* is not supported by this iterator.
*/
public void add(E e) {
throw new UnsupportedOperationException();
}
@Override
public void forEachRemaining(Consumer<? super E> action) {
Objects.requireNonNull(action);
Object[] elements = snapshot;
final int size = elements.length;
for (int i = cursor; i < size; i++) {
@SuppressWarnings("unchecked") E e = (E) elements[i];
action.accept(e);
}
cursor = size;
}
}
当调用iterator()方法获取迭代器的时候，实际上会返回一个COWIterator对象，COWIterator对象的snapshot变量保存了当前list的内容，cursor是遍历list时数据的下标。
这里我们看到明明snapshot是引用，而不是快照。是因为如果在遍历的期间，其他线程对该list进行了写操作，那么snapshot实际上就是快照，因为写操作完成后，list里面就是新的数组，但是此时老数组还是被snapshot引用。
其他线程对该list的写操作是不可见的，因为他们操作的是不同数组，这就是弱一致性。
可以通过以下的一个例子去验证
public class CopyTest {
private static volatile CopyOnWriteArrayList<Integer> list = new CopyOnWriteArrayList<Integer>();
public static void main(String[] args) throws Exception {
list.add(1);
list.add(2);
list.add(3);
list.add(4);
list.add(5);
Thread t = new Thread(() -> {
list.set(1, 100);
});
// 启动线程前，先去获取该list的迭代器
Iterator<Integer> iterator = list.iterator();
t.start();
// 等待t执行完毕
t.join();
while (iterator.hasNext()) {
System.out.println(iterator.next());
}
}
}
输出：
1
2
3
4
5
子线程t进行的操作，从输出的结果来看，一个都没有生效，因为父线程获取的是旧的数组。
3.总结
CopyOnWriteArrayList使用写时复制策略来保证List的一致性，而获取获取->修改->写入这三步操作并不是原子性，所以在写操作的时候使用了独占锁，来保证某段时间只有一个线程来操作list。另外，CopyOnWriteArrayList提供了弱一致性的迭代器，保证获取迭代器后，其他线程对list的修改是不可见的，迭代器遍历的数组是一个快照。
