Java集合之CopyOnWriteArrayList

1. 简介

      CopyOnWriteArrayList是ArrayList的线程安全版本，内部也是通过数组实现，每次对数组的修改都完全拷贝一份新的数组来修改，修改完了再替换掉老数组，这样保证了只阻塞写操作，不阻塞读操作，实现读写分离。

2. 继承体系

      CopyOnWriteArrayList实现了List，提供了基础的添加、删除、遍历等操作。

      CopyOnWriteArrayList实现了Serializable，可以被序列化。

      CopyOnWriteArrayList实现了Cloneable，可以被克隆。

      CopyOnWriteArrayList实现了RandomAccess，提供了随机访问的能力。

3. 深入源码

3.1 属性

    /** 用于对数组进行修改时加锁 */
    final transient ReentrantLock lock = new ReentrantLock();

    /** 存储元素的数组 */
    private transient volatile Object[] array;

3.2 访问数组的方法

       对于 array 的访问，只能通过这两个方法。

    /**
     * Gets the array.  Non-private so as to also be accessible
     * from CopyOnWriteArraySet class.
     */
    final Object[] getArray() {
        return array;
    }

    /**
     * Sets the array.
     */
    final void setArray(Object[] a) {
        array = a;
    }

3.3 构造方法

3.3.1 CopyOnWriteArrayList()

	// 创建一个空数组
    public CopyOnWriteArrayList() {
        setArray(new Object[0]);
    }

3.3.2 CopyOnWriteArrayList(Collection<? extends E> c)

    public CopyOnWriteArrayList(Collection<? extends E> c) {
        Object[] elements;
        if (c.getClass() == CopyOnWriteArrayList.class)
        	// 如果c也是CopyOnWriteArrayList类型
        	// 那么直接把它的数组拿过来使用
            elements = ((CopyOnWriteArrayList<?>)c).getArray();
        else {
        	// 否则调用其toArray()方法将集合元素转化为数组
            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);
    }

3.3.3 CopyOnWriteArrayList(E[] toCopyIn)

	// 相当于将原数组中的元素拷贝到 array 中
    public CopyOnWriteArrayList(E[] toCopyIn) {
        setArray(Arrays.copyOf(toCopyIn, toCopyIn.length, Object[].class));
    }

3.4 添加元素

3.4.1 add(E e)

	// 添加一个元素到数组末尾
    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);
            // 添加元素
            newElements[len] = e;
            // 令数组指向新数组
            setArray(newElements);
            return true;
        } finally {
        	// 释放锁
            lock.unlock();
        }
    }

3.4.2 add(int index, E element)

	// 在指定位置添加元素
    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)
            	// 如果插入的位置是最后一位
           		// 那么拷贝一个n+1的数组, 其前n个元素与旧数组一致
                newElements = Arrays.copyOf(elements, len + 1);
            else {
           		 // 如果插入的位置不是最后一位
            	// 那么新建一个n+1的数组
                newElements = new Object[len + 1];
                // 拷贝旧数组前index的元素到新数组中
                System.arraycopy(elements, 0, newElements, 0, index);
                 // 将index及其之后的元素往后挪一位拷贝到新数组中
            	// 这样正好index位置是空出来的
                System.arraycopy(elements, index, newElements, index + 1,
                                 numMoved);
            }
            // 将元素放置在index处
            newElements[index] = element;
            // 令数组指向新数组
            setArray(newElements);
        } finally {
        	// 释放锁
            lock.unlock();
        }
    }

