《Java并发编程之美》读书笔记
第五章 Java并发包中并发List源码剖析
介绍
并发包中的并发List只有CopyOnWriteArrayList。CopyOnWriteArrayList是一个线程安全的ArrayList，对其进行修改操作都是在底层的一个复制的数组（快照）上进行的，也就是说采用了写时复制的策略。CopyOnWriteArrayList的类图结构如下：
在CopyOnWriteArrayList的类图中，每个CopyOnWriteArrayList对象里面有一个array数组用来存放具体元素，ReentrantLock独占锁对象用来保证同时只能有一个线程对array进行修改。ReentrantLock是独占锁，同时只能有一个线程获取。
如果让我们自己做一个写时复制的线程安全的list我们怎么做，会怎样考虑？
- 何时初始化list，初始化list的size是多少，list是有限大小的吗？
- 如果保证线程安全，比如多个线程进行读写时是如何保证线程是安全的？
- 如何保证使用迭代器遍历list时数据的一致性呢？
CopyOnWriteArrayList主要方法源码解析
初始化
首先看下午无参的构造函数，如下代码在内部创建了一个大小为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[] es;
if (c.getClass() == CopyOnWriteArrayList.class)
es = ((CopyOnWriteArrayList<?>)c).getArray();
else {
es = c.toArray();
// defend against c.toArray (incorrectly) not returning Object[]
// (see e.g. https://bugs.openjdk.java.net/browse/JDK-6260652)
if (es.getClass() != Object[].class)
es = Arrays.copyOf(es, es.length, Object[].class);
}
setArray(es);
}
添加元素
CopyOnWriteArrayList中用来添加元素的函数有add(E e)、add(int index,E element)、addIfAbsent(E e)和addAllAbsent(Collection<?extends E> C)等，这里以add(E e)来讲解
public boolean add(E e) {
//获取锁
synchronized (lock) {
//获取es
Object[] es = getArray();
int len = es.length;
//复制array到新数组，添加元素到新数组
es = Arrays.copyOf(es, len + 1);
es[len] = e;
//使用新数组替换添加前的数组
setArray(es);
return true;
}
//释放锁
}
在如上的代码中，调用add方法的线程会首先获取独占锁，如果多个线程都调用add方法则只有一个线程会获取到该锁，其他线程会被阻塞挂起直到锁被释放。
所以一个线程获取到锁之后，就保证了该线程添加元素的过程中其他线程不会对array进行修改。
线程获取锁之后执行代码获取array，然后执行代码复制array到一个新数组中（从这里可以直到新数组的大小是原来数组大小增加1，所以CopyOnWriteArrayList是无解的list）并把新增的元素添加到新数组，
然后执行代码使用新数组替换掉原数组，并在返回前释放锁。由于加了锁整个add操作就是个原子性操作。需要注意的是，再添加元素时，首先复制了一个快照，然后再快照上进行添加，而不是直接在原来数组上进行
获取指定位置元素
使用E get(int index)获取下标为index的元素，如果元素不存在则抛出IndexOutOfBoundsException异常；
public E get(int index) {
return elementAt(getArray(), index);
}
final Object[] getArray() {
return array;
}
static <E> E elementAt(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处的元素，这其实就是写时复制策略产生的弱一致性的问题。
修改指定元素
使用E set(int index,E element)修改list中指定元素的值，如果指定位置的元素不存在则抛出IndexOutOfBoundsException异常
public E set(int index, E element) {
synchronized (lock) {
Object[] es = getArray();
E oldValue = elementAt(es, index);
if (oldValue != element) {
es = es.clone();
es[index] = element;
setArray(es);
}
return oldValue;
}
}
如上的代码首先获取了独占锁，从而阻止其他线程对array数组进行修改，然后获取当前数组，并调用get方法获取指定位置的元素，如果指定位置的元素值和新的值不一样，则创建新数组并复制元素，然后在新数组上修改指定位置的元素值并设置新数组到array。
删除元素
删除list里面指定的元素，可以使用E remove（int index) 、boolean remove(Object o) boolean remove(Object o,Object[] snapshot,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 {
//分两次复制删除后剩余的元素到新数组
newElements = new Object[len - 1];
System.arraycopy(es, 0, newElements, 0, index);
System.arraycopy(es, index + 1, newElements, index,
numMoved);
}
//使用新数组代替老数组
setArray(newElements);
return oldValue;
}
//释放锁
}
如上代码其实和新增元素的代码相似，首先获取独占锁以保证删除数据期间其他线程不能对array进行修改，然后获取数组中要被删除的元素，并把剩余的袁术复制到新数组中，之后使用新数组替换原来的数组，最后返回前释放锁。
弱一致性迭代器
遍历列表元素可以使用迭代器，先举一个例子说明如何使用迭代器
public static void main(String[] args) {
CopyOnWriteArrayList<String> arrayList=new CopyOnWriteArrayList<>();
arrayList.add("hello");
arrayList.add("CopyOnWriteArrayList");
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;
//构造函数
COWIterator(Object[] es, int initialCursor) {
cursor = initialCursor;
snapshot = es;
}
//是否遍历结束
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进行的增删改不可见，因为他们操作的是两个不同类型的数组，这就是弱一致性。
public class CopyList {
//创建CopyOnWriteArrayList
private static volatile CopyOnWriteArrayList<String> arrayList=new
CopyOnWriteArrayList<>();
public static void main(String[] args) throws InterruptedException{
arrayList.add("hello");
arrayList.add("CopyList");
arrayList.add("welcome");
arrayList.add("to");
arrayList.add("heu");
//创建线程修改CopyOnWriteArrayList里面的值
Thread threadOne=new Thread(new Runnable() {
@Override
public void run() {
arrayList.set(1,"ali");
arrayList.remove(2);
arrayList.remove(3);
}
});
//在修改线程启动前获取list的迭代器
Iterator<String> iterator = arrayList.iterator();
//启动线程
threadOne.start();
//等子线程执行完毕
threadOne.join();
//迭代元素
while(iterator.hasNext()){
System.out.println(iterator.next());
}
}
}
在如上的代码中，main函数首先初始化了arrayList，然后再启动线程前获取到了arrayList迭代器，子线程threadOne启动后修改了arrayList里面的值。主线程子线程执行完毕后使用获取迭代器遍历数组元素，从输出结果我们知道，在子线程里面进行的操作都没有生效，这就是迭代器弱一致性的体现。需要注意的是，获取迭代器的操作必须在子线程操作之前进行。
参考资料：
《Java并发编程之美》
