CopyOnWriteArrayList源码解析

简介

我们知道 ArrayList 是线程不安全的，其存在一个古老的线程安全的 Vector，但是由于 Vector 效率太低 (方法都加了synchronzed)，在 JDK1.5 时 Doug Lea 提供了一个效率较高的线程安全的 CopyOnWriteArrayList，其实现了阻塞写操作而不阻塞读操作，写时拷贝原数组写完替换原数组，实现了读写分离。

继承体系

• CopyOnWriteArrayList 实现了 List，RandomAccess，Cloneable，java.io.Serializable 等接口。
• CopyOnWriteArrayList 实现了 List，提供了基础的添加、删除、遍历等操作。
• CopyOnWriteArrayList 实现了 RandomAccess，提供了随机访问的能力。
• CopyOnWriteArrayList 实现了 Cloneable，可以被克隆。
• CopyOnWriteArrayList 实现了 Serializable，可以被序列化。

源码解析

属性

    // 全局的Lock锁，增删改时都需要先加锁，保证线程安全。
	// 使用transient修饰表示不自动序列化。
	final transient ReentrantLock lock = new ReentrantLock();
	
	// 真正存储元素的数组，使用transient修饰表示不自动序列化，使用volatile修饰表示一个线程对这个字段的修改另外一个线程立即可见。
	// 只能通过getArray()/setArray()访问
    private transient volatile Object[] array;

问题：为啥没有 size 字段？且听后续分解。

核心小方法

    // 获取底层的数组array
	final Object[] getArray() {
        return array;
    }

	// 重新为array赋值
    final void setArray(Object[] a) {
        array = a;
    }

构造方法

    /*
     * 无参构造器，调用了setArray()方法为array赋值为一个长度为0的数组
     */
	public CopyOnWriteArrayList() {
        setArray(new Object[0]);
    }
	
	/*
	 * 传入一个泛型数组
	 * 深拷贝一个toCopyIn数组赋值给array
	 */
    public CopyOnWriteArrayList(E[] toCopyIn) {
        setArray(Arrays.copyOf(toCopyIn, toCopyIn.length, Object[].class));
    }

	/*
	 * 传入一个集合
	 * 如果c是CopyOnWriteArrayList类型，直接把它的数组赋值给当前list的数组，注意这里是浅拷贝，两个集合共用同一个数组。
     * 如果c不是CopyOnWriteArrayList类型，则进行拷贝把c的元素全部拷贝到当前list的数组中。
	 */
    public CopyOnWriteArrayList(Collection<? extends E> c) {
        // 最终为array赋值
        Object[] elements;
        // 如果c是CopyOnWriteArrayList类型的，直接将elements引用c内部的数组
        if (c.getClass() == CopyOnWriteArrayList.class)
            elements = ((CopyOnWriteArrayList<?>)c).getArray();
        // c不是CopyOnWriteArrayList类型
        else {
            // toArray()方法是深拷贝了一个c内部的数组，交给elements引用
            elements = c.toArray();
            // 这里c.toArray()返回的不一定是Object[]类型
        	// 详细原因见[ArrayList源码分析]
            if (c.getClass() != Object.class)
                elements = Arrays.copyOf(elements, elements.length, Object[].class);
        }
        // 为array赋值
        setArray(elements);
    }

add(E e)

• 添加一个元素到末尾。

    public boolean add(E e) {
        //获取全局锁
        final ReentrantLock lock = this.lock;
        // 加锁
        lock.lock();
        try {
            // 获取内部数组
            Object[] elements = getArray();
            int len = elements.length;
            // 拷贝原数组的元素到新数组中，且新数组的长度比原数组多1
            Object[] newElements = Arrays.copyOf(elements, len + 1);
            // 直接将元素插入到最后
            newElements[len] = e;
            // 将新数组为array赋值
            setArray(newElements);
            return true;
        } finally {
            // 释放锁
            lock.unlock();
        }
    }

（1）加锁；

（2）获取元素数组；

（3）新建一个数组，大小为原数组长度加 1，并把原数组元素拷贝到新数组；

（4）把新添加的元素放到新数组的末尾；

（5）把新数组赋值给当前对象的 array 属性，覆盖原数组；

