java并发编程之美第五章读书笔记

java并发包中并发List源码剖析

介绍

CopyOnWriteArrayList

线程安全的ArrayList,对其进行的修改操作都是在底层的一个复制的数组(快照)进行的,也就是写时复制策略

类图

每一个对象里面有一个array数组进行存放具体的元素,ReentrantLock独占锁对象用来保证同时只有一个线程对array进行修改,这里只要记得ReentrantLock是独占锁,同时只有一个线程可以获取就可以了

主要方法的源码解析

初始化

无参构造创建一个大小为零的object数组

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();
        if (c.getClass() != ArrayList.class)
            elements = Arrays.copyOf(elements, elements.length, Object[].class);
    }
    setArray(elements);
}

添加元素

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

调用 add 方法的线程会首先执行代码(1)去获取独占锁，如果多个我程都调用 add 方法则只有一个线程会获取到该锁，其他线程会被阻塞挂起直到锁被释放所以一个线程获取到锁后，就保证了在该线程添加元素的过程中其他线程不会对amay进行修改。

线程获取锁后执行代码(2)获取array，然后执行代码(3)复制 array 到一个新数组(M这里可以知道新数组的大小是原来数组大小增加 1，所以 CopyOnWriteArayList 是无界is),并把新增的元素添加到新数组。然后执行代码(4)使用新数组替换原数组，并在返回前释放锁。由于加了锁，所以针咖过程是个原子性操作。需要注意的是，在添加元素时，首先复制了一个快照，然在快照上进行添加，而不是直接在原来数组上进行。

获取指定位置元素

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),这两步操作并没有进行加锁同步

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

修改指定元素

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

删除元素

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();
    }
}

弱一致性的迭代器

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

返回迭代器后,其他线程对list的增删改对迭代器是不可见的

public Spliterator<E> spliterator() {
            return Spliterators.spliterator
                    (getArray(), Spliterator.IMMUTABLE | Spliterator.ORDERED);
        }
        
        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 boolean hasPrevious() {
                return cursor > 0;
            }

            @SuppressWarnings("unchecked")
            //获取元素
            public E next() {
                if (! hasNext())
                    throw new NoSuchElementException();
                return (E) snapshot[cursor++];
            }

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

为什么说snapshot 是 list 的快照呢?

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

/**
 * @author xingchen
 * @version V1.0
 * @Package com.并发.Test
 * @date 2023/4/21 13:42
 * 
 * 学习弱一致性案例
 */
public class CopyListTest {
    
    private static volatile CopyOnWriteArrayList<String> arrayList=new CopyOnWriteArrayList<>();

    public static void main(String[] args) throws InterruptedException{
        arrayList.add("hello");
        arrayList.add("hello");
        arrayList.add("hello");
        arrayList.add("hello");
        arrayList.add("hello");
        arrayList.add("hello");
        Thread thread=new Thread(new Runnable() {
            @Override
            public void run() {
                arrayList.set(1,"baba");
                arrayList.remove(2);
                arrayList.remove(3);
            }
        });


        Iterator<String > iterator=arrayList.iterator();
        thread.start();
        thread.join();
        
        while (iterator.hasNext()){
            System.out.println(iterator.next());
        }
        
    }
}

总结

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