CopyOnWriteArrayList解析

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

其原理是： 初始化的时候只有一个容器，很长一段时间，这个容器数据、数量等没有发生变化，多个线程都是读取同一个容器中的数据，所以这样大家读到的数据都是唯一、一致、安全的，如果后来有线程往里面增加了一个数据，这个时候CopyOnWriteArrayList 底层实现添加的原理是先copy出一个容器(可以简称副本)，再往副本容器里添加这个新的数据，最后把副本容器的引用地址赋值给之前旧的的容器地址，但是在添加这个数据的期间，其他线程如果要去读取数据，仍然是读取到旧的容器里的数据。

二、CopyOnWriteArrayList数据结构

　　通过源码分析可知，CopyOnWriteArrayList使用的数据结构是数组。

CopyOnWriteArrayList使用了一种叫写时复制的方法，当有新元素添加到CopyOnWriteArrayList时，先从原有的数组中拷贝一份出来，然后在新的数组做写操作，写完之后，再将原来的数组引用指向到新数组。

当有新元素加入的时候，创建新数组，并往新数组中加入一个新元素,这个时候，array这个引用仍然是指向原数组的。

当元素在新数组添加成功后，将array这个引用指向新数组。

CopyOnWriteArrayList的整个add操作都是在锁的保护下进行的。 

这样做是为了避免在多线程并发add的时候，复制出多个副本出来,把数据搞乱了，导致最终的数组数据不是我们期望的。

三、CopyOnWriteArrayList源码分析

　　3.1 类的继承关系　

publicclassCopyOnWriteArrayList<E>

    implements List<E>, RandomAccess, Cloneable, java.io.Serializable {}

　　说明：CopyOnWriteArrayList实现了List接口，List接口定义了对列表的基本操作；同时实现了RandomAccess接口，表示可以随机访问（数组具有随机访问的特性）；同时实现了Cloneable接口，表示可克隆；同时也实现了Serializable接口，表示可被序列化。

　　3.2 类的内部类

　　1. COWIterator类　　

staticfinalclassCOWIterator<E>implementsListIterator<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,intinitialCursor) {

            cursor=initialCursor;

            snapshot=elements;

        }

        // 是否还有下一项

        public boolean hasNext() {

            return cursor < snapshot.length;

        }

        // 是否有上一项

        public boolean hasPrevious() {

            return cursor > 0;

        }

        // next项

        @SuppressWarnings("unchecked")

        public E next() {

            if (! hasNext()) // 不存在下一项，抛出异常

                throw new NoSuchElementException();

            // 返回下一项

            return (E) snapshot[cursor++];

        }

        @SuppressWarnings("unchecked")

        public E previous() {

            if (! hasPrevious())

               thrownewNoSuchElementException();

            return (E) snapshot[--cursor];

        }

       

        // 下一项索引

        public int nextIndex() {

            return cursor;

        }

       

        // 上一项索引

        public int previousIndex() {

            return cursor-1;

        }

        /**

         * Not supported. Always throws UnsupportedOperationException.

         *@throwsUnsupportedOperationException always; {@coderemove}

         *         is not supported by this iterator.

        */

        // 不支持remove操作

        public void remove() {

            throw new UnsupportedOperationException();

        }

        /**

         * Not supported. Always throws UnsupportedOperationException.

         *@throwsUnsupportedOperationException always; {@codeset}

         *         is not supported by this iterator.

        */

        // 不支持set操作

        public void set(E e) {

            throw new UnsupportedOperationException();

        }

        /**

         * Not supported. Always throws UnsupportedOperationException.

         *@throwsUnsupportedOperationException always; {@codeadd}

         *         is not supported by this iterator.

        */

        // 不支持add操作

        public void add(E e) {

            throw new UnsupportedOperationException();

        }

        @Override

        public void forEachRemaining(Consumer<?superE>action) {

            Objects.requireNonNull(action);

            Object[] elements=snapshot;

            final int size = elements.length;

            for (inti = cursor; i < size; i++) {

                @SuppressWarnings("unchecked") E e =(E) elements[i];

                action.accept(e);

            }

            cursor=size;

        }

    }