（6）解锁；

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;
            // 检查是否越界，可以等于len
            if (index > len || index < 0)
                throw new IndexOutOfBoundsException("Index: "+index+
                                                    ", Size: "+len);
            // 声明新数组
            Object[] newElements;
            /*
             * numMoved表示本次插入操作需要移动的元素个数
             * 比如len = 5，index = 3
             * 即本次在index = 3的位置插入元素，那么index = 3 index = 4的两个元素需要向后移动，即需要移动两个元素。
             */
            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;
            // 为array赋值
            setArray(newElements);
        } finally {
            // 释放锁
            lock.unlock();
        }
    }

（1）加锁；

（2）检查索引是否合法，如果不合法抛出 IndexOutOfBoundsException 异常，注意这里 index 等于 len 也是合法的；

（3）如果索引等于数组长度（也就是数组最后一位再加1），那就拷贝一个 len+1 的数组；

（4）如果索引不等于数组长度，那就新建一个 len+1 的数组，并按索引位置分成两部分，索引之前（不包含）的部分拷贝到新数组索引之前（不包含）的部分，索引之后（包含）的位置拷贝到新数组索引之后（不包含）的位置，索引所在位置留空；

（5）把索引位置赋值为待添加的元素；

（6）把新数组赋值给当前对象的 array 属性，覆盖原数组；

（7）解锁；

addIfAbsent(E e)

• 添加一个元素如果这个元素不存在于集合中。

    public boolean addIfAbsent(E e) {
        // 获取元素数组，取名为快照
        Object[] snapshot = getArray();
        // 如果集合中存在该元素 则返回false，否则执行addIfAbsent(e, snapshot)
        return indexOf(e, snapshot, 0, snapshot.length) >= 0 ? false :
            addIfAbsent(e, snapshot);
    }

	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) {
                // 重新检查元素是否在刚获取的数组里
                int common = Math.min(snapshot.length, len);
                for (int i = 0; i < common; i++)
                    // 到这个方法里面了，说明元素不在快照里面
                    /*
             		 * 条件1：如果此下标的 当前数组 和 快照数组 的值不一样，则需要继续判断一次，执行条件2
             		 * 条件2：eq(Object o1, Object o2) => return (o1 == null) ? o2 == null : o1.equals(o2);
             		 *                                   如果当前要添加的元素e为null，则判断current[i]是否为null
             		 *								     如果当前要添加的元素e不为null，则使用equals判断两个元素是否相等
             		 */
                    if (current[i] != snapshot[i] && eq(e, current[i]))
                        return false;
                // 检查current数组中是否含有当前元素
                if (indexOf(e, current, common, len) >= 0)
                        return false;
            }
            /*
             * 到这里就说明该集合中不存在要添加的元素
             */
            // 拷贝一个新数组 长度为len+1
            Object[] newElements = Arrays.copyOf(current, len + 1);
            // 将元素放到最后一位
            newElements[len] = e;
            // 为array赋值
            setArray(newElements);
            // 添加成功 返回true
            return true;
        } finally {
            // 解锁
            lock.unlock();
        }
    }

（1）检查这个元素是否存在于数组快照中；

（2）如果存在直接返回 false，如果不存在调用 addIfAbsent(E e, Object[] snapshot) 处理;

（3）加锁；

（4）如果当前数组不等于传入的快照，说明有修改，检查待添加的元素是否存在于当前数组中，如果存在直接返回 false;

（5）拷贝一个新数组，长度等于原数组长度加 1，并把原数组元素拷贝到新数组中；

（6）把新元素添加到数组最后一位；

（7）把新数组赋值给当前对象的 array 属性，覆盖原数组；

（8）解锁；

get(int index)

• 获取指定索引的元素，支持随机访问，时间复杂度为 $O(1)$。

    /*
     * 非同步方法，读时不加锁
     */
	public E get(int index) {
        // 获取数组的index位置的元素
        // 这里是没有做越界检查的，因为数组本身会做越界检查
        return get(getArray(), index);
    }

	// 获取a数组的index位置上的元素
    private E get(Object[] a, int index) {
        return (E) a[index];
    }

（1）获取元素数组；

（2）返回数组指定索引位置的元素；

set(int index, E element)

