java并发编程（二十）----(JUC集合)CopyOnWriteArrayList介绍

这一节开始我们正式来介绍JUC集合类。我们按照List、Set、Map、Queue的顺序来进行介绍。这一节我们来看一下CopyOnWriteArrayList。

CopyOnWriteArrayList介绍

CopyOnWriteArrayList是ArrayList 的一个线程安全的变体，其中所有可变操作（add、set 等等）都是通过对底层数组进行一次新的复制来实现的。

与ArrayList不同处就在于是否会拷贝数组和加锁。

CopyOnWriteArrayList顾名思义就是写时复制的ArrayList，其意思就是在修改容器的元素时，并不是直接在原数组上修改，而是先拷贝了一份数组，然后在拷贝的数组上进行修改，修改完后将其引用赋值给原数组的引用。这样体现了读写分离，这样无论在任何时候我们都可以对容器进行读取。

CopyOnWriteArrayList源码分析

我们看一下CopyOnWriteArrayList的类声明部分：

public class CopyOnWriteArrayList<E>
         implements List<E>, RandomAccess, Cloneable, java.io.Serializable {

    /** The lock protecting all mutators */
    transient final ReentrantLock lock = new ReentrantLock();

    /** The array, accessed only via getArray/setArray. */
    private volatile transient Object[] array;

    }

它实现了List接口，所以实现了Collection的功能，另外我们看到还有两个类成员变量lock和array，

在后面的源码分析中我们能看到CopyOnWriteArrayList是线程安全的使用动态数组操作机制实现的List。

所谓动态数组操作机制：即通过volatile修饰的Object类型数组来进行数组的CRUD操作。在进行add,set,remove等可变操作的时候，都会先新建一个数组把更新的值赋给该数组，然后再传递给上面的array数组来保持该次操作的可见性。这也是CopyOnWriteArrayList命名的由来。这一般需要很大的开销，但是当遍历操作的数量大大超过可变操作的数量时，即在进行读操作时的效率要远远高于写或是修改操作，这种方法可能比其他替代方法更 有效。

CopyOnWriteArrayList的线程安全实现：我们能看到是通过一个全局的Lock和volatile修饰的array来实现的。在进行add,remove,set等可变操作的时候通过赋值给array我们总能保证该变量的内存可见性，其他的线程每次总能读到最新的array变量；同样在每次进行add,remove,set等可变操作时候都会在操作的一开始加入独占锁，操作结束释放锁，以保证本次操作的安全性。

下面我们就上述分析来看一下他的部分源码：

public void add(int index, E element) {
       final ReentrantLock lock = this.lock;  //加锁
       lock.lock();
       try {
           Object[] elements = getArray();
           int len = elements.length;
           if (index > len || index < 0)
               throw new IndexOutOfBoundsException("Index: "+index+", Size: "+len);
           Object[] newElements;
           int numMoved = len - index;
           if (numMoved == 0)
        //如果是在最后一个位置增加就把该数组赋值一份然后新增一个长度
               newElements = Arrays.copyOf(elements, len + 1);
           else {
        //否则新建数组，然后将"volatile数组中被删除元素之外的其它元素“拷贝到新数组中；最后，将新数组赋值给”volatile数组"。
               newElements = new Object[len + 1];
               System.arraycopy(elements, 0, newElements, 0, index);
               System.arraycopy(elements, index, newElements, index + 1,numMoved);
           }
           newElements[index] = element;
           setArray(newElements); //拷贝
       } finally {
           lock.unlock();
       }
   }

public E set(int index, E element) {
       final ReentrantLock lock = l.lock;//加锁
       lock.lock();
       try {
           rangeCheck(index);
           checkForComodification();
           E x = l.set(index+offset, element);
           expectedArray = l.getArray();//拷贝
           return x;
       } finally {
           lock.unlock();
       }
   }

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;
        // 如果被删除的是最后一个元素，则直接通过Arrays.copyOf()进行处理，而不需要新建数组。
           if (numMoved == 0)
               setArray(Arrays.copyOf(elements, len - 1));
        // 否则，新建数组，然后将"volatile数组中被删除元素之外的其它元素“拷贝到新数组中；最后，将新数组赋值给”volatile数组"。
           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();
       }
   }

由上面源码部分我们可以看到CopyOnWriteArrayList在修改原数组的过程中比ArrayList多做了2件事：

1、加锁：保证我在修改数组的时候，其他人不能修改。

2、拷贝数组：无论是哪个方法，发现都需要拷贝数组。

上面的两件事就确保了CopyOnWriteArrayList在多线程的环境下可以应对自如。

我们再来看一下他的迭代器的实现：

public Iterator<E> iterator() {
   return new COWIterator<E>(getArray(), 0);
}

我们看到迭代器里面调用了COWIterator这个类，下面来看一下他的源码：

private static 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;
     }

     //不支持remove方法
     public void remove() {
         throw new UnsupportedOperationException();
     }

    //不支持set方法
     public void set(E e) {
         throw new UnsupportedOperationException();
     }

     //不支持add方法
     public void add(E e) {
         throw new UnsupportedOperationException();
     }
 }

我们可以看到COWSubListIterator不支持修改元素的操作。例如，对于remove(),set(),add()等操作，COWSubListIterator都会抛出异常！

CopyOnWriteArrayList的迭代器并不是快速失败的，也就是说并不会抛出ConcurrentModificationException异常。这是因为他在修改的时候，是针对与拷贝数组而言的，对于原数组没有任何影响。我们可以看出迭代器里面没有锁机制，所以只提供读取，而不支持添加修改和删除（抛出UnsupportedOperationExcetion）。

CopyOnWriteArrayList使用示例

上面我们具体的分析了CopyOnWriteArrayList的线程安全机制和实现机制，我们再来就他的使用做一个相应的说明：

public class TestCopyOnWriteArrayList {
    // fixme: list是ArrayList对象时，程序会出错。
    private static List<String> list = new ArrayList<String>();
    /*private static List<String> list = new CopyOnWriteArrayList<String>();*/
    public static void main(String[] args) {
        ExecutorService executor = Executors.newFixedThreadPool(20);
        for(int i=0;i<100;i++){
            executor.execute(new TestList("aa"));
        }
    }

    private static void printAll() {
        String value = null;
        Iterator iter = list.iterator();
        while(iter.hasNext()) {
            value = (String)iter.next();
            System.out.print(value+", ");
        }
        System.out.println();
    }

    private static class TestList extends Thread {
        TestList(String name) {
            super(name);
        }
        @Override
        public void run() {
            String val = Thread.currentThread().getName();
            list.add(val);
            printAll();
        }
    }
}

运行上程序，当list是ArrayList对象时，程序会出错，报出java.util.ConcurrentModificationException类型异常；当使用CopyOnWriteArrayList对象时，程序可以完成iterator遍历操作。