　　说明：COWIterator表示迭代器，其也有一个Object类型的数组作为CopyOnWriteArrayList数组的快照，这种快照风格的迭代器方法在创建迭代器时使用了对当时数组状态的引用。此数组在迭代器的生存期内不会更改，因此不可能发生冲突，并且迭代器保证不会抛出 ConcurrentModificationException。创建迭代器以后，迭代器就不会反映列表的添加、移除或者更改。在迭代器上进行的元素更改操作（remove、set 和 add）不受支持。这些方法将抛出 UnsupportedOperationException。

　　3.3 类的属性　　

publicclassCopyOnWriteArrayList<E>

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

    // 版本序列号

    private static final long serialVersionUID = 8673264195747942595L;

    // 可重入锁

    final transient ReentrantLock lock =newReentrantLock();

    // 对象数组，用于存放元素

    private transient volatile Object[] array;

    // 反射机制

    private static final sun.misc.Unsafe UNSAFE;

    // lock域的内存偏移量

    private static final long lockOffset;

    static {

        try {

            UNSAFE=sun.misc.Unsafe.getUnsafe();

            Class<?> k = CopyOnWriteArrayList.class;

            lockOffset=UNSAFE.objectFieldOffset

                (k.getDeclaredField("lock"));

        } catch (Exception e) {

            throw new Error(e);

        }

    }

}

　　说明：属性中有一个可重入锁，用来保证线程安全访问，还有一个Object类型的数组，用来存放具体的元素。当然，也使用到了反射机制和CAS来保证原子性的修改lock域。

　　3.4 类的构造函数

　　1. CopyOnWriteArrayList()型构造函数　　

    public CopyOnWriteArrayList() {

        // 设置数组

        setArray(newObject[0]);

    }

　　说明：该构造函数用于创建一个空列表。

　　2. CopyOnWriteArrayList(Collection<? extends E>)型构造函数　

    public CopyOnWriteArrayList(Collection<?extendsE>c) {

        Object[] elements;

        if (c.getClass() == CopyOnWriteArrayList.class)//类型相同

           //获取c集合的数组

            elements = ((CopyOnWriteArrayList<?>)c).getArray();

        else { // 类型不相同

           //将c集合转化为数组并赋值给elements

            elements = c.toArray();

            // c.toArray might (incorrectly) not return Object[] (see 6260652)

            if (elements.getClass() != Object[].class)//elements类型不为Object[]类型

               //将elements数组转化为Object[]类型的数组

                elements = Arrays.copyOf(elements, elements.length, Object[].class);

        }

        // 设置数组

        setArray(elements);

    }

　　说明：该构造函数用于创建一个按 collection 的迭代器返回元素的顺序包含指定 collection 元素的列表。该构造函数的处理流程如下

　　① 判断传入的集合c的类型是否为CopyOnWriteArrayList类型，若是，则获取该集合类型的底层数组（Object[]），并且设置当前CopyOnWriteArrayList的数组（Object[]数组），进入步骤③；否则，进入步骤②

　　② 将传入的集合转化为数组elements，判断elements的类型是否为Object[]类型（toArray方法可能不会返回Object类型的数组），若不是，则将elements转化为Object类型的数组。进入步骤③

　　③ 设置当前CopyOnWriteArrayList的Object[]为elements。

　　3. CopyOnWriteArrayList(E[])型构造函数　　

    public CopyOnWriteArrayList(E[] toCopyIn) {

        // 将toCopyIn转化为Object[]类型数组，然后设置当前数组

        setArray(Arrays.copyOf(toCopyIn, toCopyIn.length, Object[].class));

    }

　　说明：该构造函数用于创建一个保存给定数组的副本的列表。

4.get 函数：

public E get(intindex) {

    return get(getArray(),index);

}

private E get(Object[] a, intindex) {

    return (E) a[index];

}