• 修改指定位置的元素

	public E set(int index, E element) {
        final ReentrantLock lock = this.lock;
        // 加锁
        lock.lock();
        try {
            // 获取数组
            Object[] elements = getArray();
            // 获取传入的index位置的元素
            E oldValue = get(elements, index);
			// 如果旧元素不等于要修改的元素 则可以进行替换操作
            if (oldValue != element) {
                // 获取数组长度
                int len = elements.length;
                // 深拷贝一份原数组 赋值给新数组
                Object[] newElements = Arrays.copyOf(elements, len);
                // 重新为index位置的元素赋值
                newElements[index] = element;
                // 重新为array赋值
                setArray(newElements);
            } else {
                // Not quite a no-op; ensures volatile write semantics：不太可能；确保易失性写入语义
                // 也就是说一般不会执行到这个else里
                // 要修改的元素等于旧元素，则不需要修改，直接将elements再次赋值给array即可。
                setArray(elements);
            }
            // 返回旧值
            return oldValue;
        } finally {
            // 解锁
            lock.unlock();
        }
    }

（1）加锁；

（2）获取数组；

（3）获取传入 index 位置的旧元素；

（4）如果旧元素不等于要修改的元素，则进行替换操作；

（5）深拷贝一份原数组，赋值给新数组；

（6）重新为 index 位置的元素赋值；

（7）重新为 array 赋值，覆盖原数组；

（8）如果要修改的元素等于旧元素，则不需要修改，直接将 elements 再次赋值给 array 即可（几乎不可能发生）；

（9）解锁；

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)
                // 直接拷贝一个长度为len - 1的数组即可（变向的删除了最后一个元素）并赋值给array
                setArray(Arrays.copyOf(elements, len - 1));
            else {
                // 创建一个长度为len-1的新数组
                Object[] newElements = new Object[len - 1];
                // 将原数组[0 - index)的元素拷贝到新数组中
                System.arraycopy(elements, 0, newElements, 0, index);
                // 将原数组(index, len - 1]的元素拷贝到新数组中，刚好删除了index位置的元素
                System.arraycopy(elements, index + 1, newElements, index,
                                 numMoved);
                // 重新为array赋值
                setArray(newElements);
            }
            // 返回旧值
            return oldValue;
        } finally {
            // 解锁
            lock.unlock();
        }
    }

（1）加锁；

（2）获取指定索引位置元素的旧值；

（3）如果移除的是最后一位元素，则把原数组的前 len-1 个元素拷贝到新数组中，并把新数组赋值给当前对象的数组属性；

（4）如果移除的不是最后一位元素，则新建一个 len-1 长度的数组，并把原数组除了指定索引位置的元素全部拷贝到新数组中，并把新数组赋值给当前对象的数组属性；

（5）返回旧值并解锁；

size()

• 返回数组的长度。

    public int size() {
        // 获取元素个数不需要加锁
        // 直接返回数组的长度
        return getArray().length;
    }

总结

（1）CopyOnWriteArrayList 使用 JUC 包下的 ReentrantLock 重入锁加锁，保证线程安全；

（2）CopyOnWriteArrayList 的写操作都要先拷贝一份新数组，在新数组中做修改，修改完了再用新数组替换老数组，所以空间复杂度是 $O(n)$，性能比较低下；

（3）CopyOnWriteArrayList 的读操作支持随机访问，时间复杂度为 $O(1)$；

（4）CopyOnWriteArrayList 采用读写分离的思想，读操作不加锁，写操作加锁，且写操作占用较大内存空间，所以适用于读多写少的场合；

（5）CopyOnWriteArrayList 只保证最终一致性，不保证实时一致性；

彩蛋

为什么 CopyOnWriteArrayList 没有 size 属性？

因为每次修改都是拷贝一份正好可以存储目标个数元素的数组，所以不需要 size 属性了，数组的长度就是集合的大小，而不像 ArrayList 数组的长度实际是要大于集合的大小的。

比如，add(E e) 操作，先拷贝一份 n+1 个元素的数组，再把新元素放到新数组的最后一位，这时新数组的长度为 len+1 了，也就是集合的 size 了。

---

参考文章

• 彤哥读源码_死磕 java集合之CopyOnWriteArrayList源码分析
• shstart7_Java并发List容器—CopyOnWriteArrayList源码解析