3.4.3 addIfAbsent(E e)

	// 如果指定元素不存在则添加
    public boolean addIfAbsent(E e) {
        Object[] snapshot = getArray();
        return indexOf(e, snapshot, 0, snapshot.length) >= 0 ? false :
            addIfAbsent(e, snapshot);
    }

	// 遍历数组查找元素 e，不存在则返回 -1
	private static int indexOf(Object o, Object[] elements,
                               int index, int fence) {
        if (o == null) {
            for (int i = index; i < fence; i++)
                if (elements[i] == null)
                    return i;
        } else {
            for (int i = index; i < fence; i++)
                if (o.equals(elements[i]))
                    return i;
        }
        return -1;
    }

	private boolean addIfAbsent(E e, Object[] snapshot) {
        final ReentrantLock lock = this.lock;
        lock.lock();
        try {
        	// 再次获取数组
            Object[] current = getArray();
            int len = current.length;
            // 如果 current 和 snapshot 不相等，则说明有其他线程指向过 setArray 方法
            if (snapshot != current) {
                // 重新检查元素是否在刚获取的数组里
                int common = Math.min(snapshot.length, len);
                for (int i = 0; i < common; i++)
                    if (current[i] != snapshot[i] && eq(e, current[i]))
                        return false;
                if (indexOf(e, current, common, len) >= 0)
                        return false;
            }
            // 拷贝一份n+1的数组
            Object[] newElements = Arrays.copyOf(current, len + 1);
            // 将元素放在最后一位
            newElements[len] = e;
            setArray(newElements);
            return true;
        } finally {
        	// 释放锁
            lock.unlock();
        }
    }

3.5 获得元素

3.5.1 get(int index)

    public E get(int index) {
        return get(getArray(), index);
    }

	private E get(Object[] a, int index) {
        return (E) a[index];
    }

3.6 删除元素

3.6.1 remove(int index)

    public E remove(int index) {
        final ReentrantLock lock = this.lock;
        // 加锁
        lock.lock();
        try {
        	// 获得旧数组
            Object[] elements = getArray();
            int len = elements.length;
            // 获得 index 位置的元素
            E oldValue = get(elements, index);
            int numMoved = len - index - 1;
            if (numMoved == 0)
             	// 如果移除的是最后一位
          	   // 那么直接拷贝一份n-1的新数组, 最后一位就自动删除了
                setArray(Arrays.copyOf(elements, len - 1));
            else {
            	// 如果移除的不是最后一位
            	// 那么新建一个n-1的新数组
                Object[] newElements = new Object[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();
        }
    }

3.6.2 remove(Object o)

    public boolean remove(Object o) {
    	// 获得旧数组
        Object[] snapshot = getArray();
        // 判断数组中是否存在元素 o
        int index = indexOf(o, snapshot, 0, snapshot.length);
        return (index < 0) ? false : remove(o, snapshot, index);
    }

    private boolean remove(Object o, Object[] snapshot, int index) {
        final ReentrantLock lock = this.lock;
        lock.lock();
        try {
            Object[] current = getArray();
            int len = current.length;
            // 判断数组有没有倍修改
            if (snapshot != current) findIndex: {
                int prefix = Math.min(index, len);
                for (int i = 0; i < prefix; i++) {
                    if (current[i] != snapshot[i] && eq(o, current[i])) {
                        index = i;
                        break findIndex;
                    }
                }
                if (index >= len)
                    return false;
                if (current[index] == o)
                    break findIndex;
                index = indexOf(o, current, index, len);
                if (index < 0)
                    return false;
            }
            Object[] newElements = new Object[len - 1];
            System.arraycopy(current, 0, newElements, 0, index);
            System.arraycopy(current, index + 1,
                             newElements, index,
                             len - index - 1);
            setArray(newElements);
            return true;
        } finally {
            lock.unlock();
        }
    }

3.7 获得元素个数

    public int size() {
        return getArray().length;
    }

4. 总结

      （1）CopyOnWriteArrayList使用ReentrantLock重入锁加锁，保证线程安全；
      （2）CopyOnWriteArrayList的写操作都要先拷贝一份新数组，在新数组中做修改，修改完了再用新数组替换老数组，所以空间复杂度是O(n)，性能比较低下；
      （3）CopyOnWriteArrayList的读操作支持随机访问，时间复杂度为O(1)；
      （4）CopyOnWriteArrayList采用读写分离的思想，读操作不加锁，写操作加锁，且写操作占用较大内存空间，所以适用于读多写少的场合；
      （5）CopyOnWriteArrayList只保证最终一致性，不保证实时一致性；