可以看到，其实读取的时候是没有加锁的。读取不需要加锁。

　　3.5 核心函数分析

　　对于CopyOnWriteArrayList的函数分析，主要明白Arrays.copyOf方法即可理解CopyOnWriteArrayList其他函数的意义。

　　1. copyOf函数　　

    public static <T,U> T[] copyOf(U[] original,intnewLength, Class<?extendsT[]>newType) {

        @SuppressWarnings("unchecked")

        // 确定copy的类型（将newType转化为Object类型，将Object[].class转化为Object类型，判断两者是否相等，若相等，则生成指定长度的Object数组

       //否则,生成指定长度的新类型的数组）

        T[] copy = ((Object)newType == (Object)Object[].class)

            ? (T[]) new Object[newLength]

            : (T[]) Array.newInstance(newType.getComponentType(), newLength);

        // 将original数组从下标0开始，复制长度为(original.length和newLength的较小者),复制到copy数组中（也从下标0开始）

        System.arraycopy(original, 0, copy, 0,

                         Math.min(original.length, newLength));

        return copy;

    }

　　说明：该函数用于复制指定的数组，截取或用 null 填充（如有必要），以使副本具有指定的长度。

　　2. add函数　　

    public boolean add(E e) {

        // 可重入锁

        final ReentrantLock lock = this.lock;

        // 获取锁

        lock.lock();

        try {

            // 元素数组

            Object[] elements =getArray();

            // 数组长度

            int len = elements.length;

            // 复制数组

            Object[] newElements = Arrays.copyOf(elements, len + 1);

            // 存放元素e

            newElements[len] =e;

            // 设置数组

            setArray(newElements);

            return true;

        } finally {

            // 释放锁

            lock.unlock();

        }

    }

　　说明：此函数用于将指定元素添加到此列表的尾部，处理流程如下

　　① 获取锁（保证多线程的安全访问），获取当前的Object数组，获取Object数组的长度为length，进入步骤②。

　　② 根据Object数组复制一个长度为length+1的Object数组为newElements（此时，newElements[length]为null），进入步骤③。

　　③ 将下标为length的数组元素newElements[length]设置为元素e，再设置当前Object[]为newElements，释放锁，返回。这样就完成了元素的添加。

由于所有的写操作都是在新数组进行的，这个时候如果有线程并发的写，则通过锁来控制，如果有线程并发的读，则分几种情况： 

1、如果写操作未完成，那么直接读取原数组的数据； 

2、如果写操作完成，但是引用还未指向新数组，那么也是读取原数组数据； 

3、如果写操作完成，并且引用已经指向了新的数组，那么直接从新数组中读取数据。

可见，CopyOnWriteArrayList的读操作是可以不用加锁的。

　　3. addIfAbsent　

    private boolean addIfAbsent(E e, Object[] snapshot) {

        // 重入锁

        final ReentrantLock lock = this.lock;

        // 获取锁

        lock.lock();

        try {

            // 获取数组

            Object[] current =getArray();

            // 数组长度

            int len = current.length;

            if (snapshot != current) { // 快照不等于当前数组，对数组进行了修改

               //Optimize for lost race to another addXXX operation

               //取较小者

                int common = Math.min(snapshot.length, len);

               for(inti = 0; i < common; i++) // 遍历

                    if (current[i] != snapshot[i] && eq(e, current[i]))//当前数组的元素与快照的元素不相等并且e与当前元素相等

                       //表示在snapshot与current之间修改了数组，并且设置了数组某一元素为e，已经存在

                       //返回

                        return false;

               if(indexOf(e, current, common, len) >= 0)//在当前数组中找到e元素

                       //返回

                        return false;

            }

            // 复制数组

            Object[] newElements = Arrays.copyOf(current, len + 1);

            // 对数组len索引的元素赋值为e

            newElements[len] =e;

            // 设置数组

            setArray(newElements);

            return true;

        } finally {

            // 释放锁

            lock.unlock();

        }

    }

　　说明：该函数用于添加元素（如果数组中不存在，则添加；否则，不添加，直接返回）。可以保证多线程环境下不会重复添加元素，该函数的流程如下

　　① 获取锁，获取当前数组为current，current长度为len，判断数组之前的快照snapshot是否等于当前数组current，若不相等，则进入步骤②；否则，进入步骤④

　　② 不相等，表示在snapshot与current之间，对数组进行了修改（如进行了add、set、remove等操作），获取长度（snapshot与current之间的较小者），对current进行遍历操作，若遍历过程发现snapshot与current的元素不相等并且current的元素与指定元素相等（可能进行了set操作），进入步骤⑤，否则，进入步骤③

　　③ 在当前数组中索引指定元素，若能够找到，进入步骤⑤，否则，进入步骤④

　　④ 复制当前数组current为newElements，长度为len+1，此时newElements[len]为null。再设置newElements[len]为指定元素e，再设置数组，进入步骤⑤

　　⑤ 释放锁，返回。

　　4. set函数　

    public E set(intindex, E element) {

        // 可重入锁

        final ReentrantLock lock = this.lock;

        // 获取锁

        lock.lock();

        try {

            // 获取数组

            Object[] elements =getArray();

            // 获取index索引的元素

            E oldValue = get(elements, index);

            if (oldValue != element) { // 旧值等于element

               //数组长度

                int len = elements.length;

               //复制数组

                Object[] newElements =Arrays.copyOf(elements, len);

               //重新赋值index索引的值

                newElements[index] =element;

               //设置数组

                setArray(newElements);

            }else{

               //Not quite a no-op; ensures volatile write semantics

               //设置数组

                setArray(elements);

            }

            // 返回旧值

            return oldValue;

        } finally {

            // 释放锁

            lock.unlock();

        }

    }

　　说明：此函数用于用指定的元素替代此列表指定位置上的元素，也是基于数组的复制来实现的。

　　5. remove函数

    public E remove(intindex) {

        // 可重入锁

        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) // 移动个数为0

               //复制后设置数组

                setArray(Arrays.copyOf(elements, len - 1));

            else { // 移动个数不为0

               //新生数组

                Object[] newElements =newObject[len - 1];

               //复制index索引之前的元素

                System.arraycopy(elements, 0, newElements, 0, index);

               //复制index索引之后的元素

                System.arraycopy(elements, index + 1, newElements, index,

                                 numMoved);

               //设置索引

                setArray(newElements);

            }

            // 返回旧值

            return oldValue;

        } finally {

            // 释放锁

            lock.unlock();

        }

    }

　　说明：此函数用于移除此列表指定位置上的元素。处理流程如下

　　① 获取锁，获取数组elements，数组长度为length，获取索引的值elements[index]，计算需要移动的元素个数（length - index - 1）,若个数为0，则表示移除的是数组的最后一个元素，复制elements数组，复制长度为length-1，然后设置数组，进入步骤③；否则，进入步骤②

　　② 先复制index索引前的元素，再复制index索引后的元素，然后设置数组。

　　③ 释放锁，返回旧值。

优点:

1.解决开发工作中ArrayList的多线程的并发问题。

缺点:

1.内存占有问题:很明显，两个数组同时驻扎在内存中，如果实际应用中，数据比较多，而且比较大的情况下，占用内存会比较大，针对这个其实可以用ConcurrentHashMap来代替。

2.数据一致性:CopyOnWrite容器只能保证数据的最终一致性，不能保证数据的实时一致性。所以如果你希望写入的数据，马上能读到，请不要使用CopyOnWrite容器。

CopyOnWriteArrayList的源码很简单，其主要用到的是快照思路，使得在迭代的过程中使用的只是Object数组之前的某个快照，而不是最新的Object，这样可以保证在迭代的过程中不会抛出ConcurrentModificationException异常。CopyOnWriteArrayList 合适读多写少的场景，因为没法保证CopyOnWriteArrayList 到底要放置多少数据，万一数据稍微有点多，每次add/set都要重新复制数组，这个代价实在太高昂了。